1. 接口描述
接口请求域名： tsf.tencentcloudapi.com 。
查询虚拟机部署组云主机列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeGroupInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-26。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| GroupId | 是 | String | 部署组ID 示例值：group-6a79x94v |
| SearchWord | 否 | String | 搜索字段 示例值：group-name |
| OrderBy | 否 | String | 排序字段 示例值：groupId |
| OrderType | 否 | Integer | 排序类型 示例值：asc |
| Offset | 否 | Integer | 偏移量 示例值：0 |
| Limit | 否 | Integer | 分页个数 示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TsfPageInstance | 部署组机器信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询虚拟机部署组云主机列表
查询虚拟机部署组云主机列表
输入示例
POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGroupInstances
<公共请求参数>
{
"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,
"InstanceAvailableStatus": "Running",
"InstanceChargeType": null,
"InstanceCreatedTime": null,
"InstanceDesc": null,
"InstanceExpiredTime": null,
"InstanceId": "ins-660yl495",
"InstanceImportMode": "M",
"InstanceLimitCpu": null,
"InstanceLimitMem": null,
"InstanceName": "pepyzhang-Mesh升级测试1-勿删",
"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": "请启用健康检查，以便更精确地反映应用运行状态",
"RestrictState": null,
"ServiceInstanceStatus": "Running",
"ServiceSidecarStatus": "Running",
"UpdateTime": null,
"WanIp": "121.4.178.105"
}
],
"TotalCount": 1
}
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.CloudApiProxyError | TSF云API请求调用失败。 |
| FailedOperation.GroupQueryFaild | 部署组查询失败。 |
| FailedOperation.TsfPrivilegeError | TSF权限模块异常，请联系系统管理员。。 |
| InternalError.CamRoleRequestError | TSF云API调用申请角色临时凭证调用请求失败。 |
| InternalError.CloudApiProxyError | TSF云API请求调用失败。 |
| InternalError.InstanceCommonError | TSF节点管理通用错误信息。 |
| InternalError.UnhandledException | [%s]模块未处理异常。。 |
| InvalidParameter.ParamError | 参数错误。 |
| MissingParameter.GroupIdNull | 分组ID不能为空。 |
| ResourceNotFound.GroupNotExist | 此部署组不存在，无法执行该操作。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |
| UnauthorizedOperation.CamGeneralError | 访问 CAM 系统出错，%s。 |
| UnauthorizedOperation.CamTsfRoleNotExist | 当前主账号未创建TSF_QCSRole或未对子账号授予预设策略QcloudCamSubaccountsAuthorizeRoleFullAccess。请参考产品文档主账号协作者使用说明。。 |
| UnauthorizedOperation.NoLicense | 缺少License。。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
