tencent cloud

Feedback

CreateExporterIntegration

Last updated: 2023-08-11 16:09:09

1. API Description

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

This API is used to create an exporter integration.

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: CreateExporterIntegration.
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 Instance ID
Kind Yes String Type
Content Yes String Integrated configuration
KubeType No Integer Kubernetes cluster type. Valid values:
  • 1 = TKE
  • 2 = EKS
  • 3 = MEKS
  • ClusterId No String Cluster ID

    3. Output Parameters

    Parameter Name Type Description
    Names Array of String The list of successfully created integrations.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating an exporter integration

    Input Example

    POST / HTTP/1.1
    Host: monitor.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateExporterIntegration
    <Common request parameters>
    
    {
        "InstanceId": "prom-1",
        "KubeType": 3,
        "ClusterId": "cls-xx",
        "Kind": "blackbox-exporter",
        "Content": "{\"name\":\"test\",\"kind\":\"blackbox-exporter\",\"spec\":{\"instanceSpec\":{\"module\":\"http_get\",\"urls\":[\"xx\"]}}}"
    }
    

    Output Example

    {
        "Response": {
            "Names": [
                "redis-exporter"
            ],
            "RequestId": "xyz"
        }
    }
    

    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
    AuthFailure Error with CAM signature/authentication.
    AuthFailure.UnauthorizedOperation The request is not authorized. For more information on the authentication, see the CAM documentation.
    FailedOperation Operation failed.
    FailedOperation.AccessTKEFail Failed to access the TKE cluster.
    FailedOperation.DbQueryFailed Failed to query the database.
    FailedOperation.InstanceNotRunning The instance is not running.
    FailedOperation.ResourceExist The resource already exists.
    FailedOperation.ResourceNotFound The resource does not exist.
    FailedOperation.ResourceOperating The resource is being manipulated.
    FailedOperation.TKEResourceConflict A conflict occurred while updating the TKE resource.
    InternalError Internal error.