DescribeGroup
最近更新时间: 2025-10-20 17:06:15
1. 接口描述
接口请求域名: tsf.api3.fincloud.tencent.cn。
查询虚拟机部署组详情
默认接口请求频率限制:20次/秒。
接口更新时间:2020-10-21 23:13:20。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeGroup |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-26 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| GroupId | 是 | 否 | String | 部署组ID |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | VmGroup | 此参数对外不可见。 虚拟机部署组详情 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ParamError | 参数错误。 |
| ResourceNotFound.GroupNotExist | 此部署组不存在,无法执行该操作。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| InternalError.GroupCommonError | 部署组通用异常。 |
| InternalError.UnhandledException | [%s]模块未处理异常。。 |
| MissingParameter.GroupIdNull | 分组ID不能为空。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |
| InvalidParameter.RepoPackageParamError | 请求参数有误。 |