Release Notes
Domain name for API request: monitor.intl.tencentcloudapi.com.
This API is used to get the details of a TMP instance.
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: DescribePrometheusInstanceDetail. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-24. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| InstanceId | Yes | String | Instance ID |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID |
| InstanceName | String | Instance name |
| VpcId | String | VPC ID |
| SubnetId | String | Subnet ID |
| InstanceStatus | Integer | Instance status. Valid values:1: Creating2: Running3: Abnormal4: Rebooting5: Terminating6: Service suspended8: Suspending service for overdue payment9: Service suspended for overdue payment |
| ChargeStatus | Integer | Billing status1: Normal2: Expired3: Terminated4: Assigning5: Failed to assignNote: This field may return null, indicating that no valid values can be obtained. |
| EnableGrafana | Integer | Whether Grafana is enabled0: Disabled1: Enabled |
| GrafanaURL | String | Grafana dashboard URL Note: This field may return null, indicating that no valid values can be obtained. |
| InstanceChargeType | Integer | Instance billing mode. Valid values:2: Monthly subscription3: Pay-as-you-go |
| SpecName | String | Specification name Note: This field may return null, indicating that no valid values can be obtained. |
| DataRetentionTime | Integer | Storage period Note: This field may return null, indicating that no valid values can be obtained. |
| ExpireTime | String | Expiration time of the purchased instance Note: This field may return null, indicating that no valid values can be obtained. |
| AutoRenewFlag | Integer | Auto-renewal flag0: Auto-renewal not enabled1: Auto-renewal enabled2: Auto-renewal prohibited-1: InvalidNote: This field may return null, indicating that no valid values can be obtained. |
| 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 details of a TMP instance.
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusInstanceDetail
<Common request parameters>
{
"InstanceId": "xx"
}{
"Response": {
"InstanceStatus": 0,
"VpcId": "xx",
"AutoRenewFlag": 0,
"InstanceId": "xx",
"ExpireTime": "xx",
"SpecName": "xx",
"InstanceChargeType": 0,
"RequestId": "xx",
"EnableGrafana": 0,
"DataRetentionTime": 0,
"GrafanaURL": "xx",
"SubnetId": "xx",
"InstanceName": "xx",
"ChargeStatus": 0
}
}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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameter.Param | InvalidParameter.Param |
| InvalidParameterValue | The parameter value is incorrect. |
| ResourceNotFound | The resource is not found. |
フィードバック