Domain name for API request: monitor.tencentcloudapi.com.
This API is used to get the list of v2.0 instance alerting rules.
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: DescribePrometheusAlertPolicy. |
Version | Yes | String | Common Params. The value used for this API: 2018-07-24. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceId | Yes | String | Instance ID |
Offset | No | Integer | Page offset |
Limit | No | Integer | Number of results per page |
Filters.N | No | Array of Filter | Filter Valid values: ID , Name . |
Parameter Name | Type | Description |
---|---|---|
AlertRules | Array of PrometheusAlertPolicyItem | Alert details Note: This field may return null, indicating that no valid values can be obtained. |
Total | Integer | Total number |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query the alert list.
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusAlertPolicy
<Common request parameters>
{
"InstanceId": "xxx",
"Limit": 1,
"Filters": [
{
"Name": "Name",
"Values": [
"alert-test"
]
}
],
"Offset": 1
}
{
"Response": {
"AlertRules": [
{
"Name": "xxx",
"Rules": [
{
"Describe": "xxx",
"Name": "xxx",
"For": "xxx",
"Labels": [
{
"Name": "xxx",
"Value": "xxx"
}
],
"Rule": "xxx",
"Template": "xxx",
"Annotations": [
{
"Name": "xxx",
"Value": "xxx"
}
]
}
],
"Notification": {
"AlertManager": {
"Url": "xxx",
"ClusterId": "xxx",
"ClusterType": "xxx"
},
"RepeatInterval": "xxx",
"WebHook": "xxx",
"Enabled": true,
"PhoneNotifyOrder": [
1
],
"PhoneInnerInterval": 0,
"PhoneCircleInterval": 0,
"NotifyWay": [
"xxx"
],
"ReceiverGroups": [
"1"
],
"PhoneArriveNotice": true,
"PhoneCircleTimes": 0,
"TimeRangeStart": "xxx",
"Type": "xxx",
"TimeRangeEnd": "xxx"
},
"TemplateId": "xxx",
"ClusterId": "xxx",
"UpdatedAt": "xxx",
"Id": "xxx"
}
],
"Total": 1,
"RequestId": "xxx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.ComponentClientCommon | FailedOperation.ComponentClientCommon |
FailedOperation.ComponentClientHttp | FailedOperation.ComponentClientHttp |
FailedOperation.ComponentClientUnpack | FailedOperation.ComponentClientUnpack |
FailedOperation.DoTRPCTransferFailed | DoTRPCTransferFailed |
FailedOperation.KubeClientConf | FailedOperation.KubeClientConf |
FailedOperation.KubeCommon | FailedOperation.KubeCommon |
InternalError | Internal error. |
InternalError.DbRecordNotFound | InternalError.DbRecordNotFound |
InternalError.Param | InternalError.Param |
InternalError.UnexpectedInternal | InternalError.UnexpectedInternal |
InvalidParameter | Invalid parameter. |
InvalidParameter.Param | InvalidParameter.Param |
InvalidParameter.PromClusterNotFound | InvalidParameter.PromClusterNotFound |
InvalidParameter.PromInstanceNotFound | InvalidParameter.PromInstanceNotFound |
ResourceNotFound | The resource is not found. |
Was this page helpful?