华为云用户手册

请求示例 创建新的密钥 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" } ] }}

响应参数 状态码： 200 表8 响应Body参数 参数 参数类型 描述 workspace_id String 工作空间ID secret secret object 密钥 表9 secret 参数 参数类型 描述 id String 密钥ID name String 密钥名称 description String 密钥描述 project_id String 项目ID created_at String 密钥创建时间 updated_at String 密钥更新时间 secrets Array of Secret objects 密钥列表 tags Array of Tag objects 标签列表 表10 Secret 参数 参数类型 描述 key String 密钥key，最大长度63个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” value String 密钥value，每个值最大长度10000个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” 表11 Tag 参数 参数类型 描述 key String 标签key，最大长度36个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” value String 标签value，每个值最大长度43个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”

响应示例 状态码： 200 技能详情 { "sub_scenes" : "行人轨迹", "icon" : null, "version_num" : 1, "description" : null, "product_info" : [ ], "type" : "standard", "platform" : "Linux", "self_dev_flag" : 1, "approval_result" : "ok", "measure_type" : "physical_src", "update_time" : "2022-06-30 17:30:32 GMT+08:00", "channel_limit" : 10000, "publish_time" : "2022-06-30 17:31:52 GMT+08:00", "resource_step_size" : 1, "approval_time" : "2022-06-30 17:30:32 GMT+08:00", "cloud_service_type" : null, "test_status" : 0, "chip" : "Ascend 310", "is_verify_model" : false, "format" : "file", "resource_type" : null, "version" : "1.0.0", "measure_unit" : "qps", "tags" : [ ], "size" : 1439, "test_result" : null, "versions" : [ "1.0.0" ], "install_times" : 0, "privacy_policy" : [ ], "name" : "create26xDM", "scenes" : [ ], "charge_model" : 2, "resource_spec_code" : null, "skill_id" : 12233223, "developer" : "ssss", "main_scenes" : "园区", "device_types" : [ ], "status" : 1}

请求示例 删除某个密钥 DELETE https://{endpoint}/v3/{project_id}/ai-mgr/secrets/{secret_id}Request Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 sub_scenes String 技能应用场景 app_template_id String 应用模板ID icon String 技能图标 version_num Integer 技能版本数量 description String 技能描述 product_info Array of strings 计费编码信息 type String 技能类别，分为standard和lite platform String 技能操作系统平台，其值为：Linux，Android， iOS， LiteOS，Windows self_dev_flag Integer 自研标识，1表示是HiLens自研算法。 measure_type String 计费类型，physical_src表示 src approval_result String 技能审核结果 update_time String 更新时间，形如2022-06-30 17:22:48 GMT+08:00 channel_limit Integer 通道数 publish_time String 发布时间 resource_step_size Integer 步长 approval_time String 审批时间 cloud_service_type String 云服务编码 summary String 摘要 test_status Integer 测试状态 chip String 芯片 is_verify_model Boolean 是否校验模型 format String 技能类型，文件类型file，镜像类型iamge resource_type String 资源类别 version String 技能版本 measure_unit String 计费单位 qps 表示按qps收费，road表示技能路数instance 表示按实例收费 tags Array of strings 标签 size Integer 技能大小 test_result String 测试结果 install_times Integer 安装次数 privacy_policy Array of strings 隐私条款 name String 技能名字 scenes Array of strings 技能场景 charge_model Integer 计费模式 resource_spec_code String 云服务资源编码 skill_id String 技能Id developer String 开发者名字 main_scenes String 主场景 device_types Array of strings 所支持的设备类别 status Integer 技能状态 versions Array of strings 技能版本号列表 状态码： 401 表5 响应Header参数 参数 参数类型 描述 X-request-id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

请求示例 发送往部署添加节点请求，把已有的部署下发到指定的节点。 PUT https://{endpoint}/v3/{project_id}/ai-mgr/deployments/{deployment_id}/nodes{ "node_num" : 2, "node_ids" : [ "hilens-d087f32be2c641278bfc4c4d071b86ef", "hilens-d087f32be2c641278bfc4c4d071b86eg" ], "deployment_id" : "hilens-d087f32be2c641278bfc4c4d071b86ef"} 往指定部署添加含有指定标签的设备 PUT https://{endpoint}/v3/{project_id}/ai-mgr/deployments/{deployment_id}/nodesRequest Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...Request Body:{ "node_num": 1, "node_tags": [ { "key": "tag1", "value": "val1" } ], "deployment_id": "hilens-d087f32be2c641278bfc4c4d071b86ef"}

响应示例 状态码： 200 请求成功 { "template" : { "configs" : { "migration" : false, "host_network" : false, "host_pid" : false, "restart_policy" : "Always", "toleration_seconds" : 0 }, "apps" : [ { "name" : "example1-skill-name", "args" : [ ], "command" : [ "--log_dir=/train --learning_rate=0.01 --batch_size=150" ], "resources" : { "limits" : { "cpu" : "0.25", "memory" : "128" }, "requests" : { } }, "envs" : [ { "name" : "IVA_SVC_CONFIG", "value" : "{\"algorithm\":{\"multiTask\":\"no\",\"algType\":\"hilens\"},\"cloud\":{\"disEndpoint\":\"https://dis.cn-north-7.myhuaweicloud.com\",\"region\":\"cn-north-7\"},\"svcInstanceId\":\"modelbox-instance-xxxx\"}" } ], "msgs" : [ ], "ports" : [ { "container_port" : 10, "host_port" : 23, "host_ip" : "10.10.10.10" } ], "privileged" : false, "volumes" : [ { "name" : "tmp", "type" : "emptyDir", "source" : "memory", "destination" : "/tmp", "read_only" : false }, { "name" : "run", "type" : "emptyDir", "source" : "memory", "destination" : "/run", "read_only" : false }, { "name" : "cgroup", "type" : "hostPath", "source" : "/sys/fs/cgroup", "destination" : "/sys/fs/cgroup", "read_only" : true } ], "app_url" : "xxx", "is_modelbox" : true } ] }, "reason" : null, "ready_replicas" : 0, "replicas" : 1, "description" : "", "created_at" : "2022-01-25 15:57:07 GMT+08:00", "source" : "userdefined", "api_version" : null, "node_ids" : [ "hilens-e17b497c3a00406f89f605e5c16b40d7" ], "result" : [ { "node_id" : "hilens-e17b497c3a00406f89f605e5c16b40d7" } ], "cluster_id" : "", "updated_at" : "2022-01-25 15:57:07 GMT+08:00", "project_id" : "fff47e1722f94c4e98531bae56821372", "name" : "example1", "id" : "hilens-9eebd2c03a2e48a6a47949fcb4f3f66f", "state" : "CREATING"}

URI PUT /v3/{project_id}/ai-mgr/deployments/{deployment_id}/nodes 表1 路径参数 参数 是否必选 参数类型 描述 deployment_id 是 String 部署ID project_id 是 String 项目ID，获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 provider 否 String 平台提供者，分别为hilens及ief。当为hilens时，请求部署在hilens平台的相关数据。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。获取方法请参见 获取Token 表4 请求Body参数 参数 是否必选 参数类型 描述 node_ids 否 Array of strings 应用部署到指定节点 deployment_id 是 String 应用部署ID node_tags 否 Array of DeploymentTag objects 添加节点的标签 node_num 是 Integer 添加的节点数量 表5 DeploymentTag 参数 是否必选 参数类型 描述 key 是 String 部署标签的key值，长度取值范围为1~36，由英文字母，数字，中划线和下划线组成，长度1到36个字符 value 是 String 部署标签的value值，长度取值范围为1~43，由英文字母，数字，下划线，点号和中划线组成，长度0到43个字符

错误码 当您调用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. 服务内部错误 提工单或者联系客服人员解决 父主题： 附录

请求示例 启停某个设备 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平台

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

响应参数 状态码： 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 POST /v3/{project_id}/{resource_type}/{resource_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID resource_id 是 String 资源ID，不同资源（节点，部署，配置项，密钥）有不同的资源ID resource_type 是 String 资源类型（节点，部署，配置项，密钥）

响应示例 状态码： 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}

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

