华为云用户手册

响应示例 状态码：200 查询成功 { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "item" : { "id" : 10, "processor_id" : 10000, "processor_name" : "myProcessor", "data_id" : "1b166fd2-xxxx-xxxx-xxxx-59f5b6742555", "status" : "FINISHED", "output_type" : "DATA_SET", "create_at" : 1640966400000, "update_at" : 1640966400000, "start_at" : 1640966400000, "end_at" : 1640966400000, "project_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b", "user_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b", "cluster_type" : "CCE", "cluster_id" : "087679f0aaxxxxxxxxxxxxxx2f5e902b", "warehouse_filters" : { "data_process_task_ids" : [ "frame-extract-1", "scenario-to-sim-1", "scenario-to-sim-1" ], "file_types" : [ "TEXT", "VIDEO", "POINT_CLOUD", "IMAGE", "SCENARIO" ] }, "envs" : [ { "key" : "key1", "value" : "1" } ], "resource_spec" : "1Core_1GiB", "warehouse_id" : "f78214c6-xxxx-xxxx-xxxx-0315098bce88" } } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 payload DataJobDetailPayload object 实际返回信息 meta_info RespMetaInfo object 元数据 表4 DataJobDetailPayload 参数 参数类型 描述 item DataJobDetailVo object 作业详情 表5 DataJobDetailVo 参数 参数类型 描述 id Long 作业id processor_id Long 算子id processor_name String 算子名称 data_id String 输入数据id status String 作业状态 output_type String 输出类型 create_at Long 创建时间，UTC标准时间毫秒时间戳 update_at Long 更新时间，UTC标准时间毫秒时间戳 start_at Long 运行开始时间，作业未开始运行不返回该字段，UTC标准时间毫秒时间戳 end_at Long 运行结束时间，作业未结束不返回该字段，UTC标准时间毫秒时间戳 project_id String 项目id msg_code Integer 错误码，作业状态正常不返回该字段(1:内部异常,10003:镜像不存在,10005:pvc不存在,10009:算子不存在,10011:获取实例资源异常,106:创建容器配置失败,107:镜像拉取失败,108:无效镜像,109:容器启动异常,110:创建容器失败,111:未选择 数据仓库 ,201:数据包不存在,202:资源不可用,203:数据包类型异常,204:数据包状态不符合要求,205:场景片段不存在或源文件不存在,206:数据来源与算子类型不匹配,99999:作业运行失败) msg_error String 错误原因，作业状态正常不返回该字段 user_id String 用户id resource_spec String 资源规格 warehouse_id String 输出到数据仓库的ID warehouse_filters WarehouseDataFilters object 数据仓库筛选参数 envs Array of JobEnv objects 环境变量 workspace_id String 工作空间id cluster_type String 集群类型 cluster_id String 集群id 表6 WarehouseDataFilters 参数 参数类型 描述 start_time Long 创建时间最小值时间，UTC标准时间毫秒时间戳 end_time Long 创建时间最大值时间，UTC标准时间毫秒时间戳 file_name String 文件名称筛选 data_process_task_ids Array of strings 数据处理任务id列表，id最多5个 raw_data_ids Array of strings 原始数据id列表，id最多5个 and_tags Array of longs 按标签筛选，多个标签取交集，tag最多5个 or_tags Array of integers 按标签筛选，多个标签取并集，tag最多5个 and_custom_attributes Array of strings 按自定义属性筛选，多个属性取交集，attribute最多5个 or_custom_attributes Array of strings 按自定义属性筛选，多个属性取并集，attribute最多5个 file_types Array of strings 文件类型列表，file_type最多10个 表7 JobEnv 参数 参数类型 描述 key String 环境变量键，不能重复，配置环境变量时此项必填 value String 环境变量值，配置环境变量时此项必填 表8 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间，UTC时间格式，时间为UTC标准时间

标签管理 表1 标签管理权限 权限 对应API接口 授权项（Action） IAM 项目 (Project) 企业项目 (Enterprise Project) 获取标签列表 GET /v1.0/{project_id}/data/tags octopus:dataTag:list √ √ 创建标签 POST /v1.0/{project_id}/data/tags octopus:dataTag:create √ √ 导入标签 POST /v1.0/{project_id}/data/tags/import octopus:dataTag:create √ √ 获取标签导入模板 GET /v1.0/{project_id}/data/tags/template octopus:dataTag:get √ √ 编辑标签 PUT /v1.0/{project_id}/data/tags/{id} octopus:dataTag:update √ √ 删除标签 DELETE /v1.0/{project_id}/data/tags/{id} octopus:dataTag:delete √ √ 父主题： 权限和授权项

数据场景 表1 数据场景权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 获取数据场景片段列表 GET /v1.0/{project_id}/data/scenario/segments octopus:dataScenario:list √ √ 创建数据场景片段 POST /v1.0/{project_id}/data/scenario/segments octopus:dataScenario:create √ √ 删除数据场景片段 DELETE /v1.0/{project_id}/data/scenario/segments/{id} octopus:dataScenario:delete √ √ 父主题： 权限和授权项

内部作业 表1 内部作业权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 查询内部作业列表 GET /v1.0/{project_id}/data/system-jobs octopus:dataJob:list √ √ 创建内部作业 POST /v1.0/{project_id}/data/system-jobs octopus:dataJob:create √ √ 查询内部作业详情 GET /v1.0/{project_id}/data/system-jobs/{id} octopus:dataJob:get √ √ 父主题： 权限和授权项

作业队列 表1 作业队列权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 查询排队作业列表 GET /v1.0/{project_id}/data/queuing-jobs octopus:dataJob:list √ √ 操作队列 PUT /v1.0/{project_id}/data/queuing-jobs/{id} octopus:dataJob:update √ √ 批量更新队列优先级 PUT /v1.0/{project_id}/data/queuing-jobs/batch-update octopus:dataJob:update √ √ 父主题： 权限和授权项

算子管理 表1 算子管理权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 查询算子列表 GET /v1.0/{project_id}/data/processors octopus:dataProcessors:list √ √ 创建算子 POST /v1.0/{project_id}/data/processors octopus:dataProcessors:create √ √ 查询算子详情 GET /v1.0/{project_id}/data/processors/{id} octopus:dataProcessors:get √ √ 更新算子 PUT /v1.0/{project_id}/data/processors/{id} octopus:dataProcessors:update √ √ 删除算子 DELETE /v1.0/{project_id}/data/processors/{id} octopus:dataProcessors:delete √ √ 父主题： 权限和授权项

作业管理 表1 作业管理权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 查询作业列表 GET /v1.0/{project_id}/data/jobs octopus:dataJob:list √ √ 创建作业 POST /v1.0/{project_id}/data/jobs octopus:dataJob:create √ √ 批量更新作业 PUT /v1.0/{project_id}/data/jobs octopus:dataJob:update √ √ 批量删除作业 DELETE /v1.0/{project_id}/data/jobs octopus:dataJob:delete √ √ 查询作业详情 GET /v1.0/{project_id}/data/jobs/{id} octopus:dataJob:get √ √ 更新作业 PUT /v1.0/{project_id}/data/jobs/{id} octopus:dataJob:update √ √ 删除作业 DELETE /v1.0/{project_id}/data/jobs/{id} octopus:dataJob:delete √ √ 查询作业日志列表 GET /v1.0/{project_id}/data/jobs/{id}/logs octopus:dataJob:get √ √ 查询作业日志详情 GET /v1.0/{project_id}/data/logs/jobs/{job_id}/{file_name} octopus:dataJob:get √ √ 父主题： 权限和授权项

