Domain name for API request: monitor.intl.tencentcloudapi.com.
This API is used to list Prometheus scrape configurations in TKE.
Note: The prerequisite is that the corresponding TKE service has been integrated through the Prometheus console. For more information, see Agent Management.
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: DescribeServiceDiscovery. |
| 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. |
| InstanceId | Yes | String | Prometheus instance ID |
| KubeClusterId | Yes | String | |
| KubeType | Yes | Integer | Kubernetes cluster type: |
| Parameter Name | Type | Description |
|---|---|---|
| ServiceDiscoverySet | Array of ServiceDiscoveryItem | List of returned scrape configurations 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. |
POST / HTTP/1.1
Host: monitor.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeServiceDiscovery
<Common request parameters>
{
"InstanceId": "prom-sdfk2342a",
"KubeClusterId": "cls-pwerf3k3",
"KubeType": 1
}{
"Response": {
"RequestId": "0523dedd-1235-428d-885c-9443cf9175d1",
"ServiceDiscoverySet": [
{
"Kind": "ServiceMonitor",
"Name": "name",
"Namespace": "namespace",
"Selector": "{\"matchLabels\":{\"k8sapp\":\"mysql-exporter\"}}",
"Yaml": "apiVersion: monitoring.coreos.com...",
"NamespaceSelector": "{\"matchNames\":[\"demo-ns\"]}",
"Endpoints": "[{\"port\":\"tcp-port\",\"path\":\"/metrics\",\"interval\":\"30s\",\"bearerTokenSecret\":{\"key\":\"\"}}]"
}
]
}
}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.AccessSTSFail | Failed to access STS. |
| FailedOperation.AccessTKEFail | Failed to access the TKE cluster. |
| FailedOperation.DbQueryFailed | Failed to query the database. |
| FailedOperation.InstanceNotRunning | The instance is not running. |
| FailedOperation.ResourceNotFound | The resource does not exist. |
| FailedOperation.TKEEndpointStatusError | The TKE endpoint is inaccessible. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| ResourceNotFound | The resource is not found. |
文档反馈