DescribeServiceDiscovery

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: 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	TKE: ID of the integrated TKE cluster
KubeType	Yes	Integer	Kubernetes cluster type: 1 = TKE

3. Output Parameters

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.

4. Example

Example1 Listing scrape configurations

Input Example

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

{
    "InstanceId": "prom-sdfk2342a",
    "KubeClusterId": "cls-pwerf3k3",
    "KubeType": 1
}

Output Example

{
    "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\":\"\"}}]"
            }
        ]
    }
}

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.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.

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support

tencent cloud

Recent Pages