华为云用户手册

响应示例 状态码： 200 请求成功 { "count" : 5, "workspaces" : [ { "workspace_id" : "0", "ma_workspace_id" : null, "project_id" : "123", "name" : "default", "description" : null, "enterprise_project_id" : "0", "enterprise_project_name" : "default", "create_time" : 1598094655508, "update_time" : 1598094655508, "owner" : "sss", "user_id" : "123", "used_flag" : null } ]}

URI GET /v3/{project_id}/ai-mgr/workspaces 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 iam_user_id 否 String 用户的userId，用于查询指定的的子工作空间 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 limit 否 Integer 每页显示的条目数量，取值范围1~100，默认为100

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 返回总条目数 workspaces Array of WorkspaceListElem objects 工作空间列表 表5 WorkspaceListElem 参数 参数类型 描述 workspace_id String 工作空间id ma_workspace_id String 对应的Modelarts工作空间的id project_id String 项目ID name String 工作空间名称 description String 工作空间描述 enterprise_project_id String 企业项目ID enterprise_project_name String 企业项目名称 create_time Long 创建时间 update_time Long 更新时间 owner String 创建者 user_id String 创建者的USER_ID used_flag String 正在被使用

基本概念 帐号 用户注册华为云时的帐号，帐号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于帐号是付费主体，为了确保帐号安全，建议您不要直接使用帐号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由帐号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看帐号ID和用户ID。通常在调用API的鉴权过程中，您需要用到帐号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 云服务的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 父主题： 使用前必读

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 获取用户Token接口请求构造如下，您可以从接口的请求部分看到所需的请求参数及参数说明。 获取Token 消息头只需填写“Content-Type”。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中usernam用户名，domainname为用户所属的帐号名称，********为用户登录密码。 获取Token的终端节点和projectname需与KG服务终端节点保持一致。当访问华北-北京四的终端节点（即nlp-ext.cn-north-4.myhuaweicloud.com时），获取Token请使用终端节点https://iam.cn-north-4.myhuaweicloud.com，projectname对应使用cn-north-4。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过视频教程了解如何使用Token认证。

URI GET /v1/{project_id}/skill-market/skill-order 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每页显示的条目数量, 最大 100，默认值 10 offset 否 Integer 查询的起始位置, 默认值 0 skill_name 否 String 技能名称，支持模糊匹配。中英文、数字、下划线、中划线 长度[1-60] skill_form 否 String 技能形式，no_termplate不支持Modelbox部署模板，support_template支持Modelbox模板。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 订单总数 data Array of SkillOrderInfo objects 技能数据 表5 SkillOrderInfo 参数 参数类型 描述 expiration_stop_flag Integer 技能是否支持永久使用标识。1标识支持，0为不支持 package_order_id String 技能套餐包订单ID icon String 技能图标 commission_flag Integer 定制技能标识 product_info Array of strings 产品收费编码信息 package_id String 套餐包ID measure_type String 计费类型，physical_src表示按物理量纲收费，比如包周期 ，src表示一次性收费 update_time Integer 更新时间 channel_limit Integer 通道数限制 resource_step_size Integer 步长 cloud_service_type String 云服务编码 developer_id String 开发者ID amount Integer 订单数量 format String 技能类型，文件类型file，镜像类型iamge resource_type String 资源类别 expire_time Long 到期时间 measure_unit String 计费单位 qps 表示按qps收费，road表示技能路数instance 表示按实例收费 skill_chip String 芯片类别 versions Array of strings 技能版本列表 skill_name String 技能名字 skill_type String 技能类别 used_amount Integer 订单使用份数 charge_model Integer 计费模式 resource_spec_code String 资源编码 skill_id String 技能ID skill_platform String 技能支持的平台 order_limit Integer 订单购买限制 order_id String 订单ID status Integer 订单状态，0表示正常状态，1表示冻结状态，2表示受限状态

响应示例 状态码： 200 技能订单列表 { "total" : 3, "data" : [ { "expiration_stop_flag" : null, "package_order_id" : null, "icon" : null, "commission_flag" : 0, "product_info" : [ ], "package_id" : null, "measure_type" : "physical_src", "update_time" : 1654569785847, "channel_limit" : 0, "resource_step_size" : 1, "cloud_service_type" : null, "developer_id" : "07e463f65280d2d62f2ec010fcd10f1c", "amount" : 10, "format" : "image", "resource_type" : null, "measure_unit" : "road", "skill_chip" : null, "versions" : [ "0.0.1" ], "skill_name" : "skill-free", "skill_type" : null, "used_amount" : 0, "charge_model" : 0, "resource_spec_code" : null, "skill_id" : "26d00abae3a44c24a820ae9e92fe53c4", "skill_platform" : null, "order_limit" : null, "order_id" : "149d60137d634a81b5a4c7033e38e04d", "status" : 0 } ]}

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 workspace_id String 工作空间ID secret secret object 密钥 表8 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 标签列表 表9 Secret 参数 参数类型 描述 key String 密钥key，最大长度63个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” value String 密钥value，每个值最大长度10000个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” 表10 Tag 参数 参数类型 描述 key String 标签key，最大长度36个字符。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_” value String 标签value，每个值最大长度43个字符，删除时如果value有值按照key/value删除，如果value没值，则按照key删除。不能为空，只能包含大小写字母，数字，中划线“-”，下划线“_”

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

请求示例 更新某个密钥 PUT https://{endpoint}/v3/{project_id}/ai-mgr/secrets/{secret_id}{ "workspace_id" : "string", "secret" : { "name" : "string", "description" : "string", "secrets" : [ { "key" : "string", "value" : "string" } ], "tags" : [ { "key" : "string", "value" : "string" } ] }}

URI GET /v3/{project_id}/node-manager/node/{node_id}/firmware/upgrade-progress 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID node_id 是 String 设备ID，从专业版HiLens控制台设备管理查询设备列表获取 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 limit 否 Integer 每页显示的条目数量，取值范围1~100，默认为100

请求示例 获取固件升级进度 GET https://{endpoint}/v3/{project_id}/node-manager/node/{node_id}/firmware/upgrade-progressRequest Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

请求示例 注册设备到HiLens专业版控制台 POST https://{endpoint}/v3/{project_id}/ai-mgr/nodes?provider=hilens{ "node" : { "name" : "gg11112344", "description" : "", "tags" : [ ], "iam_user_id" : "19a1ef99f8ed4d4ab38be5085adaf84a", "batch" : 1, "enable_npu" : false, "enable_gpu" : false, "log_configs" : [ { "size" : "50", "rotate_num" : 10, "type" : "LTS", "component" : "app" } ] }}

响应参数 状态码： 200 表8 响应Body参数 参数 参数类型 描述 id String 设备ID name String 设备名称，只允许中文字符、英文字母、数字、下划线、中划线，最大长度64 package String 将设备配置和证书文件node.conf/certificate/private_key打成.tar.gz包后用base64编码的字符串。node.conf包含节点信息配置

URI GET /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控制台作业管理获取作业列表获取

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 name String 作业名称 timestamp String 作业创建时间 description String 作业描述 streams Array of TaskStream objects 作业流详情 ok_pod_number Integer 在实例上运行成功的作业数 cur_pod_number Integer 在实例上正在运行的作业数 sum_pod_number Integer 在实例上运行过的作业总数 fail_pod_number Integer 在实例上运行失败的作业数 pending_pod_number Integer 在实例上等待运行的作业数 task_status Array of TaskStatus objects 作业状态信息 task_id String 作业id user_task_id String 用户作业id start_time_info StartTimeInfo object 任务启动时间信息 source_usage_estimate TaskSourceUsageEstimate object 资源消耗预估 表3 TaskStream 参数 参数类型 描述 common Object 作业参数配置 input TaskInput object 输入详情 outputs Array of TaskOutputs objects 输出详情 表4 TaskInput 参数 参数类型 描述 data Object 输入数据 type String 输入类型 表5 TaskOutputs 参数 参数类型 描述 data Object 输出数据 type String 输出类型 表6 TaskStatus 参数 参数类型 描述 cause String 作业运行失败原因 pod_id String 实例id pod_name String 实例名称 task_status String 作业在实例上的状态 表7 StartTimeInfo 参数 参数类型 描述 start_time String 任务启动时间 frequency String 任务运行频率（定时任务频率，每天运行还是单次运行） mode String 任务运行模式（按时间段运行还是按频率运行） day_time_frame Array of TimeFrame objects 每天运行时间段 single_time_frame Array of TimeFrame objects 每次运行时间段 表8 TimeFrame 参数 参数类型 描述 start String 任务开始时间 stop String 任务结束时间 表9 TaskSourceUsageEstimate 参数 参数类型 描述 cpu Float cpu消耗 memory Integer 内存消耗

响应示例 状态码： 200 请求成功 { "name" : "string", "timestamp" : "string", "description" : null, "streams" : [ { "common" : null, "input" : { "type" : "camera", "data" : { "name" : "string", "create_time" : "string", "tag" : [ { "config_type" : "string" } ], "id" : "string", "rtsp" : "string" } }, "outputs" : [ { "type" : "dis", "data" : { "projectId" : "string", "streamId" : "string", "streamName" : "string" } } ] } ], "ok_pod_number" : 0, "cur_pod_number" : 0, "sum_pod_number" : 1, "fail_pod_number" : 1, "pending_pod_number" : 0, "task_status" : [ { "pod_id" : "string", "pod_name" : "string", "task_status" : "string" } ], "task_id" : "string", "user_task_id" : null}

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

概述 欢迎使用华为HiLens ，华为HiLens为端云协同多模态AI开发应用平台，提供简单易用的开发框架、开箱即用的开发环境、丰富的AI技能市场和云上管理平台，对接多种端侧计算设备，支持视觉及听觉AI应用开发、AI应用在线部署、海量设备管理等。 在调用华为HiLens服务的API之前，请确保已经充分了解华为HiLens服务相关概念，详细信息请参见产品介绍。 华为HiLens服务以开放API的方式提供给用户，您可以根据本文档提供的API使用服务，支持的全部API请参见API概览。 父主题： 使用前必读

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 作业数量 tasks Array of TaskInfo objects 作业详情 表5 TaskInfo 参数 参数类型 描述 name String 作业名称 timestamp String 作业创建时间 description String 作业描述 streams Array of TaskStream objects 作业流详情 ok_pod_number Integer 在实例上运行成功的作业数 cur_pod_number Integer 在实例上正在运行的作业数 sum_pod_number Integer 在实例上运行过的作业总数 fail_pod_number Integer 在实例上运行失败的作业数 pending_pod_number Integer 在实例上等待运行的作业数 task_status Array of TaskStatus objects 作业状态信息 task_id String 作业id user_task_id String 用户作业id start_time_info StartTimeInfo object 任务启动时间信息 source_usage_estimate TaskSourceUsageEstimate object 资源消耗预估 表6 TaskStream 参数 参数类型 描述 common Object 作业参数配置 input TaskInput object 输入详情 outputs Array of TaskOutputs objects 输出详情 表7 TaskInput 参数 参数类型 描述 data Object 输入数据 type String 输入类型 表8 TaskOutputs 参数 参数类型 描述 data Object 输出数据 type String 输出类型 表9 TaskStatus 参数 参数类型 描述 cause String 作业运行失败原因 pod_id String 实例id pod_name String 实例名称 task_status String 作业在实例上的状态 表10 StartTimeInfo 参数 参数类型 描述 start_time String 任务启动时间 frequency String 任务运行频率（定时任务频率，每天运行还是单次运行） mode String 任务运行模式（按时间段运行还是按频率运行） day_time_frame Array of TimeFrame objects 每天运行时间段 single_time_frame Array of TimeFrame objects 每次运行时间段 表11 TimeFrame 参数 参数类型 描述 start String 任务开始时间 stop String 任务结束时间 表12 TaskSourceUsageEstimate 参数 参数类型 描述 cpu Float cpu消耗 memory Integer 内存消耗

请求示例 获取某个部署下所有作业详情列表 GET https://{endpoint}/v3/{project_id}/ai-mgr/deployments/{deployment_id}/tasksRequest Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应示例 状态码： 200 请求成功 { "count": 1, "tasks": [ { "name": "string", "timestamp": "string", "description": null, "streams": [ { "common": null, "input": { "type": "camera", "data": { "name": "string", "create_time": "string", "tag": [ { "config_type": "string" } ], "id": "string", "rtsp": "string" }, "template": false }, "outputs": [ { "type": "dis", "data": { "projectId": "string", "streamId": "string", "streamName": "string" }, "template": false } ] } ], "ok_pod_number": 0, "cur_pod_number": 0, "sum_pod_number": 1, "fail_pod_number": 1, "pending_pod_number": 0, "task_status": [ { "pod_id": "string", "pod_name": "string", "task_status": "string" } ], "task_id": "string", "user_task_id": null, } ]}

URI GET /v3/{project_id}/ai-mgr/deployments/{deployment_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 deployment_id 是 String 部署ID，从专业版HiLens控制台部署管理获取部署列表获取 project_id 是 String 项目ID。获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 limit 否 Integer 每页显示的条目数量，取值范围1~100，默认为100

公共请求参数 表1 公共请求消息头 参数名 说明 必选 示例 Content-type 发送的实体的MIME类型。 是 application/json Content-Length 请求body长度，单位为Byte。 POST/PUT请求为可选， GET不包含。 3495 X-Auth-Token 用户Token。 是 MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... X-Language 请求语言类型。 否，默认为zh-cn。 en-us 其它header属性，请遵照https协议。 父主题： 数据结构

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 满足条件的设备总数 data Array of GetDevicesListArrayObject objects 设备实体列表 表5 GetDevicesListArrayObject 参数 参数类型 描述 id String 设备ID name String 设备名称 type String 设备类型 status Integer 设备状态(0:离线;1:在线) cpu Integer cpu核数 memory Integer 内存大小 os String 操作系统 firmware_name String 固件名称 firmware_version String 固件版本 firmware_status Integer 固件状态(1:更新中，2：更新失败，3：更新成功) firmware_cause String 固件更新失败原因 path String 设备数据存储路径，该桶需要和当前region匹配 path_update_status Integer 设备数据存储路径更新状态(0:更新成功，1：更新中) path_update_cause String 设备数据存储路径更新失败原因 create_time Long 创建时间（时间戳） update_time Long 更新时间（时间戳） user_time String IAM用户名 resource_spec_code String 计费资源码 cloud_service_type String 云服务计费类型 active_content String 激活内容 active_flag Integer 激活状态(0:未激活，1：已激活且付费，2：已激活且免费，3：付费到期，4：已激活使用SN码，5：已激活30天免费，6：免费到期) topic_urn String 关联设备的主题消息推送的URN地址

响应示例 状态码： 200 获取设备列表成功 { "total" : 0, "data" : [ { "id" : "6b0e806f35c2470a825da1f1ab05caf5", "name" : "Hello_nihao", "type" : "HiLens Kit", "status" : 1, "cpu" : 2, "memory" : 3.5, "os" : "GNU/Linux", "firmware_name" : "HiLens_Device_Agent", "firmware_version" : "1.0.2", "firmware_status" : 1, "firmware_cause" : null, "path" : "https://datafortesting.obs.xxx.com/qwweere/", "path_update_status" : 1, "path_update_cause" : null, "create_time" : 1234563, "update_time" : 1234563, "user_time" : "Chace", "resource_spec_code" : "platform.management", "cloud_service_type" : "xxx.service.type.hilens", "active_content" : null, "active_flag" : 2, "topic_urn" : "urn:smn:xxx:xx:xxx" } ]}

URI GET /v2/{project_id}/device-manager/devices 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置，取值范围为非负整数，默认为0 limit 否 Integer 每页显示的条目数量，取值范围1~100，默认为100 name 否 String 设备名称，模糊匹配，只允许中英文、数字、下划线、中划线，长度1-60

API概览 华为HiLens提供了如下接口，基础版控制台接口的说明如表1所示，专业版控制台接口的说明如所示。 表1 基础版控制台接口说明 接口类型 说明 获取设备列表 获取设备列表 获取设备告警列表 获取设备告警列表 表2 专业版控制台接口说明 接口类型 说明 设备管理 管理设备相关操作，包括查询设备列表、注册设备、查询设备详情等操作。 固件管理 管理固件相关操作，包括查询固件列表。 应用部署管理 管理应用部署相关操作，包括查询应用部署列表、创建应用部署、查询应用部署详情等操作。 配置项管理 管理配置项相关操作，包括查询配置项列表、创建配置项、更新配置项等操作。 作业管理 管理作业相关操作，包括查询作业列表、创建作业、编辑作业、删除作业等操作。 密钥管理 管理密钥相关操作，包括查询密钥列表、创建密钥、更新密钥等操作。 标签管理 管理标签相关操作，包括批量添加标签、查询标签、添加标签等操作。 工作空间管理 管理工作空间相关操作，包括获取工作空间列表、创建工作空间、删除工作空间等操作。 技能市场 管理技能市场相关操作，包括查询技能列表、获取技能详情、创建免费技能订单等操作。

请求示例 查询某种资源类型的所有标签 GET https://{endpoint}/v3/{project_id}/tag-mgr/{resource_type}/tagsRequest Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...