华为云用户手册

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 表1 错误码 状态码 错误码 错误信息 描述 处理措施 400 HIL.0004 Invalid projectId. 非法的项目ID 检查是否输入错误的项目ID 400 HIL.0055 Invalid device name. 非法设备名称 检查是否输入非法的设备名称 403 HIL.0145 Invalid token. 非法的Token 检查是否使用了过期或者非法的token 500 HIL.0002 Internal server error. 服务内部错误 提工单或者联系客服人员解决 父主题： 附录

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 pod_id String pod的ID 状态码： 401 表4 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_code String 错误码 error_message String 错误信息 状态码： 403 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_code String 错误码 error_message String 错误信息 状态码： 404 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_code String 错误码 error_message String 错误信息 状态码： 500 表7 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_code String 错误码 error_message String 错误信息

URI POST /v3/{project_id}/ai-mgr/deployments/{deployment_id}/{pod_id}/action/{action} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参见获取项目ID deployment_id 是 String 部署ID，可以在部署详情中获取指定ID pod_id 是 String 节点ID, 可以在部署详情中获取指定ID action 是 String 操作请求，分别为，pause停止，resume启动

请求示例 启动/停止部署下的指定实例 POST https://{endpoint}/v3/{project_id}/ai-mgr/deployments/{deployment_id}/{pod_id}/action/{action}Request Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 固件数 firmwares Array of ListFirmwaresResponseData objects 固件列表 表4 ListFirmwaresResponseData 参数 参数类型 描述 id String 固件id name String 固件名称 description String 固件描述 version String 固件版本 version_type String 固件版本类型 expire_time String 固件到期时间 firmware_whitelist Array of strings 固件白名单 type String 固件类型 series String 产品系列 device_type String 固件适用设备类型 arch String 边缘节点架构 os_name String 边缘设备操作系统名称 os_type String 边缘节点操作系统类型 os_version String 边缘设备操作系统版本 size Long 当前固件大小(单位:byte) create_time Long 创建时间毫秒数 update_time Long 更新时间毫秒数

响应示例 状态码： 200 请求成功 { "count" : 1, "firmwares" : [ { "id" : "a91e80c5f3174a6ba8b07b1bd5b0f01a", "name" : "HiLens_Device_Agent", "description" : "firmware description.", "version" : "1.0.0", "series" : "Atlas", "device_type" : "Atlas 500", "type" : "incremental", "arch" : "aarch64", "os_name" : "Linux", "os_type" : "Linux", "os_version" : "#1 SMP Mon Mar 16 00:02:15 UTC 2020", "size" : 46301864, "create_time" : 1627302463397, "update_time" : 1627302463397 } ]}

URI GET /v3/ai-mgr/firmwares 表1 Query参数 参数 是否必选 参数类型 描述 device_type 是 String 固件适用设备类型 arch 否 String 边缘节点架构 os_name 否 String 边缘设备操作系统名称 os_version 否 String 边缘设备操作系统版本 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 limit 否 Integer 每页显示的条目数量，取值范围1~100，默认为100

请求示例 获取平台管理费列表 GET https://{endpoint}/v1/{project_id}/platform-manager/ordersRequest Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 订单总数 data Array of OrderForm objects 订单列表 表5 OrderForm 参数 参数类型 描述 amount Integer 订单数量 used_amount Integer 订到已使用数量 cbc_order_id String cbc订单Id device_type String 设备类别 id String 订单Id order_update_time String 订单更新时间 status Integer 订单状态

响应示例 状态码： 200 请求成功 { "data" : [ { "amount" : 10, "used_amount" : 5, "cbc_order_id" : "xxxx", "device_type" : "lite_device", "id" : "7361b5b9069a4270a6f6364e84cd4473", "order_update_time" : "2022-11-11 10:13:48 GMT+08:00", "status" : 0 } ], "total" : 51}

URI GET /v1/{project_id}/platform-manager/orders 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 订单Id，可以根据订单Id查询 device_type 否 String 设备类别：lite_device轻量型设备，small_device小型设备，large_device大型设备，large_device_cpu CPU大型设备， large_device_gpu_npu CPU,NPU大型设备 type 否 String 运行服务费类别，专业版为running_service，标准版为development_service offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 limit 否 Integer 每页显示的条目数量，取值范围1~100，默认为100

响应示例 状态码： 200 请求成功 { "memory" : 15880352, "user_name" : "chace", "created_at" : "2022-02-16 11:01:23 GMT+08:00", "firmware_version" : "2.0.0", "type" : "General ARM Device", "host_ips" : [ "10.90.47.209" ], "firmware_name" : "HiLens_Device_Agent", "npu_num" : 1, "updated_at" : "2022-02-17 15:55:50 GMT+08:00", "id" : "hilens-989c34eeaeda4a5380b7d9f2b101f7f1", "state" : "FAIL", "active_content" : [ "fed6966c29e94bd18cd65debf25e9992", "466b3f957a8448f99a390531d615ee5c" ], "os_version" : "#1 SMP Mon Mar 16 00:02:15 UTC 2020", "cpu" : 16, "enable_npu" : false, "log_configs" : [ { "size" : 50, "type" : "LTS", "component" : "app", "rotate_num" : 5 } ], "enable_gpu" : false, "gpu_num" : 0, "tags" : { }, "enable_container" : true, "active_status" : "ACTIVATED", "npu_info" : { }, "os_type" : "Linux", "name" : "hilens-209", "os_name" : "linux", "arch" : "aarch64"}

