查询集群实例

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

1. 接口描述

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

查询集群实例

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

接口更新时间：2026-02-04 22:16:17。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeClusterInstances
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Offset	否	否	Int64	偏移量示例值： 0
Limit	否	否	Int64	分页个数示例值： 10
OnlyEKS	否	否	Bool	是否只查询EKS超级节点(容器集群) 示例值： false
ClusterId	是	否	String	集群ID 示例值： cluster-jnygqpv2
SearchWord	否	否	String	搜索字段示例值： cluster
OrderBy	否	否	String	排序字段示例值： instanceName
OrderType	否	否	Int64	排序类型示例值： 1

3. 输出参数

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

4. 错误码

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

错误码	描述
FailedOperation.GroupQueryFailed	事务分组查询失败。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。
FailedOperation.ContainergroupKuberneteConnectError	连接 kube-api-sever 失败。
FailedOperation.GroupQueryFaild	部署组查询失败。
InternalError.ContainergroupKuberneteConnectError	连接TKE服务失败。
FailedOperation.ContainergroupKubernetesConnectError	调用 kube-api-server 失败。
FailedOperation.CloudApiProxyError	TSF云API请求调用失败。
FailedOperation.UnhandledException	模块未处理异常。
ResourceNotFound.ClusterNotExist	无法获取命名空间所属集群。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
FailedOperation.InstanceUpdateFailed	机器实例更新失败。
UnauthorizedOperation.CamGeneralError	访问 CAM 系统出错，%s。
InvalidParameter.ParamError	参数错误。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InternalError.CloudApiProxyError	TSF云API请求调用失败。
InternalError.UnhandledException	[%s]模块未处理异常。。
InternalError.CamRoleRequestError	TSF云API调用申请角色临时凭证调用请求失败。
InternalError.ClusterNotExistOrPrivilegeError	无法找到部署组，或相应集群/命名空间/应用的权限不足。
InternalError.InstanceCommonError	TSF节点管理通用错误信息。
FailedOperation.InstanceQueryFailed	查询机器实例部分失败。
UnauthorizedOperation.NoLicense	缺少License。。
MissingParameter.ClusterIdRequired	集群ID未填写。

5. 示例

示例1 查询集群机器列表

输入示例

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

{
    "Limit": "20",
    "ClusterId": "cluster-xxxxxxx",
    "Offset": "0"
}

输出示例

{
  "Response": {
    "RequestId": "a92e58d4-b415-4069-910e-c84e60233019",
    "Result": {
      "TotalCount": 2,
      "Content": [
        {
          "InstanceId": "ins-6a79x94v",
          "NodeInstanceId": "ins-6a79x94v",
          "InstanceName": "consumer",
          "LanIp": "172.16.0.7",
          "WanIp": "193.112.32.241",
          "NamespaceId": "namespace-6a79x94v",
          "NamespaceName": "test-namespace",
          "UpdateTime": null,
          "InstanceDesc": null,
          "ClusterId": null,
          "ClusterName": null,
          "InstanceStatus": null,
          "InstanceAvailableStatus": "Abnormal",
          "ServiceInstanceStatus": "Stopped",
          "ServiceSidecarStatus": "UnSupported",
          "OperationState": 6,
          "CountInTsf": null,
          "GroupId": "",
          "GroupName": null,
          "ApplicationId": null,
          "ApplicationName": null,
          "InstanceCreatedTime": null,
          "InstanceExpiredTime": null,
          "InstanceChargeType": null,
          "InstanceTotalCpu": null,
          "InstanceTotalMem": null,
          "InstanceUsedCpu": null,
          "InstanceUsedMem": null,
          "InstanceLimitCpu": null,
          "InstanceLimitMem": null,
          "InstancePkgVersion": "",
          "ClusterType": null,
          "InstanceZoneId": null,
          "RestrictState": null,
          "InstanceImportMode": "R",
          "Reason": "R",
          "ApplicationResourceType": "def",
          "AgentVersion": "1.46.0",
          "ApplicationType": null
        }
      ]
    }
  }
}