腾讯云可观测平台
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 腾讯云可观测平台

接口迁移说明

最近更新时间：2023-05-17 10:11:02

我的收藏

本页目录：

腾讯云可观测平台 API 已全面升级至3.0版本，基于2.0版本接口访问时延较高和使用复杂的考虑，原腾讯云可观测平台 API2.0接口服务将不再提供技术支持，并将于2022年11月30日起下线。如果您的业务还在使用腾讯云可观测平台 API2.0相关接口，建议尽快将服务升级至 API3.0接口，以免对您的业务造成影响。

GetMonitorData

2.0文档：读取监控数据
3.0文档：拉取指标监控数据

入参改动

参数名大小写改动：2.0部分参数名为小驼峰（全部小写），3.0已全部改为大驼峰（大小写结合），例如：2.0的 namespace 对应3.0的 Namespace。
1. 地域参数值（Region）由短地域（广州:gz）改为长地域（广州:ap-guangzhou），详见 腾讯云地域列表。
2. 命名空间（namespace）和指标（metricName）参见 GetMonitorData指标对应关系 做对应修改，例如：2.0命名空间为 qce/cvm，指标为 cpu_usage，则3.0的命名空间为 QCE/CVM，指标为 CpuUsage 。
3. 实例支持传多个，2.0的 dimensions 参数移到3.0的 Instances 参数里面。
4. 维度 key（dimensions.*.name）修改：qce/cvm 的 unInstanceId 改成 InstanceId，qce/cdb 的 uInstanceId 改成 InstanceId，instType 改成 InstanceType，其他命名空间的维度 key 不需要修改。

出参改动

2.0返回的 dataPoints 对应3.0的 DataPoints.0.Values。
2.0没有返回时间戳，3.0返回时间戳（DataPoints.0.Timestamps）。
2.0使用 null 表示空值，3.0会将 null 去掉，同时将对应的时间戳去掉。
错误码：2.0返回 code 和 message，code 不为0表示出错，3.0出错时返回 Response.Error，里面有 Code 和 Message 。

具体参数对比

2.0入参
{
    "Action":"GetMonitorData",
    "Region":"gz",
    "namespace":"qce/cdb",
    "metricName":"real_capacity",
    "startTime":"2022-08-01 00:00:00",
    "endTime":"2022-08-01 00:02:00",
    "period":"60",
    "dimensions":[
        {
            "name":"uInstanceId",
            "value":"cdb-12345678"
        }
    ]
}
2.0出参
{
    "code":0,
    "message":"",
    "metricName":"real_capacity",
    "startTime":"2022-08-01 00:00:00",
    "endTime":"2022-08-01 00:02:00",
    "period":60,
    "dataPoints":[
        1,
        null,
        1
    ]
}
3.0入参
{
    "Action":"GetMonitorData",
    "Region":"ap-guangzhou",
    "Namespace":"QCE/CDB",
    "MetricName":"RealCapacity",
    "StartTime":"2022-08-01 00:00:00",
    "EndTime":"2022-08-01 00:02:00",
    "Period":60,
    "Version":"2018-07-24",
    "Instances":[
        {
            "Dimensions":[
                {
                    "Name":"InstanceId",
                    "Value":"cdb-12345678"
                }
            ]
        }
    ]
}
3.0出参
{
    "Response":{
        "MetricName":"RealCapacity",
        "StartTime":"2022-08-01 00:00:00",
        "EndTime":"2022-08-01 00:02:00",
        "Period":60,
        "DataPoints":[
            {
                "Dimensions":[
                    {
                        "Name":"InstanceId",
                        "Value":"cdb-12345678"
                    }
                ],
                "Timestamps":[ // 第二个点是null，不返回
                    1659283200,
                    1659283320
                ],
                "Values":[ // 第二个点是null，不返回
                    1,
                    1
                ]
            }
        ]
    }
}

编码

用户可使用 云产品 SDK 中心 获取到 API3.0 配套的多种编程语言的 SDK，API Explorer 可以直接生成 SDK 的调用代码，方便用户实现代码调用。



SendCustomAlarmMsg

文档链接

2.0文档： 发送自定义消息告警
3.0文档 ：发送自定义消息告警

入参改动

参数名大小写改动，2.0有些参数名是小驼峰（全小写），3.0全部改为大驼峰（大小写结合），例如：2.0的 policyId 对应3.0的 PolicyId 。
新增公共参数 Module，固定 monitor。

出参改动

3.0接口成功时只返回 RequestId，不返回错误信息。

具体参数对比

