Domain name for API request: monitor.tencentcloudapi.com.
This API is used to get the list of clusters associated with the 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: DescribePrometheusClusterAgents. |
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 |
Offset | No | Integer | Page offset |
Limit | No | Integer | Page limit |
Parameter Name | Type | Description |
---|---|---|
Agents | Array of PrometheusAgentOverview | Information of the associated cluster |
Total | Integer | The total number of the associated clusters |
IsFirstBind | Boolean | Whether the TMP instance is associated with the cluster for the first time. If so, you need to configure recording rules for it. This also applies if it has no default recording rule. |
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 pull the agent information.
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrometheusClusterAgents
<Common request parameters>
{
"InstanceId": "abc",
"Limit": 1,
"Offset": 1
}
{
"Response": {
"Total": 1,
"IsFirstBind": true,
"Agents": [
{
"Status": "abc",
"ClusterName": "abc",
"ExternalLabels": [
{
"Name": "abc",
"Value": "abc"
}
],
"ClusterId": "abc",
"ClusterType": "abc",
"Region": "abc",
"VpcId": "abc",
"FailedReason": "abc"
}
],
"RequestId": "abc"
}
}
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.ComponentClientCommon | FailedOperation.ComponentClientCommon |
FailedOperation.ComponentClientHttp | FailedOperation.ComponentClientHttp |
FailedOperation.ComponentClientUnpack | FailedOperation.ComponentClientUnpack |
FailedOperation.Db | FailedOperation.Db |
FailedOperation.DoTRPCTransferFailed | DoTRPCTransferFailed |
FailedOperation.InstanceNotFound | The instance does not exist. |
FailedOperation.KubeCommon | FailedOperation.KubeCommon |
InternalError | Internal error. |
InternalError.Db | InternalError.Db |
InternalError.UnexpectedInternal | InternalError.UnexpectedInternal |
InvalidParameter | Invalid parameter. |
InvalidParameter.ClusterNotFound | InvalidParameter.ClusterNotFound |
InvalidParameter.Param | InvalidParameter.Param |
InvalidParameter.PromClusterNotFound | InvalidParameter.PromClusterNotFound |
InvalidParameter.PromInstanceNotFound | InvalidParameter.PromInstanceNotFound |
InvalidParameter.ResourceNotFound | InvalidParameter.ResourceNotFound |
Was this page helpful?