有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

查询实例信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTawInstances。
Version String 公共参数,本接口取值:2021-06-22。
Region String 公共参数,本接口不需要传递此参数。
ChargeStatuses.N Array of Integer 计费状态
ChargeTypes.N Array of Integer 计费类型
Limit Integer 分页Limit
示例值:1
Offset Integer 分页Offset
示例值:0
AreaIds.N Array of Integer 片区Id
InstanceStatuses.N Array of Integer 实例状态(1=创建中,2=运行中,3=异常,4=重启中,5=停止中,6=已停止,7=销毁中,8=已销毁), 该参数已废弃,请在Filters内注明
InstanceIds.N Array of String 实例Id, 该参数已废弃,请在Filters内注明
Filters.N Array of Filter 过滤参数;demo模式传{"Name": "IsDemo", "Values":["1"]}
IsDemo Integer 该参数已废弃,demo模式请在Filters内注明
示例值:1

3. 输出参数

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

4. 示例

示例1 查询 RUM 业务系统信息

查询 RUM 业务系统信息

输入示例

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

{}

输出示例

{
    "Response": {
        "InstanceSet": [
            {
                "AreaId": "1",
                "ChargeStatus": 1,
                "ChargeType": 1,
                "ClusterId": "1",
                "CreatedAt": "2021-04-29 20:51:05",
                "DataRetentionDays": "30",
                "InstanceDesc": "",
                "InstanceId": "taw-VJ2mHDEb",
                "InstanceName": "test",
                "InstanceStatus": 2,
                "Tags": [],
                "UpdatedAt": "2021-04-29 20:51:05"
            },
            {
                "AreaId": "1",
                "ChargeStatus": 1,
                "ChargeType": 1,
                "ClusterId": "1",
                "CreatedAt": "2021-04-29 20:59:15",
                "DataRetentionDays": "30",
                "InstanceDesc": "",
                "InstanceId": "taw-mE08H4Ez",
                "InstanceName": "test",
                "InstanceStatus": 2,
                "Tags": [],
                "UpdatedAt": "2021-04-29 20:59:15"
            }
        ],
        "RequestId": "d356e035-ac3d-4237-add9-50a44c01dd39",
        "TotalCount": "2"
    }
}

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签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.DataBaseException 数据操作异常
InternalError 内部错误。
InvalidParameter 参数错误。