Domain name for API request: monitor.intl.tencentcloudapi.com.
This API is used to query the details of one or multiple instances.
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: DescribePrometheusInstances. |
| 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. |
| InstanceIds.N | No | Array of String | Queries by instance ID or IDs. Instance ID is in the format of prom-xxxxxxxx. Up to 100 instances can be queried in one request. |
| InstanceStatus.N | No | Array of Integer | Filter by instance status
|
| InstanceName | No | String | Filter by instance name |
| Zones.N | No | Array of String | Filter by AZ in the format of ap-guangzhou-1 |
| TagFilters.N | No | Array of PrometheusTag | Filter by tag key-value pair. The tag-key should be replaced with a specific tag key. |
| IPv4Address.N | No | Array of String | Filter by instance IPv4 address |
| Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. |
| Offset | No | Integer | Offset. Default value: 0. |
| InstanceChargeType | No | Integer | Filter by billing mode |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceSet | Array of PrometheusInstancesItem | List of instance details. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Number of eligible instances. |
| 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: DescribePrometheusInstances
<Common request parameters>
{
"InstanceIds": [
"prom-ncxkwqr8"
]
}{
"Response": {
"TotalCount": 1,
"InstanceSet": [
{
"InstanceName": "name",
"InstanceChargeType": 1,
"InstanceId": "prom-xxxxx",
"InstanceStatus": 1,
"RegionId": 1,
"Zone": "ap-guangzhou-1",
"VpcId": "vpcID",
"SubnetId": "subnetid",
"IPv4Address": "",
"DataRetentionTime": 30,
"EnableGrafana": 0,
"GrafanaURL": "",
"CreatedAt": "2020-07-07T10:39:18Z"
}
],
"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 |
|---|---|
| AuthFailure.AccessCAMFail | Access authentication failed. |
| AuthFailure.UnauthorizedOperation | The request is not authorized. For more information on the authentication, see the CAM documentation. |
| FailedOperation | Operation failed. |
| FailedOperation.AccessTagFail | Failed to access the tag service. |
| FailedOperation.DbQueryFailed | Failed to query the database. |
| FailedOperation.DbRecordCreateFailed | Failed to create the database record. |
| FailedOperation.InternalError | Internal service error. |
| FailedOperation.ResourceNotFound | The resource does not exist. |
| FailedOperation.SendRequest | Failed to send the authorization request. |
| InternalError | Internal error. |
| InvalidParameterValue | The parameter value is incorrect. |
フィードバック