Domain name for API request: monitor.intl.tencentcloudapi.com.
This API is used to update the status of a Prometheus CVM agent.
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: UpdatePrometheusAgentStatus. |
| 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-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. |
| InstanceId | Yes | String | TMP instance ID, such as “prom-abcd1234”. |
| AgentIds.N | Yes | Array of String | List of agent IDs such as “agent-abcd1234”, which can be obtained on the Agent Management page in the console. |
| Status | Yes | Integer | Status to update |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdatePrometheusAgentStatus
<Common request parameters>
{
"InstanceId": "prom-abcd1234",
"AgentIds": [
"agent-abcd1234"
],
"Status": 1
}{
"Response": {
"RequestId": "3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc"
}
}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 | Operation failed. |
| FailedOperation.DbQueryFailed | Failed to query the database. |
| FailedOperation.DbRecordUpdateFailed | Failed to update the database record. |
| FailedOperation.ResourceNotFound | The resource does not exist. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | The parameter value is incorrect. |
| ResourceNotFound | The resource is not found. |
피드백