ListHCINew - 获取节点列表--边缘智能-火山引擎

文档中心

立即注册

导航

ListHCINew - 获取节点列表

最近更新时间：2025.04.22 15:34:59首次发布时间：2025.04.22 11:47:45

调用本接口获取指定边缘智能项目下的节点（一体机）列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListHCINew	要执行的操作，取值：ListHCINew。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
projectId	String	是	p-2100001281-zf9ll	要查询的边缘智能项目ID。您可以调用ListProject接口获取所有边缘智能项目ID。
page_index	Integer	是	1	设置要返回的页码。
page_size	String	是	10	设置单页包含的最大项目数。
bind_orderby	Integer	是	0	设置节点排序方式。该参数有以下取值： 0：按节点绑定时间降序 1：按节点绑定时间升序
name	String	是	sxn012-bdvbaz	节点ID。
alias	String	否	nodeA	节点别名。
sn	String	是	L4V5********7SC1	节点序列号。
hci_model_ref	String	否	sxn012-bdvbaz	节点型号。
arch	Integer	否	1	CPU 架构。该参数有以下取值： 0：x86 1：ARM
coprocessor	Integer	否	1	协处理器类型。该参数有以下取值： 0：VPU 1：GPU 2：TPU 3：没有 4：NPU
bind_from	String	否	1744597945	节点绑定的开始时间。使用秒级时间戳格式。
bind_to	String	否	1745202745	节点绑定的结束时间。
status	String	否	2	节点状态。该参数有以下取值： 2：在线 3：离线 4：OTA 升级中 5：解绑中 6：解绑失败 7：待解绑 8：绑定中 9：绑定失败 10：重启 11：关机 12：强制解绑中 13：异常 14：迁移中 15：未绑定
account	String	否	21XXXXXXXX	火山引擎账号ID。
tags	Array of Object	是		节点绑定的标签。
nodeGroupIDs	String	是	ng-2100001281-rslq9	节点组ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
items	Array of Object		节点详情。
pageinator	Object		分页配置。

请求示例

POST /?Action=ListHCINew&Version=2022-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250401T113150Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250401/cn-beijing/vei_api/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "projectId": "p-2100001281-zf9ll",
  "page_index": 1,
  "page_size": "10",
  "bind_orderby": 0,
  "name": "sxn012-bdvbaz",
  "sn": "L4V5********7SC1",
  "nodeGroupIDs": "ng-2100001281-rslq9"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202504211040361020260450933354B2",
    "Action": "ListHCINew",
    "Version": "2022-01-01",
    "Service": "vei_api",
    "Region": "cn-beijing"
  },
  "Result": {
    "items": [
      {
        "name": "sxn012-bdvbaz",
        "alias": "nodeA",
        "hci_model_ref": "Jetson Orin NANO",
        "activated_at": "2025-04-14 10:32:21",
        "last_active_at": "2025-04-14 10:34:58",
        "status": 2,
        "monitor_status": 3,
        "node_available_cpu": 7.4,
        "node_available_mem": 29756,
        "ota_status": {
          "ota_job_status": 5,
          "ota_version": "v3.3.0",
          "fail_message": " ",
          "need_upgrade": true,
          "need_manual_upgrade": true
        },
        "cpu_usage": 7.74,
        "memory_usage": 12.68,
        "project_workload_count": 100,
        "node_workload_count": 50
      }
    ],
    "pageinator": {
      "index": 1,
      "size": 10,
      "total_pages": 1,
      "total_items": 1
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	90000015	The account is not authenticated by real name	账号未实名认证。
400	90000021	The account is not authorized to access project	越权访问其他账号下的项目。
400	90000025	The AI Gateway API Key is only allowed for verified enterprise account	仅支持企业认证账号创建边缘大模型网关密钥。
400	50040000	project not found	项目不存在。
500	90000009	Internal service errors	服务内部错误。