1. 接口描述
接口请求域名: cls.api3.fincloud.tencent.cn。
获取机器组信息列表
默认接口请求频率限制:20次/秒。
接口更新时间:2025-01-15 01:39:48。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeMachineGroups |
| Version | 是 | 否 | String | 公共参数,本接口取值:2020-10-16 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Filters | 否 | 否 | Array of Filter | machineGroupName 按照【机器组名称】进行过滤。 类型:String 必选:否 machineGroupId 按照【机器组ID】进行过滤。 类型:String 必选:否 osType 按照【操作系统类型】进行过滤。 类型:Int 必选:否 tagKey 按照【标签键】进行过滤。 类型:String 必选:否 tag:tagKey 按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换。 类型:String 必选:否 每次请求的Filters的上限为10,Filter.Values的上限为5。 示例值:查看 |
| Offset | 否 | 否 | Int64 | 分页的偏移量,默认值为0 示例值: 0 |
| Limit | 否 | 否 | Int64 | 分页单页的限制数目,默认值为20,最大值100 示例值: 10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| MachineGroups | Array of MachineGroupInfo | 机器组信息列表 示例值:查看 |
| TotalCount | Int64 | 分页的总数目 示例值: 10 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
| AuthFailure | CAM签名/鉴权错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |