微服务平台 TSF

3.0

查询机器列表

最近更新时间:2025-03-20 12:36:56

我的收藏

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 过滤条件
示例值:[{"name":"id","values":["ins-xxxxxx"]}]
Offset Integer 偏移量,默认为0
示例值:0
Limit Integer 分页个数,默认为20,最大100
示例值:20

3. 输出参数

参数名称 类型 描述
Result InstanceEnrichedInfoPage 机器列表信息
示例值:{"TotalCount":0,"Content":[]}
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": null,
                    "GroupId": null,
                    "ClusterId": "cluster-xxxxxx",
                    "InstanceStatus": "Running",
                    "InstanceName": "tsf自动化拨测",
                    "WanIp": null,
                    "GroupName": null,
                    "InstanceId": "ins-xxxxxx",
                    "NamespaceId": null,
                    "VpcId": "vpc-xxxxxx",
                    "InstanceAvailableStatus": null,
                    "ClusterName": "tsf-auto-dialtest",
                    "ApplicationId": null,
                    "ApplicationName": null,
                    "NamespaceName": null,
                    "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。

命令行工具

6. 错误码

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

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

如果遇到产品相关问题,您可咨询 在线客服 寻求帮助。

返回顶部
可通过正文划词反馈文档内容问题,我们会快速处理并更新文档内容。