请求示例 支持查询HiLens专业版控制台上的某个设备详情。 GET https://{endpoint}/v3/{project_id}/ai-mgr/nodes/{node_id}Request Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户Token。获取方法请参见 获取Token 表3 请求Body参数 参数 是否必选 参数类型 描述 order_id 否 String 订单ID，小型轻型设备激活时使用的订单 cpu_order_id 否 String 订单ID，大型设备使用CPU时激活的订单 npu_gpu_order_id 否 String 订单ID，大型设备使用GPU/NPU时激活的订单

响应示例 状态码： 200 请求成功 { "count" : 26, "nodes" : [ { "firmware_status" : null, "cluster_node_type" : "cluster_controller", "cpu" : 16, "created_at" : "2022-02-16 11:01:23 GMT+08:00", "type" : "General ARM Device", "gpu_num" : 0, "firmware_upgrade_record" : null, "host_ips" : [ "10.90.47.209" ], "tags" : { }, "firmware_name" : "HiLens_Device_Agent", "cluster_id" : "hilens-cf7d36a328334a7599f4004fe917adcb", "active_status" : "ACTIVATED", "npu_num" : 1, "name" : "hilens-209", "id" : "hilens-989c34eeaeda4a5380b7d9f2b101f7f1", "state" : "RUNNING", "upgrade_firmware_version" : null, "cluster_node_state" : "RUNNING" }, { "firmware_status" : null, "cluster_node_type" : null, "cpu" : 0, "created_at" : "2022-02-16 10:33:05 GMT+08:00", "type" : "General ARM Device", "gpu_num" : 0, "firmware_upgrade_record" : null, "host_ips" : [ ], "tags" : { }, "firmware_name" : null, "cluster_id" : null, "active_status" : "INACTIVE", "npu_num" : 0, "name" : "ddp-test111", "id" : "hilens-1027a354fd1c4f2b81fba6d6081ce19f", "state" : "UNCONNECTED", "upgrade_firmware_version" : null, "cluster_node_state" : null }, { "firmware_status" : null, "cluster_node_type" : null, "cpu" : 0, "created_at" : "2022-02-13 21:25:32 GMT+08:00", "type" : "General x86 Device", "gpu_num" : 0, "firmware_upgrade_record" : null, "host_ips" : [ ], "tags" : { }, "firmware_name" : null, "cluster_id" : null, "active_status" : "INACTIVE", "npu_num" : 0, "name" : "my-test-device", "id" : "hilens-3f665c35ea3b471880c1499e05a3c630", "state" : "UNCONNECTED", "upgrade_firmware_version" : null, "cluster_node_state" : null }, { "firmware_status" : null, "cluster_node_type" : "cluster_controller", "cpu" : 16, "created_at" : "2022-02-11 17:07:32 GMT+08:00", "type" : "General ARM Device", "gpu_num" : 0, "firmware_upgrade_record" : null, "host_ips" : [ "10.90.47.208" ], "tags" : { }, "firmware_name" : "HiLens_Device_Agent", "cluster_id" : "hilens-cf7d36a328334a7599f4004fe917adcb", "active_status" : "ACTIVATED", "npu_num" : 1, "name" : "hilens-208", "id" : "hilens-4f7ff1e5da1c4051861e50b336efde0b", "state" : "RUNNING", "upgrade_firmware_version" : null, "cluster_node_state" : "FAIL" }, { "firmware_status" : null, "cluster_node_type" : null, "cpu" : 48, "created_at" : "2022-02-10 20:44:43 GMT+08:00", "type" : "General x86 Device", "gpu_num" : 3, "firmware_upgrade_record" : null, "host_ips" : [ "10.216.139.114" ], "tags" : { }, "firmware_name" : "HiLens_Device_Agent_x86", "cluster_id" : null, "active_status" : "ACTIVATED", "npu_num" : 0, "name" : "egypt-x86-test-114", "id" : "hilens-e2423376a61e4265a2ffd253a3493b35", "state" : "FAIL", "upgrade_firmware_version" : null, "cluster_node_state" : null } ]}

请求示例 分页查询HiLens控制台专业版设备列表 GET https://{endpoint}/v3/{project_id}/ai-mgr/nodes?offset=0&limit=10&provider=hilensRequest Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户Token。获取方法请参见获取Token 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 否 Array of NodeResource objects 资源列表 tags 否 Array of NodeTag objects 标签列表 表4 NodeResource 参数 是否必选 参数类型 描述 resource_id 否 String 资源ID resource_type 否 String 资源类型 表5 NodeTag 参数 是否必选 参数类型 描述 key 否 String 标签键，最大长度36个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” value 否 String 标签值，每个值最大长度43个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”

