tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeWebHookPolicy

Last updated: 2024-08-27 11:39:58

1. API Description

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

This API is used to query alarm policies.

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: DescribeWebHookPolicy.
Version Yes String Common Params. The value used for this API: 2018-02-28.
Region No String Common Params. This parameter is not required.
Filter.N No Array of Filter Filter criteria
Offset No Integer Offset, which defaults to 0
Limit No Integer Number of items to be returned. It is 10 by default, and the maximum value is 100.
Order No String Sorting Method: [ASC: Ascending Order, DESC: Descending Order]
By No String Sorting field

3. Output Parameters

Parameter Name Type Description
List Array of WebHookPolicy Policy list
Note: This field may return null, indicating that no valid values can be obtained.
TotalCount Integer Number of policy lists
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 Example

Example

Input Example

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

{
    "Offset": 0,
    "Limit": 1
}

Output Example

{
    "Response": {
        "List": [
            {
                "CustomFields": [
                    {
                        "Key": "Machine A",
                        "Value": "Text"
                    }
                ],
                "Events": [
                    {
                        "ControlBit": "11",
                        "Type": 4
                    },
                    {
                        "ControlBit": "11",
                        "Type": 13
                    },
                    {
                        "ControlBit": "1",
                        "Type": 14
                    },
                    {
                        "ControlBit": "",
                        "Type": 22
                    },
                    {
                        "ControlBit": "1",
                        "Type": 23
                    },
                    {
                        "ControlBit": "",
                        "Type": 1
                    },
                    {
                        "ControlBit": "11",
                        "Type": 3
                    },
                    {
                        "ControlBit": "1",
                        "Type": 7
                    },
                    {
                        "ControlBit": "1",
                        "Type": 12
                    },
                    {
                        "ControlBit": "1",
                        "Type": 19
                    },
                    {
                        "ControlBit": "1",
                        "Type": 20
                    },
                    {
                        "ControlBit": "",
                        "Type": 25
                    },
                    {
                        "ControlBit": "1",
                        "Type": 8
                    },
                    {
                        "ControlBit": "1111",
                        "Type": 18
                    },
                    {
                        "ControlBit": "1111",
                        "Type": 17
                    },
                    {
                        "ControlBit": "11111",
                        "Type": 2
                    },
                    {
                        "ControlBit": "111",
                        "Type": 6
                    },
                    {
                        "ControlBit": "1111",
                        "Type": 9
                    },
                    {
                        "ControlBit": "1111",
                        "Type": 10
                    },
                    {
                        "ControlBit": "1111",
                        "Type": 11
                    },
                    {
                        "ControlBit": "11",
                        "Type": 15
                    },
                    {
                        "ControlBit": "1111",
                        "Type": 16
                    },
                    {
                        "ControlBit": "1",
                        "Type": 21
                    },
                    {
                        "ControlBit": "1",
                        "Type": 24
                    }
                ],
                "Format": 0,
                "HostCount": 3,
                "HostLabels": [
                    {
                        "Type": 4,
                        "Values": []
                    }
                ],
                "Id": 38,
                "IsDisabled": 0,
                "Name": "Only machine a; text",
                "Quuids": [
                    "058e0cf8-ba52-47fc-a100-2fdcc1e73e96",
                    "00e800cb-7202-4d83-90c2-6e920758dd42",
                    "380add75-bb06-4cc4-84c5-cf806d102fba"
                ],
                "Receivers": [
                    {
                        "Addr": "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=d0c2fc25-23a2-4285-ab98-d8a862146a73",
                        "Id": 17,
                        "Name": "Wecom"
                    }
                ]
            }
        ],
        "RequestId": "6933d139-3143-4590-805f-712489ea91b8",
        "TotalCount": 16
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy