华为云用户手册

终端节点 终端节点即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。 目前华为HiLens服务支持以下地区和终端节点，请您根据业务需要选择对应区域的终端节点。 表1 华为HiLens的终端节点 区 域名 称 区域 终端节点（Endpoint） 协议类型 华北-北京四 cn-north-4 hilens.cn-north-4.myhuaweicloud.com HTTPS 父主题： 使用前必读

URI PUT /v3/{project_id}/node-manager/node/{node_id}/firmware/{firmware_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID node_id 是 String 设备ID，从专业版HiLens控制台设备管理查询设备列表获取 firmware_id 是 String 固件ID,，从专业版HiLens控制台固件管理查询固件列表获取

URI DELETE /v3/{project_id}/ai-mgr/deployments/{deployment_id}/tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 deployment_id 是 String 部署ID，从专业版HiLens控制台部署管理获取部署列表获取 project_id 是 String 项目ID。获取方法请参见获取项目ID task_id 是 String 作业ID，从专业版HiLens控制台作业管理获取作业列表获取

URI DELETE /v3/{project_id}/ai-mgr/nodes/{node_id} 表1 路径参数 参数 是否必选 参数类型 描述 node_id 是 String 设备ID，从专业版HiLens控制台设备管理查询设备列表获取 project_id 是 String 项目ID。获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 force_delete 否 Boolean 是否强制删除，true代表是，false代表否

请求示例 删除专业版HiLens控制台上的设备 DELETE https://{endpoint}/v3/{project_id}/ai-mgr/nodes/{node_id}Request Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

请求示例 删除某个作业 DELETE https://{endpoint}/v3/{project_id}/ai-mgr/deployments/{deployment_id}/tasks/{task_id}Request Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应参数 状态码： 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

URI DELETE /v3/{project_id}/{resource_type}/{resource_id}/tags/{key} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID resource_id 是 String 资源ID，不同资源（节点，部署，配置项，密钥）有不同的资源ID resource_type 是 String 资源类型（节点，部署，配置项，密钥） key 是 String 标签键，最大长度36个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”

请求示例 删除对应资源的标签 DELETE https://{endpoint}/v3/{project_id}/{resource_type}/{resource_id}/tags/{key}Request Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-4", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

请求示例 更新自定义技能 https://{endpoint}/v3/8c79e1e7ff39437680a67783feb0e815/ai-mgr/deployments/8c79e1e7ff39437680a67783feb0e811{ "deployment" : { "replicas" : 1, "template" : { "configs" : { "restart_policy" : "Always", "host_network" : false }, "apps" : [ { "privileged" : false, "resources" : { "limits" : { "cpu" : "0.25", "memory" : "128" }, "requests" : { } }, "name" : "iamge", "app_url" : "xxx" } ] } }}

URI PUT /v3/{project_id}/ai-mgr/deployments/{deployment_id} 表1 路径参数 参数 是否必选 参数类型 描述 deployment_id 是 String 部署ID 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"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。获取方法请参见 获取Token 表3 请求Body参数 参数 是否必选 参数类型 描述 version 否 String 技能版本，可选，当下发的技能版本和当前部署的版本不一致的时候，根据技能模板参数更新部署 patch 否 Patch object 增量更新的部署参数 表4 Patch 参数 是否必选 参数类型 描述 envs 否 Array of Env objects 环境变量更新 表5 Env 参数 是否必选 参数类型 描述 name 是 String 环境变量的key，由大小写字母或下划线开头，由数字、大小写字母、下划线组成，最大长度2048个字符，不允许重复 value 否 String 环境变量的value，最大长度20480个字符。value、value_from和field_path必须三选一使用 value_from 否 ValueFrom object 环境变量可使用配置项和密钥导入。value、value_from和field_path必须三选一使用 field_path 否 String 该参数目前只支持赋值"status.hostIP"，即引用边缘节点的IP地址作为环境变量。value、value_from和field_path必须三选一使用 表6 ValueFrom 参数 是否必选 参数类型 描述 configmap 否 ConfigsMap object 环境变量引用配置项时使用。使用ValueFrom时，secret与configmap必须二选一 secret 否 DeploymentSecrets object 环境变量引用密钥时使用。使用ValueFrom时，secret与configmap必须二选一 表7 ConfigsMap 参数 是否必选 参数类型 描述 key 是 String 配置项的名称，以英文字母或中划线开头，由英文字母、数字、点号、中划线和下划线组成，长度1到63个字符。 name 是 String 配置项的属性名，以英文小写字母开头，由中文字符，英文字母，数字，下划线和中划线组成，不能以中划线结尾，长度4-64位。 表8 DeploymentSecrets 参数 是否必选 参数类型 描述 name 否 String 密钥的名称，以英文小写字母开头，由中文字符，英文字母，数字，下划线和中划线组成，不能以中划线结尾，长度4-64位 key 否 String 密钥的属性名，以英文字母和中划线开头，由英文字母、数字、点号、中划线和下划线组成，长度1-63位

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

请求示例 基于技能版本参数更新部署信息 PATCH https://{endpoint}/v3/{project_id}/ai-mgr/deployments/{deployment_id}{ "version" : "0.0.2"} 增量更新部署中的环境变量 PATCH https://{endpoint}/v3/{project_id}/ai-mgr/deployments/{deployment_id}Request Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...Request Body:{ "patch": { "envs": [ { "name": "aaaaaaaaaaaaaaaaa1", "value": "1" }, { "name": "aaaaaaaaaaaaaaaa2", "value": "2" }, { "name": "yyyyyyyyyyyyyyyy1", "field_path": "status.hostIP" } ] }}

请求示例 更新某个作业 POST https://{endpoint}/v3/{project_id}/ai-mgr/deployments/{deployment_id}/task/{task_id}{ "business" : "string", "data" : { "streams" : [ { "common" : { }, "input" : { "data" : { }, "type" : "string" }, "outputs" : [ { "data" : { }, "type" : "string" } ] } ], "task_id" : "string", "start_time_info" : { "start_time" : "string", "frequency" : "string", "mode" : "string", "day_time_frame" : [ { "start" : "string", "stop" : "string" } ], "single_time_frame" : [ { "start" : "string", "stop" : "string" } ] } }, "description" : "string", "instance_id" : "string", "name" : "string", "timestamp" : "string"}

URI POST /v3/{project_id}/ai-mgr/deployments/{deployment_id}/task/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 deployment_id 是 String 部署ID，从专业版HiLens控制台部署管理获取部署列表获取 project_id 是 String 项目ID。获取方法请参见获取项目ID task_id 是 String 作业ID，从专业版HiLens控制台作业管理获取作业列表获取

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户Token。获取方法请参见获取Token 表3 请求Body参数 参数 是否必选 参数类型 描述 business 否 String 作业动作，创建作业或者是删除作业又或是更新作业等 data 是 TaskData object 作业详情 description 否 String 作业描述 instance_id 否 String 实例ID，非必选 name 是 String 作业名称 timestamp 否 String 时间戳，非必选 表4 TaskData 参数 是否必选 参数类型 描述 streams 是 Array of TaskStream objects 作业流详情 task_id 否 String 作业id start_time_info 否 StartTimeInfo object 任务启动信息 source_usage_estimate 否 TaskSourceUsageEstimate object 资源消耗 表5 TaskStream 参数 是否必选 参数类型 描述 common 否 Object 作业参数配置 input 是 TaskInput object 输入详情 outputs 是 Array of TaskOutputs objects 输出详情 表6 TaskInput 参数 是否必选 参数类型 描述 data 是 Object 输入数据 type 是 String 输入类型 表7 TaskOutputs 参数 是否必选 参数类型 描述 data 是 Object 输出数据 type 是 String 输出类型 表8 StartTimeInfo 参数 是否必选 参数类型 描述 start_time 是 String 任务启动时间 frequency 否 String 任务运行频率（定时任务频率，每天运行还是单次运行） mode 否 String 任务运行模式（按时间段运行还是按频率运行） day_time_frame 否 Array of TimeFrame objects 每天运行时间段 single_time_frame 否 Array of TimeFrame objects 每次运行时间段 表9 TimeFrame 参数 是否必选 参数类型 描述 start 是 String 任务开始时间 stop 是 String 任务结束时间 表10 TaskSourceUsageEstimate 参数 是否必选 参数类型 描述 cpu 是 Float cpu消耗 memory 是 Integer 内存消耗

请求示例 更新某个配置项 PUT https://{endpoint}/v3/{project_id}/ai-mgr/configmaps/{config_map_id}{ "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 表7 响应Body参数 参数 参数类型 描述 configmap ConfigMap object 配置项详情 workspace_id String 工作空间ID，默认为注册账号/子账号的default工作空间，可通过专业版HiLens控制台展开工作空间列表获取到工作空间ID 表8 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 表9 Config 参数 参数类型 描述 key String 配置项key，最大长度63个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” value String 配置项value，每个值最大长度10000个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” 表10 Tag 参数 参数类型 描述 key String 标签键，最大长度36个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” value String 标签值，每个值最大长度43个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”

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

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

请求示例 更新设备的描述和标签 POST https://{endpoint}/v3/{project_id}/ai-mgr/nodes/{node_id}{ "node" : { "enable_gpu" : false, "enable_npu" : false, "npu_type" : "null", "description" : "HiLens节点", "tags" : [ { "key" : "lI", "value" : "ss" } ] }}

调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为 IAM 的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，例如，华为HiLens服务部署的区域为“cn-north-4”，响应消息体中查找“name”为“cn-north-4”，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

从控制台获取项目ID 登录管理控制台。 在页面右上角单击用户名，在下拉列表中单击“我的凭证”，进入“我的凭证”页面。 在项目列表中查看“项目ID”和“项目”（“项目”即项目名称）。 图1 查看项目ID 多项目时，展开“所属区域”，从“项目ID”列获取子项目ID。项目编码需与华为HiLens服务终端节点保持一致，当访问华北-北京四的终端节点（即hilens.cn-north-4.myhuaweicloud.com时），项目对应需为cn-north-4。

URI GET /v3/{project_id}/ai-mgr/configmaps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 provider 否 String 服务提供者：ief或hilens，默认为hilens。 name 否 String 配置项名称，模糊匹配。 workspace_id 否 String 工作空间ID，默认为注册账号/子账号的default工作空间，可通过专业版HiLens控制台展开工作空间列表获取到工作空间ID limit 否 Integer 每页显示的条目数量，取值范围1~1000，默认值为1000。 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0。 sort 否 String 排序方式，可根据名称、创建时间、更新时间排序枚举值：name，created_at，updated_at。sort默认升序，如sort=name，降序：sort=name%3Adesc。不填默认为sort=created_at%3Adesc。 tag_key 否 String 格式为{tag_key}={tag_value}，支持多对tag或查询。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 配置项数量 configmaps Array of ConfigMap objects 配置项详情 表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删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”

请求示例 获取配置项详情列表 GET https://{endpoint}/v3/{project_id}/ai-mgr/configmapsRequest Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应示例 状态码： 200 请求成功 { "count" : "integer", "configmaps" : [ { "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" } ]}