tencent cloud

Feedback

CreateServiceDiscovery

Last updated: 2022-08-23 15:35:36

1. API Description

Domain name for API request: monitor.tencentcloudapi.com.

This API is used to create a Prometheus scrape configuration 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.

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 Params. The value used for this API: CreateServiceDiscovery.
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-nanjing, 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
  • Type Yes Integer Scrape configuration type. Valid values:
  • 1 = ServiceMonitor
  • 2 = PodMonitor
  • 3 = JobMonitor
  • Yaml Yes String Scrape configuration information

    3. Output Parameters

    Parameter Name Type Description
    ServiceDiscovery ServiceDiscoveryItem The scrape configuration information returned after successful creation
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating a scrape configuration

    Input Example

    https://monitor.tencentcloudapi.com/?Action=CreateServiceDiscovery
    &InstanceId=prom-sdfk2342a
    &KubeClusterId=cls-pwerf3k3
    &KubeType=1
    &Type=1
    &Yaml=yaml
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "ServiceDiscovery": {
                "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\":\"\"}}]"
            },
            "RequestId": "nrtlca1qmunlpf51noe13qp5vyvg7mq5"
        }
    }
    

    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
    FailedOperation Operation failed.
    FailedOperation.AccessSTSFail Failed to access STS.
    FailedOperation.AccessTKEFail Failed to access the TKE cluster.
    FailedOperation.AgentVersionNotSupported The agent version does not support this operation. Upgrade the agent.
    FailedOperation.BadYamlFormat The YAML format is incorrect.
    FailedOperation.ResourceNotFound The resource does not exist.
    FailedOperation.TKEClientAuthFail There is no access to TKE.
    FailedOperation.TKEEndpointStatusError The TKE endpoint is inaccessible.
    FailedOperation.TKEResourceConflict A conflict occurred while updating the TKE resource.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    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