DescribeAlarmNotice

Last updated: 2021-07-06 16:45:42

    1. API Description

    Domain name for API request: monitor.tencentcloudapi.com.

    This API is used to query the details of a single notification template.

    A maximum of 20 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: monitor.ap-shanghai-fsi.tencentcloudapi.com

    We recommend you use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: DescribeAlarmNotice.
    Version Yes String Common parameter. The value used for this API: 2018-07-24.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    Module Yes String Module name. Enter "monitor" here
    NoticeId Yes String Alarm notification template ID

    3. Output Parameters

    Parameter Name Type Description
    Notice AlarmNotice Alarm notification template details
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the details of a single notification template

    This example shows you how to query the details of the specified alarm notification template (ID: notice-2g892hg8).

    Input Example

    POST / HTTP/1.1
    Host: monitor.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeAlarmNotice
    <Common request parameters>
    {
      "Module": "monitor",
      "NoticeId": "notice-2g892hg8"
    }
    

    Output Example

    {
    "Response": {
      "RequestId": "fasdfaghash434stsi579ah",
      "Notice": {
        "Id": "notice-2g892hg8",
        "Name": "Test - alarm notification rule 1",
        "UpdatedAt": "2020-05-01 12:00:00",
        "UpdatedBy": "112051051047",
        "NoticeType": "ALL",
        "NoticeLanguage": "zh-CN",
        "UserNotices": [
          {
            "ReceiverType": "USER",
            "UserIds": [
              168105,
              162208
            ],
            "GroupIds": [],
            "StartTime": 0,
            "EndTime": 3600,
            "NoticeWay": [
              "EMAIL",
              "CALL"
            ],
            "PhoneOrder": [
              162208,
              168105
            ],
            "PhoneCircleTimes": 2,
            "PhoneInnerInterval": 60,
            "PhoneCircleInterval": 60,
            "NeedPhoneArriveNotice": 1
          }
        ],
        "URLNotices": [
          {
            "URL": "http://www.baidu.com/validate",
            "IsValid": 0,
            "ValidationCode": "1r51tg3"
          },
          {
            "URL": "https://www.googe.com/validate",
            "IsValid": 0,
            "ValidationCode": "h4224"
          }
        ],
        "IsPreset": 0,
        "PolicyIds": [
          "policy-58hbt18"
        ]
      }
    }
    }
    

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    AuthFailure Error with CAM signature/authentication.
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue The parameter value is incorrect.
    ResourceNotFound The resource is not found.
    UnsupportedOperation Unsupported operation.