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

最近更新时间: 2026-09-17 00:04:01

1. 接口描述

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

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

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

接口更新时间：2024-09-14 11:55:39。

接口既验签名又鉴权。

2. 输入参数

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

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

3. 输出参数

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

4. 错误码

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

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

5. 示例

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

输入示例

https://tsf.api3.<no value>/?Action=DescribeGroupInstances
&GroupId=group-xxxxxxx
&Offset=0
&Limit=20
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "26528f55-0b7e-4f9c-a122-974fbccd2ab3",
    "Result": {
      "TotalCount": 1,
      "Content": [
        {
          "InstanceId": "ins-xxxxxxx",
          "InstanceName": "test",
          "LanIp": "10.3.0.9",
          "WanIp": "",
          "NamespaceId": "cluster-xxxxxxx",
          "UpdateTime": null,
          "InstanceDesc": null,
          "ClusterId": null,
          "ClusterName": null,
          "InstanceStatus": "Running",
          "InstanceAvailableStatus": "Running",
          "ServiceInstanceStatus": "Running",
          "ServiceSidecarStatus": "UnSupported",
          "OperationState": 0,
          "CountInTsf": null,
          "GroupId": "group-ov6wl65y",
          "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": "20190527183200",
          "ClusterType": null,
          "InstanceZoneId": null,
          "RestrictState": null,
          "InstanceImportMode": "R",
          "ApplicationType": null
        }
      ]
    }
  }
}