数据回放 表1 数据回放权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 获取数据片段统计 GET /v1.0/{project_id}/data/episodes/statistics octopus:dataReplay:get √ √ 获取数据片段列表 GET /v1.0/{project_id}/data/episodes octopus:dataReplay:get √ √ 数据片段详情 GET /v1.0/{project_id}/data/episodes/{episode_id} octopus:dataReplay:get √ √ 获取数据包topic回放索引 GET /v1.0/{project_id}/data/packages/{id}/replay-indices octopus:dataReplay:get √ √ 获取数据包topic回放数据临时链接 GET /v1.0/{project_id}/data/packages/{id}/replay-data octopus:dataReplay:get √ √ 创建回放转仿真场景作业 POST /v1.0/{project_id}/data/episodes/scenarios octopus:dataScenario:create √ √ 查询回放转仿真场景作业状态 GET /v1.0/{project_id}/data/episodes/scenarios/{id} octopus:dataReplay:get √ √ 父主题： 权限和授权项

数据导入 表1 数据导入权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 获取导入任务列表 GET /v1.0/{project_id}/data/import-records octopus:dataImportRecord:list √ √ 创建数据包导入任务 POST /v1.0/{project_id}/data/import-records octopus:dataImportRecord:create √ √ 获取导入任务详情 GET /v1.0/{project_id}/data/import-records/{id} octopus:dataImportRecord:get √ √ 删除导入任务 DELETE /v1.0/{project_id}/data/import-records/{id} octopus:dataImportRecord:delete √ √ 启动数据导入任务 POST /v1.0/{project_id}/data/import-records/{id}/import octopus:dataImportRecord:import √ √ 父主题： 权限和授权项

数据包 表1 数据包权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 获取数据包列表 GET /v1.0/{project_id}/data/packages octopus:dataPackage:list √ √ 获取数据包详情 GET /v1.0/{project_id}/data/packages/{id} octopus:dataPackage:get √ √ 永久删除数据包 DELETE /v1.0/{project_id}/data/packages/{id} octopus:dataPackage:delete √ √ 操作数据包 PUT /v1.0/{project_id}/data/packages/{id} octopus:dataPackage:update √ √ 更新数据包标签 PUT /v1.0/{project_id}/data/packages/{id}/tags octopus:dataPackage:update √ √ 父主题： 权限和授权项

数据总览 表1 数据总览权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 获取数据服务总览 GET /v1.0/{project_id}/data/overview octopus:dataOverview:get √ √ 获取轨迹统计 GET /v1.0/{project_id}/data/mileage-statistics octopus:dataOverview:get √ √ 父主题： 权限和授权项

数据仓库自定义属性 表1 数据仓库自定义属性权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 获取数据仓库自定义属性列表 GET /v1.0/{project_id}/common/warehouses/custom-attributes octopus:dataWarehouse:list √ √ 父主题： 权限和授权项

数据仓库 表1 数据仓库权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 获取数据仓库列表 GET /v1.0/{project_id}/common/warehouses octopus:dataWarehouse:list √ √ 获取数据仓库的数据列表 POST /v1.0/{project_id}/common/warehouses/{data_warehouse_id}/data octopus:dataWarehouse:list √ √ 父主题： 权限和授权项

数据集版本 表1 数据集版本权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 获取数据集版本列表 GET /v1.0/{project_id}/common/datasets/{dataset_id}/versions octopus:dataset:list √ √ 创建数据集版本 POST /v1.0/{project_id}/common/datasets/{dataset_id}/versions octopus:dataset:create √ √ 获取数据集版本详情 GET /v1.0/{project_id}/common/datasets/{dataset_id}/versions/{version_id} octopus:dataset:get √ √ 删除数据集版本 DELETE /v1.0/{project_id}/common/datasets/{dataset_id}/versions/{version_id} octopus:dataset:delete √ √ 父主题： 权限和授权项

