1. API Description
Domain name for API request: monitor.intl.tencentcloudapi.com.
This API is used to bind an alarm policy to a specific object.
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.
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: BindingPolicyObject. |
| 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. |
| Module |
Yes |
String |
Required. The value is fixed to monitor. |
| GroupId |
No |
Integer |
Policy group ID, such as 4739573. This parameter will be disused soon. Another parameter PolicyId is recommended. |
| PolicyId |
No |
String |
Alarm policy ID, such as policy-gh892hg0. At least one of the two parameters, PolicyId and GroupId, must be specified; otherwise, an error will be reported. PolicyId is preferred over GroupId when both of them are specified. |
| InstanceGroupId |
No |
Integer |
Instance group ID. |
| Dimensions.N |
No |
Array of BindingPolicyObjectDimension |
Dimensions of an object to be bound. |
| EbSubject |
No |
String |
The alert configured for an event |
| EbEventFlag |
No |
Integer |
Whether the event alert has been configured |
3. Output Parameters
| Parameter Name |
Type |
Description |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Binding a policy object
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: BindingPolicyObject
<Common request parameters>
{
"GroupId": "111111",
"Module": "monitor",
"Dimensions": [
{
"EventDimensions": "{\"uuid\":\"9d51a69e-0e4a-4120-ae58-9c073c851e24\"}",
"Region": "gz",
"RegionId": "1",
"Dimensions": "{\"unInstanceId\":\"ins-ot3cq4bi\"}"
}
]
}
Output Example
{
"Response": {
"RequestId": "78345016-ff97-4360-839a-82f3d96430e8"
}
}
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 |
| FailedOperation |
Operation failed. |
| ResourceNotFound |
The resource is not found. |
| UnsupportedOperation |
Unsupported operation. |