Domain name for API request: monitor.intl.tencentcloudapi.com.
This API is used to batch update the status of alarm groups and set all rules grouped in them to the target status.
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: UpdatePrometheusAlertGroupState. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-24. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| InstanceId | No | String | TMP instance ID |
| GroupIds.N | No | Array of String | Alarm group ID list, such as alert-xxxx. |
| GroupState | No | Integer | Describes the group status of the alarm. 2 - enable. 3 - disabled. |
| Parameter Name | Type | Description |
|---|---|---|
| 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. |
This example shows you how to disable alarm grouping in settings.
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdatePrometheusAlertGroupState
<Common request parameters>
{
"InstanceId": "prom-7vp71mk0",
"GroupIds": [
"alert-ol72w8vy"
],
"GroupState": 3
}{
"Response": {
"RequestId": "a4797141-a4f9-43d4-b4ca-09d72bb48f8d"
}
}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 |
|---|---|
| AuthFailure | Error with CAM signature/authentication. |
| FailedOperation | Operation failed. |
| FailedOperation.BadYamlFormat | The YAML format is incorrect. |
| FailedOperation.DbQueryFailed | Failed to query the database. |
| FailedOperation.DbRecordCreateFailed | Failed to create the database record. |
| FailedOperation.DbRecordDeleteFailed | Failed to delete the database record. |
| FailedOperation.DbRecordUpdateFailed | Failed to update the database record. |
| FailedOperation.GenerateInstanceIDFailed | An error occurred while generating the resource ID. |
| FailedOperation.ResourceExist | The resource already exists. |
| FailedOperation.ResourceNotFound | The resource does not exist. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
フィードバック