微服务平台 TSF 查询机器列表

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	过滤条件。多个 filter 之间是与关系，单个 filter 多个 value 之间是或关系。参考：[{"Name":"ip","Values":["172.16.16.139"]}] filter name 取值范围： - `id`：实例ID - `name`：实例名 - `ip`：内网IP（可填wan_ip或lan_ip）
Offset	否	Integer	偏移量，默认为0 示例值：0
Limit	否	Integer	分页个数，默认为20，最大100 示例值：20

3. 输出参数

参数名称	类型	描述
Result	InstanceEnrichedInfoPage	机器列表信息
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
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "d2de5f06-bc71-4bd5-aa93-1188ce24aa46",
        "Result": {
            "TotalCount": 1,
            "Content": [
                {
                    "ClusterType": "V",
                    "ApplicationType": "",
                    "GroupId": "group-id",
                    "ClusterId": "cluster-xxxxxx",
                    "InstanceStatus": "Running",
                    "InstanceName": "tsf自动化拨测",
                    "WanIp": "",
                    "GroupName": "name",
                    "InstanceId": "ins-xxxxxx",
                    "NamespaceId": "nid",
                    "VpcId": "vpc-xxxxxx",
                    "InstanceAvailableStatus": "",
                    "ClusterName": "tsf-auto-dialtest",
                    "ApplicationId": "application-id",
                    "ApplicationName": "app-name",
                    "NamespaceName": "namespace-name",
                    "LanIp": "10.0.2.4"
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。
InvalidParameter.ParamError	参数错误。
InvalidParameterValue.InvalidParameter	示例：参数 Region 取值错误。
UnauthorizedOperation.CamGeneralError	示例：访问 CAM 系统出错，具体报错信息。
UnauthorizedOperation.CamTsfRoleNotExist	当前主账号未创建TSF_QCSRole或未对子账号授予预设策略QcloudCamSubaccountsAuthorizeRoleFullAccess。请参考产品文档主账号获取访问授权。

查询机器列表

本页目录：