指标订阅数据预览

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

我的收藏

1. 接口描述

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

创建指标订阅配置

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMetricSubscribePreview。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
Namespace String 云产品命名空间。
示例值:QCE/CVM
Metrics.N Array of MetricConfig 数据库配置信息。
InstanceInfo InstanceConfig 实例配置配置。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 总数量
示例值:2
SuccessCount Integer 成功数量
示例值:1
FailCount Integer 失败数量
示例值:1
SuccessInstances Array of InstanceData 成功实例数据
FailInstances Array of InstanceData 失败实例数据
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 指标订阅预览示例

指标订阅预览示例

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMetricSubscribePreview
<公共请求参数>

{
    "Namespace": "QCE/CVM",
    "Metrics": [
        {
            "MetricName": "MemUsed",
            "Periods": [
                60
            ],
            "MetricLabels": [
                {
                    "Key": "key_demo",
                    "Value": "value_demo"
                }
            ]
        }
    ],
    "InstanceInfo": {
        "InstanceDimension": [
            "InstanceId"
        ],
        "Instances": [
            {
                "Values": [
                    "ins-izop9bz6"
                ]
            }
        ]
    }
}

输出示例

{
    "Response": {
        "FailCount": 0,
        "FailInstances": [],
        "RequestId": "220fa7fb-9134-4dbc-84bb-00613636b45a",
        "SuccessCount": 1,
        "SuccessInstances": [
            {
                "Dimensions": [
                    {
                        "Name": "InstanceId",
                        "Value": "ins-izop9bz6"
                    }
                ],
                "ErrMsg": "",
                "MetricName": "MemUsed",
                "Namespace": "QCE/CVM",
                "Period": 60,
                "CLSMetricName": "qce_cvm_memused_60_avg",
                "Value": 340.166
            }
        ],
        "TotalCount": 1
    }
}

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 操作失败。
FailedOperation.Timeout 操作超时
InternalError 内部错误。
InternalError.DbError DB错误。
InternalError.IllegalRole 角色非法。
InvalidParameter 参数错误。
InvalidParameter.DbDuplication 数据库唯一键冲突。
InvalidParameter.ParamError 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded.RecordOutOfLimit 记录超过限制
MissingParameter 缺少参数错误。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。