查询虚拟机部署组云主机列表

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

1. 接口描述

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

查询虚拟机部署组云主机列表

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

接口更新时间：2026-02-04 21:06:42。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeGroupInstances
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
GroupId	是	否	String	部署组ID 示例值： group-6a79x94v
SearchWord	否	否	String	搜索字段示例值： group-name
OrderBy	否	否	String	排序字段示例值： groupId
OrderType	否	否	Int64	排序类型示例值： 0
Offset	否	否	Int64	偏移量示例值： 0
Limit	否	否	Int64	分页个数示例值： 20

3. 输出参数

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

4. 错误码

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

错误码	描述
FailedOperation.GroupQueryFailed	事务分组查询失败。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。
FailedOperation.GroupQueryFaild	部署组查询失败。
FailedOperation.CloudApiProxyError	TSF云API请求调用失败。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
ResourceNotFound.GroupNotExist	此部署组不存在，无法执行该操作。
UnauthorizedOperation.CamGeneralError	访问 CAM 系统出错，%s。
InvalidParameter.ParamError	参数错误。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InternalError.CloudApiProxyError	TSF云API请求调用失败。
UnauthorizedOperation.CamTsfRoleNotExist	当前主账号未创建TSF_QCSRole或未对子账号授予预设策略QcloudCamSubaccountsAuthorizeRoleFullAccess。请参考产品文档主账号协作者使用说明。。
InternalError.UnhandledException	[%s]模块未处理异常。。
InternalError.CamRoleRequestError	TSF云API调用申请角色临时凭证调用请求失败。
InternalError.InstanceCommonError	TSF节点管理通用错误信息。
UnauthorizedOperation.NoLicense	缺少License。。
MissingParameter.GroupIdNull	分组ID不能为空。

5. 示例

示例1 查询虚拟机部署组云主机列表

查询虚拟机部署组云主机列表

输入示例

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

{
  "GroupId": "group-v6743bka"
}

输出示例

{
  "Response": {
    "RequestId": "57578845-90a3-4f98-b166-a1822f3a7223",
    "Result": {
      "Content": [
        {
          "AgentVersion": "1.44.0",
          "ApplicationId": null,
          "ApplicationName": null,
          "ApplicationResourceType": null,
          "ApplicationType": null,
          "ClusterId": "cluster-y4rb3qja",
          "ClusterName": null,
          "ClusterType": null,
          "CountInTsf": null,
          "GroupId": "group-v6743bka",
          "GroupName": null,
          "InstanceAdvancedSettings": null,
          "InstanceAvailableStatus": "Running",
          "InstanceChargeType": null,
          "InstanceCreatedTime": null,
          "InstanceDesc": null,
          "InstanceExpiredTime": null,
          "InstanceId": "ins-660yl495",
          "InstanceImportMode": "M",
          "InstanceLimitCpu": null,
          "InstanceLimitMem": null,
          "InstanceName": "test-instance",
          "InstancePkgVersion": "20210826163718",
          "InstanceStatus": "Running",
          "InstanceTotalCpu": null,
          "InstanceTotalMem": null,
          "InstanceUsedCpu": null,
          "InstanceUsedMem": null,
          "InstanceZoneId": null,
          "LanIp": "10.0.1.16",
          "NamespaceId": null,
          "NamespaceName": null,
          "NodeInstanceId": null,
          "OperationState": 0,
          "Reason": "Please enable healthchecks to more accurately reflect the application's running status.",
          "RestrictState": null,
          "ServiceInstanceStatus": "Running",
          "ServiceSidecarStatus": "Running",
          "UpdateTime": null,
          "WanIp": "121.4.178.105"
        }
      ],
      "TotalCount": 1
    }
  }
}