DescribePrometheusInstancesOverview

最后更新时间：2023-08-11 16:08:59

1. API Description

Domain name for API request: monitor.tencentcloudapi.com.

This API is used to obtain the list of Tencent Managed Service for Prometheus (TMP) instances and the clusters associated with them.

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.

2. Input Parameters

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: DescribePrometheusInstancesOverview.
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.
Offset	No	Integer	Page offset
Limit	No	Integer	Number of results per page
Filters.N	No	Array of Filter	Instance filter. Valid values: `ID`: Filter by instance ID `Name`: Filter by instance name

3. Output Parameters

Parameter Name	Type	Description
Instances	Array of PrometheusInstancesOverview	List of instances
Total	Integer	Total number of instances 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 Obtaining the instance list

This example shows you how to obtain the instance list.

Input Example

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusInstancesOverview
<Common request parameters>

{
    "Limit": 1,
    "Filters": [
        {
            "Name": "Name",
            "Values": [
                "alert-test"
            ]
        }
    ],
    "Offset": 1
}

Output Example

{
    "Response": {
        "Instances": [
            {
                "InstanceStatus": 0,
                "BoundNormal": 0,
                "VpcId": "xxx",
                "AutoRenewFlag": 0,
                "InstanceId": "xxx",
                "BoundTotal": 0,
                "ExpireTime": "xxx",
                "SpecName": "xxx",
                "InstanceChargeType": 0,
                "EnableGrafana": 0,
                "DataRetentionTime": 0,
                "GrafanaURL": "xxx",
                "SubnetId": "xxx",
                "InstanceName": "xxx",
                "ChargeStatus": 0,
                "ResourcePackageStatus": 1,
                "ResourcePackageSpecName": "fff"
            }
        ],
        "Total": 1,
        "RequestId": "xxx"
    }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation.ComponentClientCommon	FailedOperation.ComponentClientCommon
FailedOperation.ComponentClientUnpack	FailedOperation.ComponentClientUnpack
FailedOperation.DoTRPCTransferFailed	DoTRPCTransferFailed
InternalError	Internal error.
InternalError.Param	InternalError.Param
InternalError.UnexpectedInternal	InternalError.UnexpectedInternal
InvalidParameter.Param	InvalidParameter.Param

tencent cloud

Recent Pages