获取机器组列表

最近更新时间: 2024-10-18 10:38:40

1. 接口描述

接口请求域名: cls.api3.fincloud.tencent.cn。

获取机器组信息列表

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

接口更新时间:2022-10-31 11:10:35。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeMachineGroups
Version String 公共参数,本接口取值:2020-10-16
Region String 公共参数,详见产品支持的地域列表(TODO)
Filters Array of Filter <br><li> machineGroupName<br><br>按照【机器组名称】进行过滤。<br>类型:String<br><br>必选:否<br><br><br><li> machineGroupId<br><br>按照【机器组ID】进行过滤。<br>类型:String<br><br>必选:否<br><br><br><li> tagKey<br><br>按照【标签键】进行过滤。<br><br>类型:String<br><br>必选:否<br><br><br><li> tag:tagKey<br><br>按照【标签键值对】进行过滤。tagKey使用具体的标签键进行替换。<br>类型:String<br><br>必选:否<br><br><br>每次请求的Filters的上限为10,Filter.Values的上限为5。
Offset Int64 分页的偏移量,默认值为0
Limit Int64 分页单页的限制数目,默认值为20,最大值100

3. 输出参数

参数名称 类型 描述
MachineGroups MachineGroupInfo 此参数对外不可见。
机器组信息列表
TotalCount Int64 此参数对外不可见。
分页的总数目
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameter
InvalidParameterValue
InternalError
FailedOperation
AuthFailure
OperationDenied
OperationDenied.AccountIsolate
OperationDenied.AccountDestroy
OperationDenied.AccountNotExists