华为云用户手册

响应示例 状态码： 201 Created { "rsu_id" : "b58efc27-a6e5-4bca-9d12-c76ecfe3f102", "name" : "RSU001", "description" : "TEST", "esn" : "13518098671442480164720973683901", "last_modified_time" : "2020-09-01T01:37:01Z", "created_time" : "2020-09-01T01:37:01Z", "last_online_time" : "2020-09-01T01:37:01Z", "ip" : "127.0.0.1", "position_description" : "K08", "location" : { "lat" : 40.1234567, "lon" : 116.1234567 }, "status" : "ONLINE", "intersection_id" : "1-301", "rsu_model_id" : "27652459499824704332521974743806", "related_edge_num" : 0, "software_version" : "V100X00XX00X325"}

状态码 状态码 英文描述 中文描述 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

响应示例 状态码： 201 Created { "count" : 1, "edge_apps" : [ { "edge_app_id" : "14729446815072419760762234026232", "description" : "this is a test", "created_time" : "2021-12-23T12:29:08Z", "last_modified_time" : "2021-12-23T12:29:08Z", "last_published_version" : null } ]}

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 edge_app_id String 参数说明：用户自定义应用唯一ID。 取值范围：只允许字母、数字、下划线（_）、连接符（-）、美元符号（$）的组合。 description String 参数说明：应用描述。 取值范围：只允许中文、字母、数字、下划线（_）、中文分号（；）、中文冒号（：）、中文问号（？）、中文感叹号（！）中文逗号（，）、中文句号（。）、英文引号（;）、英文冒号（:）、英文逗号（,）、英文句号（.）、英文问号（?）、英文感叹号（!）、顿号（、）、连接符（-）的组合。 created_time String 参数说明：创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z。 last_modified_time String 参数说明：更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z。 last_published_version String 参数说明：最新发布版本。

请求示例 POST https://{endpoint}/v1/{project_id}/v2x-edge-appsContent-Type:application/jsonX-Auth-Token:********Instance-Id:********{ "edge_app_id" : "14729446815072419760762234026232", "description" : "this is a test"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 参数说明：总记录数。 edge_apps Array of QueryApplicationBriefResponseDTO objects 参数说明：列举每条记录。 表5 QueryApplicationBriefResponseDTO 参数 参数类型 描述 edge_app_id String 参数说明：用户自定义应用唯一ID。 取值范围：只允许字母、数字、下划线（_）、连接符（-）、美元符号（$）的组合。 description String 参数说明：应用描述。 取值范围：只允许中文、字母、数字、下划线（_）、中文分号（；）、中文冒号（：）、中文问号（？）、中文感叹号（！）中文逗号（，）、中文句号（。）、英文引号（;）、英文冒号（:）、英文逗号（,）、英文句号（.）、英文问号（?）、英文感叹号（!）、顿号（、）、连接符（-）的组合。 created_time String 参数说明：创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z。 last_modified_time String 参数说明：更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z。 last_published_version String 参数说明：最新发布版本。

响应示例 状态码： 200 OK { "count" : 1, "edge_apps" : [ { "edge_app_id" : "10691172132537970614092038885766", "description" : "this is a test app", "created_time" : "2021-12-23T12:21:55", "last_modified_time" : "2021-12-23T12:21:55", "last_published_version" : null } ]}

请求示例 POST https://{endpoint}/v1/{project_id}/v2x-edge-apps/{edge_app_id}/versionsContent-Type:application/jsonX-Auth-Token:********Instance-Id:********{ "args" : [ "args" ], "description" : "description", "version" : "1.0.11", "command" : [ "start" ], "container_settings" : { "configs" : { "privileged" : false, "host_network" : true, "restart_policy" : "Always", "container_port_list" : [ { "container_port" : 8082, "host_ip" : "127.0.0.1", "host_port" : 8083 } ] }, "image_url" : "example.com/huawei/edge:1.0.0", "volumes" : [ { "read_only" : true, "name" : "config", "destination" : "destination_1", "source" : "/opt/host/iot", "type" : " LOG " } ], "envs" : { "test" : "test" }, "resources" : { "requests" : { "npu" : 4, "memory" : 2, "cpu" : 1, "gpu" : 3 }, "limits" : { "npu" : 9, "memory" : 7, "cpu" : 6, "gpu" : 8 } }, "ext_devices" : [ { "destination" : "/destination", "cgroup_permissions" : "MRW", "source" : "/source" } ] }}

响应参数 状态码： 200 表11 响应Body参数 参数 参数类型 描述 edge_app_id String 参数说明：用户自定义应用唯一ID。 取值范围：只允许字母、数字、下划线（_）、连接符（-）、美元符号（$）的组合。 version String 参数说明：应用版本。 description String 参数说明：应用描述。 取值范围：只允许中文、字母、数字、下划线（_）、中文分号（；）、中文冒号（：）、中文问号（？）、中文感叹号（！）中文逗号（，）、中文句号（。）、英文引号（;）、英文冒号（:）、英文逗号（,）、英文句号（.）、英文问号（?）、英文感叹号（!）、顿号（、）、连接符（-）的组合。 created_time String 参数说明：创建时间。 last_modified_time String 参数说明：最后一次修改时间。 state String 参数说明：应用版本状态。 取值范围： DRAFT：草稿 PUBLISHED：发布 OFF_SHELF：下线 command Array of strings 参数说明：启动命令。 args Array of strings 参数说明：启动参数。 container_settings ContainerSettingsDTO object 参数说明：容器配置。 publish_time String 参数说明：发布时间。 off_shelf_time String 参数说明：下线时间。 表12 ContainerSettingsDTO 参数 参数类型 描述 configs ContainerConfigsDTO object 参数说明：容器特殊参数。 image_url String 参数说明：镜像存储地址。 envs Object 参数说明：环境变量。 volumes Array of VolumeDTO objects 参数说明：卷配置。 resources ResourceDTO object 参数说明：资源配额。 ext_devices Array of ExtDevice objects 参数说明：外挂设备配置。 表13 ContainerConfigsDTO 参数 参数类型 描述 privileged Boolean 参数说明：开启容器特权模式。 host_network Boolean 参数说明：是否使用主机网络模式。 restart_policy String 参数说明：重启策略，容器执行健康检查后失败后的策略。 container_port_list Array of ContainerPortDTO objects 参数说明：容器端口映射值。 表14 ContainerPortDTO 参数 参数类型 描述 container_port Integer 参数说明：构成一对映射的容器端口。 host_port Integer 参数说明：构成一对映射的物理机对应网卡端口。 host_ip String 参数说明：对应网卡地址。 表15 VolumeDTO 参数 参数类型 描述 name String 参数说明：卷名称。 type String 参数说明：挂载类型。 source String 参数说明：源路径。只允许输入数字、大写字母、小写字母、下划线（_）、横杠（-）、斜线（/） destination String 参数说明：卷挂载路径。 read_only Boolean 参数说明：只读，默认只读。 表16 ResourceDTO 参数 参数类型 描述 limits ResourceConfigDTO object 参数说明：允许容器使用的最大资源。 requests ResourceConfigDTO object 参数说明：容器需要使用的最小资源。 表17 ResourceConfigDTO 参数 参数类型 描述 cpu Float 参数说明：cpu个数。 memory Float 参数说明：内存大小。 gpu Float 参数说明：gpu个数。 npu Float 参数说明：npu个数。 表18 ExtDevice 参数 参数类型 描述 source String 参数说明：源路径。 destination String 参数说明：卷挂载路径。 cgroup_permissions String 参数说明：只读，默认MRW。

响应示例 状态码： 200 Created { "edge_app_id" : "10689817309939082523811187758968", "version" : "1.0.2", "description" : "this is a test", "created_time" : "2020-05-28T11:31:29.740Z", "last_modified_time" : "2020-05-28T11:31:29.740Z", "state" : "DRAFT", "command" : null, "args" : null, "container_settings" : null, "publish_time" : null, "off_shelf_time" : null}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 参数说明：返回RSU的总体数量。 rsus Array of RsuDTO objects 参数说明：RSU数据列表。 表5 RsuDTO 参数 参数类型 描述 rsu_id String 参数说明：RSU的唯一标识符，在平台创建RSU时由平台生成。 name String 参数说明：RSU的名字。 取值范围：长度不低于1不超过128，只允许中文、字母、数字、下划线（_）、连接符（-）的组合。 description String 参数说明：RSU的描述。 取值范围：只允许中文、字母、数字、下划线（_）、中文分号（；）、中文冒号（：）、中文问号（？）、中文感叹号（！）中文逗号（，）、中文句号（。）、英文分号（;）、英文冒号（:）、英文逗号（,）、英文句号（.）、英文问号（?）、英文感叹号（!）、顿号（、）、连接符（-）、空格的组合。 esn String 参数说明：RSU的设备序列号。 取值范围：只允许字母、数字、下划线（_）的组合。 last_modified_time String 参数说明：最后修改的时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z created_time String 参数说明：创建的时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z last_online_time String 参数说明：最后的在线时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z ip String 参数说明：RSU的IP。满足IP的格式，例如127.0.0.1。 position_description String 参数说明：安装位置编码，由用户自定义。 取值范围：长度不低于1不超过128，只允许字母、数字、下划线（_）的组合。 location RsuLocation object 参数说明：RSU的位置信息。 status String 参数说明：RSU设备状态。 取值范围： ONLINE：在线 OFFLINE：离线 INITIAL：初始化 UNKNOWN：未知 rsu_model_id String 参数说明：RSU型号ID，用于唯一标识一个RSU型号，在平台创建RSU型号后由平台分配获得，获取方法可参见 “创建RSU型号”接口。 取值范围：长度不低于1不超过36，只允许字母、数字、连接符（-）的组合。 intersection_id String 参数说明：在地图中，rsu所在区域对应的路口ID，也即区域ID拼接路口ID，格式为：region-node_id。其中路网最基本的构成即节点和节点之间连接的路段。节点可以是路口，也可以是一条 路的端点。一个节点的ID在同一个区域内是唯一的。 related_edge_num Integer 参数说明：RSU可关联的Edge的数量。 software_version String 参数说明：RSU的软件版本，由RSU上报其软件版本。 表6 RsuLocation 参数 参数类型 描述 lat Number 参数说明：定义纬度数值，北纬为正，南纬为负，单位°，精度小数点后7位。 lon Number 参数说明：定义经度数值。东经为正，西经为负，单位°，精度小数点后7位。

响应示例 状态码： 200 OK { "count" : 1, "rsus" : [ { "rsu_id" : "b58efc27-a6e5-4bca-9d12-c76ecfe3f102", "name" : "RSU001", "description" : "TEST", "esn" : "13518098671442480164720973683901", "last_modified_time" : "2020-09-01T01:37:01Z", "created_time" : "2020-09-01T01:37:01Z", "last_online_time" : "2020-09-01T01:37:01Z", "ip" : "127.0.0.1", "position_description" : "K08", "location" : { "lat" : 40.1234567, "lon" : 116.1234567 }, "status" : "ONLINE", "rsu_model_id" : "27652459499824704332521974743806", "intersection_id" : "1-301", "related_edge_num" : 0, "software_version" : "V100X00XX00X325" } ]}

请求示例 GET https://{endpoint}/v1/{project_id}/rsus?limit={limit}&offset={offset}&rsu_id={rsu_id}&esn={esn}&status={status}&rsu_model_id={rsu_model_id}Content-Type:application/jsonX-Auth-Token:********Instance-Id:********

请求示例 PUT https://{endpoint}/v1/{project_id}/rsus/{rsu_id}Content-Type:application/jsonX-Auth-Token:********Instance-Id:********{ "name" : "RSU001", "description" : "TEST", "ip" : "127.0.0.1", "position_description" : "K08", "intersection_id" : "1-301", "related_edge_num" : 0}

响应示例 状态码： 200 OK { "rsu_id" : "b58efc27-a6e5-4bca-9d12-c76ecfe3f102", "name" : "RSU001", "description" : "TEST", "esn" : "13518098671442480164720973683901", "last_modified_time" : "2020-09-01T01:37:01Z", "created_time" : "2020-09-01T01:37:01Z", "last_online_time" : "2020-09-01T01:37:01Z", "ip" : "127.0.0.1", "position_description" : "K08", "location" : { "lat" : 40.1234567, "lon" : 116.1234567 }, "status" : "ONLINE", "rsu_model_id" : "27652459499824704332521974743806", "intersection_id" : "1-301", "related_edge_num" : 0, "software_version" : "V100X00XX00X325"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 rsu_id String 参数说明：RSU的唯一标识符，在平台创建RSU时由平台生成。 name String 参数说明：RSU的名字。 取值范围：长度不低于1不超过128，只允许中文、字母、数字、下划线（_）、连接符（-）的组合。 description String 参数说明：RSU的描述。 取值范围：只允许中文、字母、数字、下划线（_）、中文分号（；）、中文冒号（：）、中文问号（？）、中文感叹号（！）中文逗号（，）、中文句号（。）、英文分号（;）、英文冒号（:）、英文逗号（,）、英文句号（.）、英文问号（?）、英文感叹号（!）、顿号（、）、连接符（-）、空格的组合。 esn String 参数说明：RSU的设备序列号。 取值范围：只允许字母、数字、下划线（_）的组合。 last_modified_time String 参数说明：最后修改的时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z created_time String 参数说明：创建的时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z last_online_time String 参数说明：最后的在线时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如 2020-09-01T01:37:01Z ip String 参数说明：RSU的IP。满足IP的格式，例如127.0.0.1。 position_description String 参数说明：安装位置编码，由用户自定义。 取值范围：长度不低于1不超过128，只允许字母、数字、下划线（_）的组合。 location RsuLocation object 参数说明：RSU的位置信息。 status String 参数说明：RSU设备状态。 取值范围： ONLINE：在线 OFFLINE：离线 INITIAL：初始化 UNKNOWN：未知 rsu_model_id String 参数说明：RSU型号ID，用于唯一标识一个RSU型号，在平台创建RSU型号后由平台分配获得，获取方法可参见 “创建RSU型号”接口。 取值范围：长度不低于1不超过36，只允许字母、数字、连接符（-）的组合。 intersection_id String 参数说明：在地图中，rsu所在区域对应的路口ID，也即区域ID拼接路口ID，格式为：region-node_id。其中路网最基本的构成即节点和节点之间连接的路段。节点可以是路口，也可以是一条 路的端点。一个节点的ID在同一个区域内是唯一的。 related_edge_num Integer 参数说明：RSU可关联的Edge的数量。 software_version String 参数说明：RSU的软件版本，由RSU上报其软件版本。 表5 RsuLocation 参数 参数类型 描述 lat Number 参数说明：定义纬度数值，北纬为正，南纬为负，单位°，精度小数点后7位。 lon Number 参数说明：定义经度数值。东经为正，西经为负，单位°，精度小数点后7位。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 参数说明：满足查询条件的记录总数。 rsu_models Array of RsuModelSummary objects 参数说明：RSU型号信息列表。 表5 RsuModelSummary 参数 参数类型 描述 rsu_model_id String 参数说明：RSU型号ID，用于唯一标识一个RSU型号，在平台创建RSU型号后由平台分配获得。 取值范围：长度不小于1不超过36，只允许字母、数字、连接符（-）的组合。 name String 参数说明: RSU型号名称。 取值范围：长度不低于1不超过64，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。 manufacturer_name String 参数说明: RSU的厂商名称。 取值范围：长度不低于1不超过32，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。 description String 参数说明: RSU型号的描述信息。 取值范围：长度不低于1不超过128，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。 last_modified_time String 参数说明: RSU型号更新的时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如：2020-12-07T01:32:17Z created_time String 参数说明: 在平台创建RSU型号的时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如：2020-12-07T01:32:17Z

响应示例 状态码： 200 OK { "count" : 1, "rsu_models" : [ { "rsu_model_id" : "5ba24f5ebbe8f56f5a14f605", "name" : "RSU001", "manufacturer_name" : "ABC", "description" : "test", "last_modified_time" : "2020-12-07T01:32:17Z", "created_time" : "2020-12-07T01:32:17Z" } ]}

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表格内容。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Instance-Id 路网数字化服务 的实例ID，请参考获取Instance-Id获取实例ID。 否 部分接口调用要求必选。 c7ff8b76-9e6c-46c1-863e-a2225bb637ef project-id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。 例如 IAM 服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token额作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

响应示例 状态码： 200 OK { "rsu_model_id" : "5ba24f5ebbe8f56f5a14f605", "name" : "RSU001", "manufacturer_name" : "ABC", "description" : "excellent", "created_time" : "2020-12-07T01:32:17Z", "last_modified_time" : "2020-12-07T01:32:17Z"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 rsu_model_id String 参数说明：RSU型号ID，用于唯一标识一个RSU型号，在平台创建RSU型号后由平台分配获得。 取值范围：长度不小于1不超过36，只允许字母、数字、连接符（-）的组合。 name String 参数说明: RSU型号名称。 取值范围：长度不低于1不超过64，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。 manufacturer_name String 参数说明: RSU的厂商名称。 取值范围：长度不低于1不超过32，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。 description String 参数说明: RSU型号的描述信息。 取值范围：长度不低于1不超过128，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）、空格的组合 last_modified_time String 参数说明: RSU型号更新的时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如：2020-12-07T01:32:17Z created_time String 参数说明: 在平台创建RSU型号的时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如：2020-12-07T01:32:17Z

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

响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-1", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_code": "DRIS.01010002", "error_msg": "The RSU not found. "} 其中，error_code表示错误码，error_msg表示错误描述信息。error_msg值会变动，内容以实际情况为准。

请求示例 POST https://{endpoint}/v1/{project_id}/rsu-modelsContent-Type:application/jsonX-Auth-Token:********Instance-Id:********{ "name" : "RSU001", "manufacturer_name" : "ABC", "description" : "excellent"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 rsu_model_id String 参数说明：RSU型号ID，用于唯一标识一个RSU型号，在平台创建RSU型号后由平台分配获得。 取值范围：长度不小于1不超过36，只允许字母、数字、连接符（-）的组合。 name String 参数说明: RSU型号名称。 取值范围：长度不低于1不超过64，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。 manufacturer_name String 参数说明: RSU的厂商名称。 取值范围：长度不低于1不超过32，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。 description String 参数说明: RSU型号的描述信息。 取值范围：长度不低于1不超过128，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）、空格的组合。 last_modified_time String 参数说明: RSU型号更新的时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如：2020-12-07T01:32:17Z created_time String 参数说明: 在平台创建RSU型号的时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如：2020-12-07T01:32:17Z

请求示例 PUT https://{endpoint}/v1/{project_id}/rsu-models/{rsu_model_id}Content-Type:application/jsonX-Auth-Token:********Instance-Id:********{ "manufacturer_name" : "ABC", "description" : "excellent"}

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 rsu_model_id String 参数说明：RSU型号ID，用于唯一标识一个RSU型号，在平台创建RSU型号后由平台分配获得。 取值范围：长度不小于1不超过36，只允许字母、数字、连接符（-）的组合。 name String 参数说明: RSU型号名称。 取值范围：长度不低于1不超过64，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。 manufacturer_name String 参数说明: RSU的厂商名称。 取值范围：长度不低于1不超过32，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。 description String 参数说明: RSU型号的描述信息。 取值范围：长度不低于1不超过128，只允许中文、字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）、空格的组合 last_modified_time String 参数说明: RSU型号更新的时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如：2020-12-07T01:32:17Z created_time String 参数说明: 在平台创建RSU型号的时间。 格式：yyyy-MM-dd'T'HH:mm:ss'Z' 例如：2020-12-07T01:32:17Z