1. 接口描述
此接口处于预下线状态 。
预计下线时间:2025-02-03 15:33:36
接口请求域名: iecp.tencentcloudapi.com 。
产品下线
查询边缘节点列表
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeEdgeNodes。 |
Version | 是 | String | 公共参数,本接口取值:2021-09-14。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
EdgeUnitId | 是 | Integer | IECP边缘单元ID 示例值:100001 |
NamePattern | 否 | String | 边缘节点名称模糊搜索串 示例值:testnode |
NameMatchedList.N | 否 | Array of String | 边缘节点名称列表,支持批量查询 ,优先于模糊查询 |
Sort.N | 否 | Array of Sort | 排序信息列表 |
Offset | 否 | Integer | 偏移量 示例值:0 |
Limit | 否 | Integer | 页面大小Limit 示例值:20 |
NodeType | 否 | Integer | 节点类型 示例值:2 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 边缘节点数量 示例值:1 |
NodeSet | Array of EdgeNodeInfo | 节点列表 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询边缘节点列表
输入示例
POST / HTTP/1.1
Host: iecp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEdgeNodes
<公共请求参数>
{
"EdgeUnitId": 8367274,
"Sort": [
{
"Field": "Name",
"Order": "ASC"
}
]
}
输出示例
{
"Response": {
"RequestId": "4c815bfa-0a61-4676-91c7-452ad56a373a",
"TotalCount": 1,
"NodeSet": [
{
"Id": 100152,
"Name": "test-test01",
"Status": 1,
"CpuArchitecture": "amd64",
"Resource": {
"AllocatedCPU": "120m",
"TotalCPU": "4000m",
"AllocatedMemory": "0.15",
"TotalMemory": "7.64",
"AllocatedGPU": "",
"TotalGPU": "",
"AvailableCPU": "",
"AvailableMemory": "6.42",
"AvailableGPU": "0"
},
"Ip": "192.168.8.102",
"CreateTime": "2021-01-01 11:00:00",
"OperatingSystem": "CentOS Linux 7 (Core)",
"NodeUnits": 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签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.DBError | 数据库异常。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.DuplicateName | 名字冲突。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnsupportedOperation | 操作不支持。 |