1. 接口描述
接口请求域名： tcss.tencentcloudapi.com 。
安全概览和集群安全页进入调用该接口，查询用户集群相关信息。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeUserCluster。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-01。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Offset | 否 | Integer | 偏移量 示例值：0 |
| Limit | 否 | Integer | 每次查询的最大记录数量 示例值：20 |
| Filters.N | 否 | Array of ComplianceFilters | Name - String Name 可取值：ClusterName,ClusterId,ClusterType,Region,ClusterCheckMode,ClusterAutoCheck 示例值：[{"ClusterName":[""ClusterName1]}] |
| By | 否 | String | 排序字段 示例值：HighRiskCount |
| Order | 否 | String | 排序方式 asc,desc 示例值：asc |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 集群总数 示例值：10 |
| ClusterInfoList | Array of ClusterInfoItem | 集群的详细信息 示例值：[{"AccessedStatus": "AccessedDefe", "AccessedSubStatus": "AccessedSub", "ChargeCoresCnt": 364000, "CheckFailReason": "", "CheckStatus": "Uncheck", "ClusterAuditFailedInfo": "", "ClusterAuditStatus": "Closed", "ClusterAutoCheck": false, "ClusterCheckMode": "", "ClusterId": "2f0ff9facc53a579b4b4e44e8932", "ClusterName": "umeng", "ClusterNodeNum": 12, "ClusterOs": "", "ClusterStatus": "CSR_RUN", "ClusterType": "USER_CREATE_CLU", "ClusterVersion": "v1.19.16", "CoresCnt": 364000, "DefenderErrorReason": "", "DefenderStatus": "Defended", "HighRiskCount": 0, "HintRiskCount": 0, "MasterAddresses": ["10.188.251.101;10.188.251.102;10.188.251.****"], "MiddleRiskCount": 0, "NodeCount": 12, "OffLineNodeCount": 0, "Region": null, "SeriousRiskCount": 0, "TaskCreateTime": "", "UnInstallAgentNodeCount": 0, "UnreadyNodeNum": 12}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询用户集群列表
查询用户集群列表
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserCluster
<公共请求参数>
{
"Limit": "2",
"Offset": "0"
}输出示例
{
"Response": {
"ClusterInfoList": [
{
"AccessedStatus": "AccessedPartialDefence",
"AccessedSubStatus": "AccessedSubNone",
"ChargeCoresCnt": 4000,
"CheckFailReason": "SUCCESS",
"CheckStatus": "HasRisk",
"ClusterAuditFailedInfo": "ClusterAuditFailedInfo",
"ClusterAuditStatus": "Opened",
"ClusterAutoCheck": false,
"ClusterCheckMode": "ClusterCheckMode",
"ClusterId": "cls-abhq0j4o",
"ClusterName": "bx_test_tmp",
"ClusterNodeNum": 4,
"ClusterOs": "centos",
"ClusterStatus": "CSR_RUNNING",
"ClusterSubStatus": "3",
"ClusterType": "INDEPENDENT_CLUSTER",
"ClusterVersion": "1.28.3",
"CoresCnt": 12000,
"DefenderErrorReason": "DefenderErrorReason",
"DefenderStatus": "UnDefended",
"HighRiskCount": 6,
"HintRiskCount": 3,
"MasterAddresses": [
"10.0.0.11;10.0.0.14;10.0.0.4;"
],
"MiddleRiskCount": 7,
"NodeCount": 4,
"OffLineNodeCount": 0,
"Region": "ap-guangzhou",
"SeriousRiskCount": 1,
"TaskCreateTime": "2024-10-30 14:41:25",
"UnInstallAgentNodeCount": 1,
"UnreadyNodeNum": 3
}
],
"RequestId": "8a64a4f9-864c-49c6-adcb-21b483de477a",
"TotalCount": 7
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| UnauthorizedOperation | 未授权操作。 |
