DescribePrometheusInstance

Last updated: 2021-10-20 16:47:51

1. API Description

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.

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 parameter. The value used for this API: DescribePrometheusInstance.
Version Yes String Common parameter. The value used for this API: 2018-05-25.
Region Yes String Common parameter. 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-mumbai, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, eu-frankfurt, eu-moscow, na-ashburn, na-siliconvalley
InstanceId Yes String Instance ID

3. Output Parameters

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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the details of the managed PROM instance

Input Example

https://tke.tencentcloudapi.com/?Action=DescribePrometheusInstance
&InstanceId=prom-xxx
&<Common request parameters>

Output Example

{
  "Response": {
    "QueryAddress": "xx",
    "VpcId": "xx",
    "Name": "xx",
    "InstanceId": "xx",
    "COSBucket": "xx",
    "AlertManagerUrl": "xx",
    "Grafana": {
      "Domain": "xx",
      "Internet": "xx",
      "Enabled": true,
      "AdminUser": "xx",
      "Address": "xx"
    },
    "RequestId": "xx",
    "SubnetId": "xx"
  }
}

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
InternalError Internal 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.PromInstanceNotFound The PROM instance does not exist.