Tencent Cloud

Prev Next

키워드를 검색하세요

Recent Pages

문서

Download PDF

DescribeAlarmShields

마지막 업데이트 시간:2024-04-15 19:58:48

PDF 다운로드

1. API Description

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

This API is used to access alarm blocking configuration rules.

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

We recommend you to 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 Params. The value used for this API: DescribeAlarmShields.
Version	Yes	String	Common Params. The value used for this API: 2020-10-16.
Region	No	String	Common Params. This parameter is not required for this API.
AlarmNoticeId	Yes	String	Notification Channel Group ID
Filters.N	No	Array of Filter	- taskId: Filter by [Rule ID]. Type: String. Optional: No - status: Filter by [Rule Status]. Type: String. Supports 0: Not yet effective, 1: In Effect, 2: Expired. Optional: No Each request can have up to 10 Filters. The upper limit of Filter.Values is 100.
Offset	No	Integer	Page offset. Default value: 0
Limit	No	Integer	Maximum number of entries per page. Default value: 20. Maximum value: 100.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	The total number of rules that meet the criteria
AlarmShields	Array of AlarmShieldInfo	Details of the alarm blocking rules
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Accessing Alarm Masking Configuration Information

This example shows you how to access alarm masking configuration information.

Input Example

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmShields
<Common request parameters>

{
    "AlarmNoticeId": "notice-ea115e5a-04c4-421e-9ba3-fb177e9025cb",
    "Filters": [
        {
            "Key": "status",
            "Values": [
                "1"
            ]
        }
    ],
    "Offset": 0,
    "Limit": 10
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "AlarmShields": [
            {
                "AlarmNoticeId": "notice-ea115e5a-04c4-421e-9ba3-fb177e9025cb",
                "TaskId": "ea115e5a-04c4-421e-9ba3-fb177e9025cb",
                "StartTime": 1701933943,
                "EndTime": 1701993943,
                "Type": 1,
                "Rule": "",
                "Reason": "System Deployment, Temporary Masking",
                "Source": 1,
                "Operator": "1001(Zhang San)",
                "Status": 1,
                "CreateTime": 1701933943,
                "UpdateTime": 1701933943
            }
        ],
        "RequestId": "11115e5a-04c4-421e-9ba3-fb177e902511"
    }
}

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

Tencent Cloud CLI 3.0

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	CAM signature/authentication error.
AuthFailure.UnauthorizedOperation	Request unauthorized.
FailedOperation	Operation failed.
FailedOperation.Timeout	Operation timed out
InternalError	Internal error.
InternalError.DbError	DB Error.
InternalError.IllegalRole	Illegal role.
InvalidParameter	Incorrect parameter.
InvalidParameter.ParamError	Parameter error.
InvalidParameterValue	Incorrect parameter value.
LimitExceeded.RecordOutOfLimit	Record exceeds limit
MissingParameter	Missing parameter.
OperationDenied.AccountNotExists	The account does not exist.
UnauthorizedOperation	Unauthorized operation.
UnknownParameter	Unknown parameter error.
UnsupportedOperation	Unsupported operation.

문의하기

고객의 업무에 전용 서비스를 제공해드립니다.

기술 지원

더 많은 도움이 필요하시면, 티켓을 통해 연락 바랍니다. 티켓 서비스는 연중무휴 24시간 제공됩니다.

연중무휴 24시간 전화 지원

tencent cloud

Recent Pages

DescribeAlarmShields

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Accessing Alarm Masking Configuration Information

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

문제 해결에 도움이 되었나요?

문제 해결에 도움이 되었나요?

tencent cloud

가입하기

로그인

Recent Pages

DescribeAlarmShields

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Accessing Alarm Masking Configuration Information

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

문제 해결에 도움이 되었나요?

문제 해결에 도움이 되었나요?