1. API Description
Domain name for API request: monitor.intl.tencentcloudapi.com.
This API is used to query the usage of a pay-as-you-go Tencent Managed Service for Prometheus (TMP) instance.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
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: DescribePrometheusInstanceUsage. |
| 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 |
Yes |
Array of String |
Query by one or more instance IDs. Instance ID is in the format of prom-xxxxxxxx. Up to 100 instances can be queried in one request. |
| StartCalcDate |
Yes |
String |
Start time |
| EndCalcDate |
Yes |
String |
End time |
3. Output Parameters
| Parameter Name |
Type |
Description |
| UsageSet |
Array of PrometheusInstanceTenantUsage |
Usage list Note: 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. |
4. Example
Example1 Querying the usage of a pay-as-you-go TMP instance
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusInstanceUsage
<Common request parameters>
{
"InstanceIds": [
"prom-xxxxx"
],
"StartCalcDate": "20210101",
"EndCalcDate": "20210101"
}
Output Example
{
"Response": {
"UsageSet": [
{
"InstanceId": "prom-xxxxx",
"CalcDate": "20210101",
"Total": 1.1,
"Basic": 1.1,
"Fee": 1.1
}
],
"RequestId": "3e0dff9d-9ed5-47c3-beb2-a42c1d69e1cc"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
Command Line Interface
6. Error Code
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 |
Error with CAM signature/authentication. |
| AuthFailure.UnauthorizedOperation |
The request is not authorized. For more information on the authentication, see the CAM documentation. |
| FailedOperation |
Operation failed. |
| FailedOperation.DbQueryFailed |
Failed to query the database. |
| InternalError |
Internal error. |
| InvalidParameter |
Invalid parameter. |
| InvalidParameter.InvalidParameter |
Invalid parameter. |
| InvalidParameter.InvalidParameterParam |
Invalid parameter. |
| InvalidParameter.ParamError |
Incorrect parameter. |
| InvalidParameterValue |
The parameter value is incorrect. |
| ResourceNotFound |
The resource is not found. |