数据集 表1 数据集权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 获取数据集列表 GET /v1.0/{project_id}/common/datasets octopus:dataset:list √ √ 创建数据集 POST /v1.0/{project_id}/common/datasets octopus:dataset:create √ √ 获取数据集详情 GET /v1.0/{project_id}/common/datasets/{dataset_id} octopus:dataset:get √ √ 删除数据集 DELETE /v1.0/{project_id}/common/datasets/{dataset_id} octopus:dataset:delete √ √ 父主题： 权限和授权项

镜像版本 表1 镜像版本权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 获取镜像仓库版本列表 GET /v1.0/{project_id}/common/image-registry/image-repos/{id}/versions octopus:imageRepo:list √ √ 创建镜像仓库版本 POST /v1.0/{project_id}/common/image-registry/image-repos/{id}/versions octopus:imageRepo:create √ √ 获取镜像仓库版本详情 GET /v1.0/{project_id}/common/image-registry/image-repos/{id}/versions/{version} octopus:imageRepo:get √ √ 删除镜像仓库版本 DELETE /v1.0/{project_id}/common/image-registry/image-repos/{id}/versions/{version} octopus:imageRepo:delete √ √ 更新镜像仓库版本状态 POST /v1.0/{project_id}/common/image-registry/image-repos/{id}/versions/{version}/status octopus:imageRepo:update √ √ 创建镜像仓库版本操作账号 POST /v1.0/{project_id}/common/image-registry/image-repos/{id}/versions/{version}/accounts octopus:imageRepo:createAccount √ √ 父主题： 权限和授权项

镜像仓库 表1 镜像仓库权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 获取镜像仓库列表 GET /v1.0/{project_id}/common/image-registry/image-repos octopus:imageRepo:list √ √ 创建镜像仓库 POST /v1.0/{project_id}/common/image-registry/image-repos octopus:imageRepo:create √ √ 修改镜像仓库 PUT /v1.0/{project_id}/common/image-registry/image-repos/{id} octopus:imageRepo:update √ √ 删除镜像仓库 DELETE /v1.0/{project_id}/common/image-registry/image-repos/{id} octopus:imageRepo:delete √ √ 父主题： 权限和授权项

状态码 状态码如表1所示。 表1 状态码 状态码 编码 错误码说明 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协议的版本，无法完成处理。 父主题： 附录

场景地图 表1 场景地图权限 权限 对应API接口 授权项（Action） IAM项目 (Project) 企业项目 (Enterprise Project) 创建地图场景 POST /v2/{project_id}/sim/sm/maps octopus:simScenario:create √ √ 修改场景地图文件 PATCH /v2/{project_id}/sim/sm/maps/{parent_lookup_id}/files/{sha256} octopus:simScenario:update √ √ 父主题： 权限和授权项

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。

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

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内，12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": "user_password", //IAM用户密码 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "*******" //项目名称 } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-south-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。

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

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

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。X-Auth-Token是调用获取IAM用户Token（使用密码）接口返回的响应值，该接口功能为获取Token，因此调用该接口时，不用填写本字段。 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。AK/SK认证的详细说明请参见：AK/SK认证。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-south-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求URI 请求URI由如下部分组成。 {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 表1 请求URI 参数 说明 URI-scheme 传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器 域名 或IP，不同服务在不同区域时，对应Endpoint不同，可以从地区和终端节点中获取。 例如IAM服务在“华南-广州”区域的Endpoint为“iam.cn-south-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-south-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-south-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

终端节点 终端节点即调用API的请求地址，不同服务不同区域的终端节点不同。 Octopus自动驾驶云服务的终端节点如下表所示，请您根据业务需要选择对应区域的终端节点。 表1 自动驾驶云服务的终端节点 区域名称 区域 终端节点（Endpoint） 华北-乌兰察布-汽车一 cn-north-11 octopus.cn-north-11.myhuaweicloud.com 华南-广州 cn-south-1 octopus.cn-south-1.myhuaweicloud.com

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