请求示例 针对多个设备批量添加多个标签 POST https://{endpoint}/v3/{project_id}/tag-mgr/node-tags{ "resources" : [ { "resource_type" : "node", "resource_id" : "hilens-989c34eeaeda4a5380b7d9f2b101f7f1" }, { "resource_type" : "node", "resource_id" : "hilens-3f665c35ea3b471880c1499e05a3c630" } ], "tags" : [ { "key" : "k1", "value" : "v1" } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户Token。获取方法请参见获取Token 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of TagObject objects 资源标签对列表 表4 TagObject 参数 是否必选 参数类型 描述 key 否 String 标签键，最大长度36个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” value 否 String 标签值，每个值最大长度43个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”

URI POST /v3/{project_id}/{resource_type}/{resource_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID resource_id 是 String 资源ID，不同资源（节点，部署，配置项，密钥）有不同的资源ID resource_type 是 String 资源类型（节点，部署，配置项，密钥）

请求示例 启停某个设备 POST https://{endpoint}/v3/{project_id}/ai-mgr/nodes/{node_id}/action/{action}Request Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

URI POST /v3/{project_id}/ai-mgr/nodes/{node_id}/action/{action} 表1 路径参数 参数 是否必选 参数类型 描述 node_id 是 String 设备ID，从专业版HiLens控制台设备管理查询设备列表获取 project_id 是 String 项目ID。获取方法请参见获取项目ID action 是 String 设备启用/停用动作，启用（start）,停用（stop） 表2 Query参数 参数 是否必选 参数类型 描述 provider 否 String 服务提供者：ief或hilens，选择设备纳管到不同的平台。不填默认为hilens平台

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 order_id String 订单ID 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 order_id String 订单ID 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户Token。获取方法请参见获取Token 表4 请求Body参数 参数 是否必选 参数类型 描述 configmap 是 ConfigMap object 配置项详情 workspace_id 否 String 工作空间ID，默认为注册账号/子账号的default工作空间，可通过专业版HiLens控制台展开工作空间列表获取到工作空间ID 表5 ConfigMap 参数 是否必选 参数类型 描述 configs 是 Array of Config objects 配置列表 created_at 否 String 创建时间 description 否 String 描述 id 否 String 配置项ID name 是 String 名称 project_id 否 String 项目ID tags 是 Array of Tag objects 标签列表 type 否 String 类型 updated_at 否 String 更新时间 workspace_id 否 String 工作空间ID 表6 Config 参数 是否必选 参数类型 描述 key 是 String 配置项key，最大长度63个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” value 是 String 配置项value，每个值最大长度10000个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” 表7 Tag 参数 是否必选 参数类型 描述 key 是 String 标签键，最大长度36个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” value 是 String 标签值，每个值最大长度43个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”

请求示例 新建配置项 POST https://{endpoint}/v3/{project_id}/ai-mgr/configmaps{ "configmap" : { "configs" : [ { "key" : "string", "value" : "string" } ], "created_at" : "string", "description" : "string", "id" : "string", "name" : "string", "project_id" : "string", "tags" : [ { "key" : "string", "value" : "string" } ], "type" : "string", "updated_at" : "string", "workspace_id" : "string" }, "workspace_id" : "string"}

响应示例 状态码： 200 请求成功 { "configmap" : { "configs" : [ { "key" : "string", "value" : "string" } ], "created_at" : "string", "description" : "string", "id" : "string", "name" : "string", "project_id" : "string", "tags" : [ { "key" : "string", "value" : "string" } ], "type" : "string", "updated_at" : "string", "workspace_id" : "string" }, "workspace_id" : "string"}

响应参数 状态码： 200 表8 响应Body参数 参数 参数类型 描述 configmap ConfigMap object 配置项详情 workspace_id String 工作空间ID，默认为注册账号/子账号的default工作空间，可通过专业版HiLens控制台展开工作空间列表获取到工作空间ID 表9 ConfigMap 参数 参数类型 描述 configs Array of Config objects 配置列表 created_at String 创建时间 description String 描述 id String 配置项ID name String 名称 project_id String 项目ID tags Array of Tag objects 标签列表 type String 类型 updated_at String 更新时间 workspace_id String 工作空间ID 表10 Config 参数 参数类型 描述 key String 配置项key，最大长度63个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” value String 配置项value，每个值最大长度10000个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” 表11 Tag 参数 参数类型 描述 key String 标签键，最大长度36个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” value String 标签值，每个值最大长度43个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户Token。获取方法请参见获取Token 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 工作空间名 enterprise_project_id 是 String 企业项目id，默认为0 enterprise_project_name 是 String 企业项目名，默认为default description 否 String 工作空间描述

请求示例 创建新的密钥 POST https://{endpoint}/v3/{project_id}/ai-mgr/secrets{ "workspace_id" : "string", "secret" : { "name" : "string", "description" : "string", "secrets" : [ { "key" : "string", "value" : "string" } ], "tags" : [ { "key" : "string", "value" : "string" } ] }}