1. 接口描述
接口请求域名: tsf.api3.fincloud.tencent.cn。
查询简单集群列表
默认接口请求频率限制:20次/秒。
接口更新时间:2024-09-14 11:55:39。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeSimpleClusters |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-03-26 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ClusterIdList | 否 | 否 | Array of String | 需要查询的集群ID列表,不填或不传入时查询所有内容 示例值: |
| ClusterType | 否 | 否 | String | 需要查询的集群类型,不填或不传入时查询所有内容 示例值: |
| Offset | 否 | 否 | Int64 | 查询偏移量,默认为0 示例值: |
| Limit | 否 | 否 | Int64 | 分页个数,默认为20, 取值应为1~50 示例值: |
| SearchWord | 否 | 否 | String | 对id和name进行关键词过滤 示例值: |
| DisableProgramAuthCheck | 否 | 否 | Bool | 无 示例值: |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TsfPageCluster | TSF集群分页对象 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ParamError | 参数错误。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| FailedOperation.ClusterQueryFailed | 查询集群失败。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |
| UnauthorizedOperation.NoLicense | 缺少License。。 |
5. 示例
示例1 查询简单集群列表
输入示例
https://tsf.api3.<no value>/?Action=DescribeSimpleClusters
&Offset=0
&Limit=50
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "73d633f3-1d91-443a-a5bb-b4d419a56721",
"Result": {
"TotalCount": 2,
"Content": [
{
"ClusterId": "cls-xxxxxxx",
"ClusterName": "示例",
"ClusterDesc": null,
"ClusterType": "C",
"VpcId": "vpc-xxxxxxx",
"CreateTime": null,
"UpdateTime": null,
"ClusterStatus": null,
"ClusterCIDR": null,
"ClusterTotalCpu": null,
"ClusterTotalMem": null,
"ClusterUsedCpu": null,
"ClusterUsedMem": null,
"ClusterLimitCpu": null,
"ClusterLimitMem": null,
"InstanceCount": null,
"RunInstanceCount": null,
"RunServiceInstanceCount": null,
"NormalInstanceCount": null,
"DeleteFlag": null,
"DeleteFlagReason": null,
"OperationInfo": null,
"TsfRegionId": null,
"TsfRegionName": null,
"TsfZoneId": null,
"TsfZoneName": null
},
{
"ClusterId": "cls-xxxxxxx",
"ClusterName": "示例",
"ClusterDesc": null,
"ClusterType": "C",
"VpcId": "vpc-xxxxxxx",
"CreateTime": null,
"UpdateTime": null,
"ClusterStatus": null,
"ClusterCIDR": null,
"ClusterTotalCpu": null,
"ClusterTotalMem": null,
"ClusterUsedCpu": null,
"ClusterUsedMem": null,
"ClusterLimitCpu": null,
"ClusterLimitMem": null,
"InstanceCount": null,
"RunInstanceCount": null,
"RunServiceInstanceCount": null,
"NormalInstanceCount": null,
"DeleteFlag": null,
"DeleteFlagReason": null,
"OperationInfo": null,
"TsfRegionId": null,
"TsfRegionName": null,
"TsfZoneId": null,
"TsfZoneName": null
}
]
}
}
}