Domain name for API request: csip.intl.tencentcloudapi.com.
This API is used to query the notification policy list for the current tenant by page, corresponding to the table on the Notification Policy Configuration Tab in Notification Center - Robot Notification. The returned fields are simplified info required for row display. Use DescribeWebhookPolicy for complete configuration in editing scenarios. Each tenant can have up to 100 notification policies.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeWebhookPolicyList. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| Offset | No | Integer | Paging offset |
| Limit | No | Integer | Number of results per page |
| Filters.N | No | Array of Filters | Filter criteria |
| Order | No | String | Sorting field |
| By | No | String | Sorting method |
| Parameter Name | Type | Description |
|---|---|---|
| Data | Array of WebhookPolicy | Policy list. |
| TotalCount | Integer | Total quantity. |
| 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. |
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWebhookPolicyList
<Common request parameters>
{
"Offset": 0,
"Limit": 1,
"Order": "UpdateTime",
"By": "desc"
}{
"Response": {
"Data": [
{
"AssetScope": {
"AssetRange": 1,
"CloudTags": [],
"ExcludedInstanceIds": [],
"InstanceIds": [],
"TagIds": []
},
"CustomFields": [],
"ID": 5,
"MemberId": [],
"MsgLanguage": "zh",
"Name": "policy1",
"NotifyItems": [
{
"Levels": [
"HIGH"
],
"Module": "Alert",
"SubModule": "MALWARE_FILE"
}
],
"ReceiveFormat": "TEXT",
"ReceiverIDList": [
2
],
"ReceiverList": [],
"Status": "ON"
}
],
"TotalCount": 1,
"RequestId": "6a04ff0f-affe-4ae6-afe6-9c2f747715ba"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback