Domain name for API request: monitor.intl.tencentcloudapi.com.
This API is used to list Prometheus scrape tasks.
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: DescribePrometheusScrapeJobs. |
| 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 | Instance ID |
| AgentId | Yes | String | Agent ID |
| Name | No | String | Task name |
| JobIds.N | No | Array of String | List of task IDs |
| Offset | No | Integer | Offset. Default value: 0. |
| Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
| Parameter Name | Type | Description |
|---|---|---|
| ScrapeJobSet | Array of PrometheusScrapeJob | List of tasks Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Total number of tasks |
| 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 list of Prometheus scrape tasks.
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusScrapeJobs
<Common request parameters>
{
"InstanceId": "prom-evrh1x32",
"AgentId": "agent-hod16m43"
}{
"Response": {
"TotalCount": 0,
"RequestId": "5fa8c92-3072-4f46-8553-4cb82c30943c",
"ScrapeJobSet": [
{
"AgentId": "agent-hod16m43",
"Config": "job_name: static\nhonor_timestamps: true\nmetrics_path: /metrics\nscheme: http\nfollow_redirects: true\nstatic_configs:\n- targets:\n - localhost:9090\n",
"Name": "node-exporter",
"JobId": "job-afeiig0k"
}
]
}
}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.ResourceNotFound | The resource does not exist. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | The parameter value is incorrect. |
| ResourceNotFound | The resource is not found. |
フィードバック