获取指标订阅配置

最近更新时间:2025-12-23 01:28:47

我的收藏

1. 接口描述

接口请求域名: cls.tencentcloudapi.com 。

获取指标订阅配置

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMetricSubscribes。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
TopicId String 日志主题id
示例值:5871c48d-219b-4274-829b-5aa7fb24229b
Filters.N Array of Filter
  • taskId按照【配置id】进行过滤。类型:String 必选:否


  • name按照【配置名称】进行过滤。类型:String 必选:否


  • status按照【配置状态标记】进行过滤。类型:String 必选:否


  • 每次请求的Filters的上限为10,Filter.Values的上限为100。
  • Offset Integer 分页的偏移量,默认值为0。
    示例值:0
    Limit Integer 分页单页限制数目,默认值为20,最大值100。
    示例值:20

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 总数目
    示例值:0
    Datas Array of MetricSubscribeInfo 指标订阅配置信息
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取指标订阅配置信息

    获取指标订阅配置信息

    输入示例

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

    输出示例

    {
        "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. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    AuthFailure CAM签名/鉴权错误。
    AuthFailure.UnauthorizedOperation 请求未授权。
    FailedOperation 操作失败。
    InternalError 内部错误。
    InternalError.DbError DB错误。
    InternalError.IllegalRole 角色非法。
    InvalidParameter 参数错误。
    InvalidParameter.ParamError 参数错误。
    InvalidParameterValue 参数取值错误。
    LimitExceeded.RecordOutOfLimit 记录超过限制
    MissingParameter 缺少参数错误。
    OperationDenied.AccountNotExists 账户不存在。
    UnauthorizedOperation 未授权操作。
    UnknownParameter 未知参数错误。
    UnsupportedOperation 操作不支持。