查找虚机资源池实例列表

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

1. 接口描述

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

资源池实例列表

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

接口更新时间：2025-08-06 23:23:55。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeResourcePoolInstances
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ClusterId	是	否	String	资源池所属集群 ID 示例值：
ResourcePoolId	是	否	String	资源池 ID 示例值：
Offset	否	否	Int64	偏移量示例值：
Limit	否	否	Int64	分页个数示例值：
SearchWord	否	否	String	搜索字段，目前只支持 instanceid 示例值：

3. 输出参数

参数名称	类型	描述
Result	TsfPageResourcePoolInstance	资源池实例分页对象示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
ResourceNotFound.ClusterNotExist	无法获取命名空间所属集群。
MissingParameter.ClusterIdRequired	集群ID未填写。
FailedOperation	操作失败。
FailedOperation.SendRequest
FailedOperation.AccessTagFail

5. 示例

示例1 资源池实例列表

输入示例

POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeResourcePoolInstances
<Common Parameters>

{"Offset":0,"Limit":20,"ClusterId":"cluster-xxx","ResourcePoolId":"resourcepool-xxx"}

输出示例

{
  "Response": {
    "RequestId": "xx-x-x-x-x",
    "Result": {
      "TotalCount": 1,
      "Content": [
        {
          "InstanceId": "ins-xx",
          "InstanceName": "xx-xx",
          "LanIp": "1.1.1.1",
          "WanIp": "1.1.1.1",
          "InstanceStatus": "Running",
          "InstanceAvailableStatus": "Running",
          "ResourcePoolId": "resourcepool-xx",
          "Zone": "ap-gz-2"
        }
      ]
    }
  }
}