查询机器列表

最近更新时间: 2026-09-17 00:03:54

1. 接口描述

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

无

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

接口更新时间：2025-08-22 15:04:37。

接口既验签名又鉴权。

2. 输入参数

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

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

3. 输出参数

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

4. 错误码

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

错误码	描述
InvalidParameter.ParamError	参数错误。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InvalidParameterValue.InvalidParameter	参数 %s 取值错误。
UnauthorizedOperation.CamGeneralError	访问 CAM 系统出错，%s。

5. 示例

示例1 查询机器列表

输入示例

https://tsf.api3.<no value>/?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"
      }
    ]
  }
}