tencent cloud

APIs

DescribeMetricSubscribes

Download
Focus Mode
Font Size
Last updated: 2026-06-10 15:02:30

1. API Description

Domain name for API request: cls.intl.tencentcloudapi.com.

This API is used to obtain metric subscription configurations.

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: DescribeMetricSubscribes.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TopicId Yes String Log topic id
Filters.N No Array of Filter
  • Filter taskId by [configuration id]. Type: String. Required: No


  • Name is filtered by [configuration name]. Type: String Required: No


  • Filter status by [configuration status tag]. Type: String Required: No


  • Each request can have up to 10 Filters. The maximum number of Filter.Values is 100.
  • Offset No Integer Page offset. Default value: 0
    Limit No Integer Maximum number of entries per page. Default value: 20. Maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number
    Datas Array of MetricSubscribeInfo Metric subscription configuration information.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Obtaining Metric Subscription Configuration

    Obtaining Metric Subscription Configuration

    Input Example

    POST / HTTP/1.1
    Host: cls.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeMetricSubscribes
    <Common request parameters>
    
    {
        "TopicId": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c",
        "Filters": [
            {
                "Key": "name",
                "Values": [
                    "template_1"
                ]
            }
        ],
        "Offset": 0,
        "Limit": 1
    }
    

    Output Example

    {
        "Response": {
            "TotalCount": 1,
            "Datas": [
                {
                    "TopicId": "715094e3-01b0-4aeb-91f5-ee9f46a4a13c",
                    "TaskId": "5871c48d-219b-4274-829b-5aa7fb24229b",
                    "Name": "metric_subscribe_name",
                    "Namespace": "QCE/CVM",
                    "Metrics": [
                        {
                            "MetricName": "metric name",
                            "Periods": [
                                60,
                                120
                            ],
                            "MetricLabels": [
                                {
                                    "Key": "label_key",
                                    "Value": "label_value"
                                }
                            ]
                        }
                    ],
                    "InstanceInfo": {
                        "InstanceDimension": [
                            "bucket",
                            "appid"
                        ],
                        "Instances": [
                            {
                                "Values": [
                                    "bucket_asdfa-asdf-asdf-ads",
                                    "12325435"
                                ]
                            }
                        ]
                    },
                    "Enable": 2,
                    "Status": 1,
                    "ErrMsg": "",
                    "CreateTime": 1700200000,
                    "UpdateTime": 1700200000
                }
            ],
            "RequestId": "1111c48d-219b-4274-829b-5aa7fb24229b"
        }
    }
    

    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 CAM signature/authentication error.
    AuthFailure.UnauthorizedOperation Request unauthorized.
    FailedOperation Operation failed.
    InternalError Internal error.
    InternalError.DbError DB Error.
    InternalError.IllegalRole Illegal role.
    InvalidParameter Incorrect parameter.
    InvalidParameter.ParamError Parameter error.
    InvalidParameterValue Incorrect parameter value.
    LimitExceeded.RecordOutOfLimit Record exceeds limit
    MissingParameter Missing parameter.
    OperationDenied.AccountNotExists The account does not exist.
    UnauthorizedOperation Unauthorized operation.
    UnknownParameter Unknown parameter error.
    UnsupportedOperation Unsupported operation.

    Help and Support

    Was this page helpful?

    Help us improve! Rate your documentation experience in 5 mins.

    Feedback