请求参数 表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 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

请求示例 启动/停止部署下的指定实例 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 表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 表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启动

请求参数 表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" } ]}

请求示例 创建部署，来源于自定义技能 https://{endpoint}/v3/{project_id}/ai-mgr/deployments{ "name" : "create-deployment-from-market", "description" : "", "tags" : [ { "key" : "key", "value" : "value" } ], "source" : "userdefined", "deployment" : { "replicas" : "1", "template" : { "configs" : { "restart_policy" : "Always", "host_network" : false }, "apps" : [ { "skill_project_id" : "0c0e1e0f42e54119bf50d8b98aa3d71c", "app_url" : "https://test-sdk.obs.cn-north-x.myhuaweicloud.com/xxxx", "version" : "0.0.2", "name" : "skill-test-reject", "envs" : [ { "name" : "xxx", "value" : "xxx" } ], "privileged" : "false", "volumes" : [ { "type" : "configMap", "source" : "config001", "read_only" : true, "name" : "vol001", "key" : "key", "destination" : "xxx/xxxx" } ], "msgs" : [ { "name" : "xxx", "value" : "xxx" } ], "resources" : { "limits" : { "cpu" : "0.25", "memory" : "128" }, "requests" : { } } } ] } }, "node_ids" : [ "hilens-8c79e1e7ff39437680a67783feb0e815" ], "license_quota" : 1}

URI POST /v3/{project_id}/ai-mgr/deployments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 provider 否 String 平台提供者，分别为hilens及ief。当为hilens时，请求部署在hilens平台的相关数据

响应示例 状态码： 200 请求成功，当批量部署节点个数小于20个的时候，返回结果result字段非空，当大于20个的时候，result字段为空，此时可通过回调机制获取部署结果。 { "template" : { "configs" : { "migration" : false, "host_network" : false, "host_pid" : false, "restart_policy" : "Always", "toleration_seconds" : 0 }, "apps" : [ { "name" : "example1-skill-name", "args" : [ ], "command" : [ "--log_dir=/train --learning_rate=0.01 --batch_size=150" ], "resources" : { "limits" : { "cpu" : "0.25", "memory" : "128" }, "requests" : { } }, "envs" : [ { "name" : "IVA_SVC_CONFIG", "value" : "{\"algorithm\":{\"multiTask\":\"no\",\"algType\":\"hilens\"},\"cloud\":{\"disEndpoint\":\"https://dis.cn-north-7.myhuaweicloud.com\",\"region\":\"cn-north-7\"},\"svcInstanceId\":\"modelbox-instance-xxxx\"}" } ], "msgs" : [ ], "ports" : [ { "container_port" : 10, "host_port" : 23, "host_ip" : "10.10.10.10" } ], "privileged" : false, "volumes" : [ { "name" : "tmp", "type" : "emptyDir", "source" : "memory", "destination" : "/tmp", "read_only" : false }, { "name" : "run", "type" : "emptyDir", "source" : "memory", "destination" : "/run", "read_only" : false }, { "name" : "cgroup", "type" : "hostPath", "source" : "/sys/fs/cgroup", "destination" : "/sys/fs/cgroup", "read_only" : true } ], "app_url" : "xxx", "is_modelbox" : true } ] }, "reason" : null, "ready_replicas" : 0, "replicas" : 1, "description" : "", "created_at" : "2022-01-25 15:57:07 GMT+08:00", "source" : "userdefined", "api_version" : null, "node_ids" : [ "hilens-e17b497c3a00406f89f605e5c16b40d7" ], "result" : [ { "node_id" : "hilens-e17b497c3a00406f89f605e5c16b40d7" } ], "cluster_id" : "", "updated_at" : "2022-01-25 15:57:07 GMT+08:00", "project_id" : "fff47e1722f94c4e98531bae56821372", "name" : "example1", "id" : "hilens-9eebd2c03a2e48a6a47949fcb4f3f66f", "state" : "CREATING"}

响应示例 状态码： 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"}