2.0入参
{
    "Action":"SendCustomAlarmMsg",
    "policyId":"policy-xxx",
    "msg":"xxxxxx"
}
2.0出参
{
    "code": 0,
    "message": "",
    "codeDesc": "Success"
}
3.0入参
{
    "Action":"SendCustomAlarmMsg",
    "Module":"monitor",
    "PolicyId":"policy-xxx",
    "Msg":"xxxxxx"
}
3.0出参
{
    "Response": {
        "RequestId": "9q1zxtmzw6xqyqriu8run9jf6fnnkdbn"
    }
}

DescribeBasicAlarmList

文档

2.0文档：无
3.0文档： 获取基础告警列表
说明
建议使用最新接口 查询告警历史。

入参改动

参数名大小写改动，2.0有些参数名是小驼峰，3.0全部改为大驼峰，例如：2.0的 projectIds 对应3.0的 ProjectIds。
1. 新增参数：
新增公共参数 Module，必填，固定 monitor；
新增 InstanceGroupIds 参数，选填，根据实例组 ID 过滤；
新增 MetricNames，选填，根据指标名过滤。
2. 移除参数：dimension、search、requestType。
3. 时间参数类型转为 int。

出参改动

无太大改动，2.0 有些参数名是小驼峰（全小写），3.0全部改为大驼峰（大小写结合），具体以文档为准。

具体参数对比

2.0入参
 {
     "region": "gz",
     "startTime": "2022-08-28 17:41:24",
     "endTime": "2022-08-29 17:41:24",
     "occurTimeOrder": "desc",
     "offset": 50,
     "limit": 1,
     "viewNames": [
         "TSF",
         "TSF_LOG",
         "TSF_GROUP"
     ]
 }
2.0出参
{
    "returnCode": 0,
    "returnMessage": "ok",
    "data":
    {
        "total": 57,
        "alarms": [
        {
            "id": 556326182,
            "projectId": -1,
            "projectName": "-",
            "status": 1,
            "alarmStatus": "OK",
            "groupId": 2604932,
            "groupName": "\\u4f01\\u70b9B2B\\u670d\\u52a1",
            "firstOccurTime": "2022-08-28T19:17:00+08:00",
            "duration": 660,
            "lastOccurTime": "2022-08-28T19:28:00+08:00",
            "content": "\\u63a5\\u6536\\u8bf7\\u6c42\\u91cf >3000\\u6b21",
            "objName": "qidian_tsf_gray_new_v1.16_default|analytics",
            "objId": "1251316161#namespace-vw7xoj9y#analytics",
            "viewName": "TSF",
            "vpc": "-",
            "metricId": 1232,
            "metricName": "req_count",
            "alarmType": "0",
            "region": "gz",
            "dimensions": [],
            "instanceGroup": [],
            "notifyWay": ["EMAIL", "SMS", "WECHAT"]
        }]
    }
}
3.0入参
{
    "Module": "monitor",
    "Action": "DescribeBasicAlarmList",
    "Limit": 1,
    "Offset": 50,
    "AppId": 1251316161,
    "Uin": "2252646423",
    "SubAccountUin": "2252646423",
    "Region": "ap-guangzhou",
    "Version": "2018-07-24",
    "StartTime": 1661679684,
    "EndTime": 1661766084,
    "ViewNames": [
        "TSF",
        "TSF_LOG",
        "TSF_GROUP"
    ],
    "OccurTimeOrder": "DESC"
}
3.0出参
{
    "Response":
    {
        "Alarms": [
        {
            "AlarmStatus": "OK",
            "AlarmType": 0,
            "Content": "接收请求量 \\u003e3000次",
            "Dimensions": "{\\"app_id\\":\\"1251316161\\",\\"namespace_id\\":\\"namespace-vw7xoj9y\\",\\"service_name\\":\\"analytics\\"}",
            "Duration": 0,
            "FirstOccurTime": "2022-08-28T19:17:00+08:00",
            "GroupId": 2604932,
            "GroupName": "企点B2B服务",
            "Id": 68124140025,
            "InstanceGroup": null,
            "LastOccurTime": "2022-08-28T19:28:00+08:00",
            "MetricId": 1232,
            "MetricName": "req_count",
            "NotifyWay": [],
            "ObjId": "1251316161#namespace-vw7xoj9y#analytics",
            "ObjName": "qidian_tsf_gray_new_v1.16_default|analytics",
            "ProjectId": -1,
            "ProjectName": "-",
            "Region": "ap-guangzhou",
            "Status": 1,
            "ViewName": "TSF",
            "Vpc": "-"
        }],
        "RequestId": "gez-8c4baoqgsfblttgghwro6cbh2qvo",
        "Total": 57,
        "Warning": "This method is deprecated! Use `DescribeAlarmHistories` instead!"
    }
}

中国站