Domain name for API request: monitor.tencentcloudapi.com.
This API is used to update a Prometheus scrape task.
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: UpdatePrometheusScrapeJob. |
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”. |
AgentId | Yes | String | Agent ID such as “agent-abcd1234”, which can be obtained on the Agent Management page in the console |
JobId | Yes | String | Scrape task ID such as “job-abcd1234”. You can go to the Agent Management page and obtain the ID in the pop-up Create Scrape Task window. |
Config | Yes | String | Scrape task ID in the format of “job_name:xx” |
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.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdatePrometheusScrapeJob
<Common request parameters>
{
"JobId": "job-abcd1234",
"InstanceId": "prom-abcd1234",
"AgentId": "agent-abcd1234",
"Config": "job_name:xx"
}
{
"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.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.ResourceExist | The resource already exists. |
FailedOperation.ResourceNotFound | The resource does not exist. |
InvalidParameter | Invalid parameter. |
InvalidParameterValue | The parameter value is incorrect. |
ResourceNotFound | The resource is not found. |
Was this page helpful?