tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribePrometheusTempSync

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

1. API Description

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

This API is used to get the information of instances associated with a template. It takes effect for v2 instances.

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: DescribePrometheusTempSync.
Version Yes String Common Params. The value used for this API: 2018-07-24.
Region No String Common Params. This parameter is not required for this API.
TemplateId Yes String Template ID

3. Output Parameters

Parameter Name Type Description
Targets Array of PrometheusTemplateSyncTarget Details of the sync target
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 Getting the sync targets

This example shows you how to get the sync targets.

Input Example

https://monitor.tencentcloudapi.com/?Action=DescribePrometheusTempSync
&TemplateId="temp-xxx"
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
        "Targets": [
            {
                "Region": "ap-shanghai",
                "InstanceId": "prom-xxx",
                "ClusterId": "xxx",
                "SyncTime": "2020-02-2"
            }
        ]
    }
}

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.DoTRPCTransferFailed DoTRPCTransferFailed
InternalError Internal error.
InternalError.Db InternalError.Db
InternalError.Param InternalError.Param
InvalidParameter.Param InvalidParameter.Param
InvalidParameter.ResourceNotFound InvalidParameter.ResourceNotFound
ResourceNotFound The resource is not found.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy