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

1. 接口描述

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstances。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 过滤条件
Offset Integer 偏移量,默认为0
Limit Integer 分页个数,默认为20,最大100

3. 输出参数

参数名称 类型 描述
Result InstanceEnrichedInfoPage 机器列表信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询机器列表

输入示例

https://tsf.tencentcloudapi.com/?Action=DescribeInstances
&Filters.0.Name=name
&Filters.0.Values.0=pepy
&Filters.0.Values.1=zeni
&<公共请求参数>

输出示例

{
    "RequestId": "1f2a5c1d-d94b-4296-9b1a-208b237b64da",
    "Result": {
        "TotalCount": 1,
        "Content": [
            {
                "ClusterType": "V",
                "ApplicationType": "V",
                "GroupId": "group-gvklblao",
                "ClusterId": "cluster-by8mnkak",
                "InstanceStatus": "Running",
                "InstanceName": "zeni_2",
                "WanIp": "111.231.188.89",
                "GroupName": "rocketmq-consumer",
                "InstanceId": "ins-0wud1su6",
                "NamespaceId": "namespace-nalpdwyq",
                "VpcId": "vpc-imscnlpv",
                "InstanceAvailableStatus": "Running",
                "ClusterName": "zeni-rocketmq",
                "ApplicationId": "application-maejqev3",
                "ApplicationName": "zeni-rocketmq",
                "NamespaceName": "zeni-rocketmq_default",
                "LanIp": "172.30.0.68"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.TsfPrivilegeError TSF权限模块异常,请联系系统管理员。。
InvalidParameter.ParamError 参数错误。
InvalidParameterValue.InvalidParameter 参数 %s 取值错误。
UnauthorizedOperation.CamGeneralError 访问 CAM 系统出错,%s。
UnauthorizedOperation.CamTsfRoleNotExist 当前主账号未创建TSF_QCSRole或未对子账号授予预设策略QcloudCamSubaccountsAuthorizeRoleFullAccess。请参考产品文档主账号协作者使用说明。。