1. 接口描述
接口请求域名: iecp.tencentcloudapi.com 。
查询边缘集群详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeEdgeUnitCloud。 |
Version | 是 | String | 公共参数,本接口取值:2021-09-14。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
EdgeUnitId | 是 | Integer | 边缘集群ID 示例值:333 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Name | String | 边缘集群名称 示例值:api-test |
Description | String | 描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:desc |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-10-09 06:58:24 |
UpdateTime | String | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-10-09 06:58:24 |
LiveTime | String | 集群最后探活时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-10-09 15:19:03 |
MasterStatus | String | 集群状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:Running |
K8sVersion | String | 版本号 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.16.7 |
PodCIDR | String | pod cidr 注意:此字段可能返回 null,表示取不到有效值。 示例值:10.1.0.0/16 |
ServiceCIDR | String | service cidr 注意:此字段可能返回 null,表示取不到有效值。 示例值:10.2.0.0/16 |
APIServerAddress | String | 集群内网访问地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.1.1.1:2727 |
APIServerExposeAddress | String | 集群外网访问地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:2.2.2.2:6443 |
UID | String | 用户ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:2222 |
UnitID | Integer | 集群ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:33333 |
Cluster | String | 集群标识 注意:此字段可能返回 null,表示取不到有效值。 示例值:cls-ssssss |
Node | EdgeUnitStatisticItem | 节点统计 注意:此字段可能返回 null,表示取不到有效值。 |
Workload | EdgeUnitStatisticItem | 工作负载统计 注意:此字段可能返回 null,表示取不到有效值。 |
Grid | EdgeUnitStatisticItem | Grid应用统计 注意:此字段可能返回 null,表示取不到有效值。 |
SubDevice | EdgeUnitStatisticItem | 设备统计 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取集群详细实例
输入示例
POST / HTTP/1.1
Host: iecp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEdgeUnitCloud
<公共请求参数>
{
"EdgeUnitId": "5"
}
输出示例
{
"Response": {
"RequestId": "61abe8f0-ef42-4432-ad55-6092baaec209",
"Name": "test-11",
"Description": "字符串",
"CreateTime": "2021-10-09 15:49:37",
"UpdateTime": "2021-10-09 15:49:37",
"LiveTime": "2021-10-09 16:15:40",
"MasterStatus": "Running",
"K8sVersion": "1.16.7",
"PodCIDR": "10.1.0.0/16",
"ServiceCIDR": "10.2.0.0/16",
"APIServerAddress": "11.38.56.131:11302",
"APIServerExposeAddress": "211.159.144.178:443",
"UID": "600000559632",
"UnitID": 5,
"Cluster": "cls-g6uuoeez",
"Node": {
"NotActive": 0,
"Offline": 0,
"Total": 1,
"Abnormal": 0,
"Online": 1
},
"Grid": {
"NotActive": 0,
"Offline": 0,
"Total": 0,
"Abnormal": 0,
"Online": 0
},
"Workload": {
"NotActive": 1,
"Offline": 1,
"Total": 1,
"Abnormal": 1,
"Online": 1
},
"SubDevice": null
}
}
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签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.DBError | 数据库异常。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.DuplicateName | 名字冲突。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |