Domain name for API request: tke.tencentcloudapi.com.
This API is used to obtain the instance details.
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: DescribePrometheusInstance. |
Version | Yes | String | Common Params. The value used for this API: 2018-05-25. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | Instance ID |
Parameter Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID |
Name | String | Instance name |
VpcId | String | VPC ID |
SubnetId | String | Subnet ID |
COSBucket | String | COS bucket name |
QueryAddress | String | Data query address |
Grafana | PrometheusGrafanaInfo | The grafana related information in the instance Note: this field may return null , indicating that no valid value can be obtained. |
AlertManagerUrl | String | Custom alertmanager Note: this field may return null , indicating that no valid value can be obtained. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to query the details of the managed PROM instance.
https://tke.tencentcloudapi.com/?Action=DescribePrometheusInstance
&InstanceId=prom-abc
&<Common request parameters>
{
"Response": {
"QueryAddress": "http://10.0.0.1:9090",
"VpcId": "vpc-abcdfgfg",
"Name": "tps-test",
"InstanceId": "prom-abcdefg",
"COSBucket": "prometheus-prom-abcdefg-data-1234567895",
"AlertManagerUrl": "",
"Grafana": {
"Domain": "",
"Internet": "close",
"Enabled": true,
"AdminUser": "admin",
"Address": "http://10.0.0.2"
},
"RequestId": "55054791-f4ff-4c33-afd2-dsahdjahdahada",
"SubnetId": "subnet-dsadsada"
}
}
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.ComponentClientHttp | Internal HTTP client error. |
FailedOperation.ComponentClientUnpack | Internal HTTP decapsulation failed. |
FailedOperation.KubeCommon | Kubernetes API error. |
InternalError | Internal error. |
InternalError.Db | DB error. |
InternalError.DbRecordNotFound | Record not found. |
InternalError.Param | Parameter error. |
InternalError.UnexpectedInternal | Unknown internal error. |
InvalidParameter | Parameter error. |
InvalidParameter.ClusterNotFound | The cluster ID does not exist. |
InvalidParameter.Param | Invalid parameter. |
InvalidParameter.PromInstanceNotFound | The PROM instance does not exist. |
本页内容是否解决了您的问题?