查询机器列表

最近更新时间: 2026-10-11 00:12:02

1. 接口描述

接口请求域名： tsf.api3.fincloud.tencent.com。

无

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

接口更新时间：2026-02-04 22:08:52。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeInstances
Version 是 否 String 公共参数，本接口取值：2018-03-26
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Limit 否 否 Uint64 分页个数，默认为20，最大100
示例值： 10
Filters 否 否 Array of Filter 过滤条件，name表示过滤字段，value表示过滤字段值。
示例值：查看
Offset 否 否 Uint64 偏移量，默认为0
示例值： 0

3. 输出参数

参数名称 类型 描述
Result InstanceEnrichedInfoPage 机器列表信息
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 查询机器列表

输入示例

https://tsf.api3.fincloud.tencent.com/?Action=DescribeInstances
&Filters.0.Name=name
&Filters.0.Values.0=pepy
&Filters.0.Values.1=zeni
&<Common Parameters>

输出示例

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