华为云用户手册

  • 响应示例 状态码: 200 查询成功 { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "list" : [ { "vehicle" : "car1", "start_time" : 1640966400000, "end_time" : 1640966500000 }, { "vehicle" : "car2", "start_time" : 1640966400000, "end_time" : 1640966500000 } ] }}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 payload DataStaticsEpisodePayload object 实际返回信息 meta_info RespMetaInfo object 元数据 表5 DataStaticsEpisodePayload 参数 参数类型 描述 list Array of DataEpisodeInfo objects 分时间段统计列表 表6 DataEpisodeInfo 参数 参数类型 描述 vehicle String 车辆名称 start_time Long 开始时间,UTC标准时间毫秒时间戳 end_time Long 结束时间,UTC标准时间毫秒时间戳 表7 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间,UTC时间格式,时间为UTC标准时间
  • 响应参数 状态码: 201 表6 响应Body参数 参数 参数类型 描述 url String 地图资源地址。 id Integer 地图ID。 created_at Double 创建时间。 最小值:0 updated_at Double 更新时间。 最小值:0 file FileCreateSrlz object 地图文件信息。 version String 地图文件的OpenDRIVE版本。 枚举值: v1.4.0 v1.5.0 v1.6.0 v1.6.1 v1.7.0 agreement_confirm Boolean 是否同意免责声明,必须为true。 表7 FileCreateSrlz 参数 参数类型 描述 url String 文件资源地址。 sha256 String 文件sha256值。 最小长度:64 最大长度:64 created_at Double 创建时间。 最小值:0 updated_at Double 更新时间。 最小值:0 post post object POST预签链接信息,用于上传文件。 put_url String PUT预签链接地址,用于上传文件。优先使用POST方法上传。 get_url String GET地址,用于下载文件。 expire Integer 默认失效时间为600秒。 缺省值:600 ready Boolean 文件状态。完成文件上传状态为true,未完成文件上传状态为false。 filename String 文件名。 最大长度:255 表8 post 参数 参数类型 描述 url String POST预签链接信息,用于上传文件。 fields PostResponseField object POST预签链接信息,调用POST预签链接上传文件时用于构造请求。 表9 PostResponseField 参数 参数类型 描述 key String Post预签链接Key字段,在创建请求时需要添加到请求头。 x-amz-algorithm String Post预签链接x-amz-algorithm字段,在创建请求时需要添加到请求头。 x-amz-credential String Post预签链接x-amz-credential字段,在创建请求时需要添加到请求头。 x-amz-date String Post预签链接x-amz-date字段,在创建请求时需要添加到请求头。 policy String Post预签链接policy字段,在创建请求时需要添加到请求头。 x-amz-signature String Post预签链接x-amz-signature字段,在创建请求时需要添加到请求头。
  • 请求示例 创建场景地图 POST https://{endpoint}/v2/{project_id}/sim/sm/maps/{ "version" : "v1.6.0", "file" : { "sha256" : "8717ae1874a4b063267211bb575373b7eb73aaa99d6ed531352fff3776dc3a60", "filename" : "ALKS_Road_straight.xodr" }}
  • 响应示例 状态码: 201 请求成功 { "url" : "/v2/my_project_id/sim/sm/maps/2631662/", "id" : 2631662, "created_at" : 1.699954027366838E9, "updated_at" : 1.699954027366882E9, "file" : { "url" : "/v2/my_project_id/sim/sm/files/8717ae1874a4b063267211bb575373b7eb73aaa99d6ed531352fff3776dc3a60/", "sha256" : "8717ae1874a4b063267211bb575373b7eb73aaa99d6ed531352fff3776dc3a60", "created_at" : 1.699954027363056E9, "updated_at" : 1.699954027363114E9, "post" : { "url" : "https://post_url", "fields" : { "key" : "sim/ifiles/map/8717ae1874a4b063267211bb575373b7eb73aaa99d6ed531352fff3776dc3a60.xodr", "x-amz-algorithm" : "AWS4-HMAC-SHA256", "x-amz-credential" : "my-x-amz-credential", "x-amz-date" : "20231114T092707Z", "policy" : "my-policy", "x-amz-signature" : "my-x-amz-signature" }, "put_url" : "my-put-url", "get_url" : null, "expire" : 600, "ready" : false, "filename" : "ALKS_Road_straight.xodr" }, "version" : "v1.6.0" }, "agreement_confirm" : true}
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 url 是 String 地图资源地址。 id 是 Integer 地图ID。 created_at 是 Double 创建时间。 最小值:0 updated_at 是 Double 更新时间。 最小值:0 file 是 FileCreateSrlz object 地图文件信息。 version 是 String 地图文件的OpenDRIVE版本。 枚举值: v1.4.0 v1.5.0 v1.6.0 v1.6.1 v1.7.0 agreement_confirm 是 Boolean 是否同意免责声明,必须为true。 表3 FileCreateSrlz 参数 是否必选 参数类型 描述 url 是 String 文件资源地址。 sha256 是 String 文件sha256值。 最小长度:64 最大长度:64 created_at 是 Double 创建时间。 最小值:0 updated_at 是 Double 更新时间。 最小值:0 post 是 post object POST预签链接信息,用于上传文件。 put_url 是 String PUT预签链接地址,用于上传文件。优先使用POST方法上传。 get_url 是 String GET地址,用于下载文件。 expire 是 Integer 默认失效时间为600秒。 缺省值:600 ready 是 Boolean 文件状态。完成文件上传状态为true,未完成文件上传状态为false。 filename 是 String 文件名。 最大长度:255 表4 post 参数 是否必选 参数类型 描述 url 否 String POST预签链接信息,用于上传文件。 fields 否 PostResponseField object POST预签链接信息,调用POST预签链接上传文件时用于构造请求。 表5 PostResponseField 参数 是否必选 参数类型 描述 key 否 String Post预签链接Key字段,在创建请求时需要添加到请求头。 x-amz-algorithm 否 String Post预签链接x-amz-algorithm字段,在创建请求时需要添加到请求头。 x-amz-credential 否 String Post预签链接x-amz-credential字段,在创建请求时需要添加到请求头。 x-amz-date 否 String Post预签链接x-amz-date字段,在创建请求时需要添加到请求头。 policy 否 String Post预签链接policy字段,在创建请求时需要添加到请求头。 x-amz-signature 否 String Post预签链接x-amz-signature字段,在创建请求时需要添加到请求头。
  • 数据仓库 自定义属性 表1 数据仓库自定义属性权限 权限 对应API接口 授权项(Action) IAM 项目 (Project) 企业项目 (Enterprise Project) 获取数据仓库自定义属性列表 GET /v1.0/{project_id}/common/warehouses/custom-attributes octopus:dataWarehouse:list √ √ 父主题: 权限和授权项
  • 基本概念 账号 用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在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的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 父主题: 使用前必读
  • 响应示例 状态码: 200 查询成功 { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "list" : [ { "file_name" : "job-std-stream.log", "file_size" : 1000, "update_time" : 1640966400000 } ] }}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 payload DataJobLogListPayload object 实际返回信息 meta_info RespMetaInfo object 元数据 表4 DataJobLogListPayload 参数 参数类型 描述 list Array of DataJobLogPayload objects 日志列表 表5 DataJobLogPayload 参数 参数类型 描述 file_name String 日志文件名 file_size Long 日志文件大小 update_time Long 更新时间 表6 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间,UTC时间格式,时间为UTC标准时间
  • 响应示例 状态码: 200 查询成功 { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "list" : [ { "id" : 10002, "repo_id" : 10001, "create_at" : 1698405950407, "update_at" : 1701399655749, "project_id" : "087679f0aa80d32a2f4ec0172f5e902b", "user_id" : "087679f0aa80d32a2f4ec0172f5e902b", "status" : "PUSHED", "version" : 1, "visibility" : "TEAM", "description" : "test" } ], "page_info" : { "total" : 1, "offset" : 0, "limit" : 10 } }}
  • 仿真场景 表1 仿真场景权限 权限 对应API接口 授权项(Action) IAM项目 (Project) 企业项目 (Enterprise Project) 场景列表 GET /v2/{project_id}/sim/sm/scenarios octopus:simScenario:list √ √ 创建仿真场景 POST /v2/{project_id}/sim/sm/scenarios octopus:simScenario:create √ √ 创建场景文件 POST /v2/{project_id}/sim/sm/scenarios/{parent_lookup_id}/files octopus:simScenario:create √ √ 修改场景文件 PATCH /v2/{project_id}/sim/sm/scenarios/{parent_lookup_id}/files/{sha256} octopus:simScenario:update √ √ 父主题: 权限和授权项
  • URI GET /v1.0/{project_id}/common/image-registry/image-repos/{id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方法请参见获取项目ID id 是 Long 镜像仓库id 最小值:1 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String 按照状态筛选 枚举值: INIT(初始化) PUSHED(创建成功) PUSHING(推送中) SECONDARY_PUSHING(二次推送中) PUSH_FAILED(创建失败) limit 否 Integer 返回个数上限 最小值:1 最大值:100 缺省值:10 offset 否 Integer 查询偏移量 最小值:0 缺省值:0
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 payload VersionListPayload object 实际返回信息 meta_info MetaInfo object 元数据 表5 VersionListPayload 参数 参数类型 描述 list Array of RepoVersion objects 镜像版本列表 page_info PageInfo object 分页信息 表6 RepoVersion 参数 参数类型 描述 id Long 版本id repo_id Long 所属仓库id create_at Long 创建时间,UTC标准时间毫秒时间戳 update_at Long 最近更新时间,UTC标准时间毫秒时间戳 project_id String 项目id user_id String 创建用户id status String 状态 枚举值: INIT(初始化) PUSHED(创建成功) PUSHING(推送中) SECONDARY_PUSHING(二次推送中) PUSH_FAILED(创建失败) version Integer 版本号 description String 描述。若镜像没有描述则不返回该字段 visibility String 使用范围 枚举值: TEAM(团队) PUBLIC(公开) 表7 PageInfo 参数 参数类型 描述 total Integer 资源总数 offset Integer 查询偏移量 limit Integer 返回个数上限 表8 MetaInfo 参数 参数类型 描述 current_time String 请求时间,UTC时间格式,时间为UTC标准时间
  • 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/projectsContent-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 payload LabelDatasetVOPayload object 实际返回信息 meta_info MetaInfo object 元数据 表5 LabelDatasetVOPayload 参数 参数类型 描述 list Array of LabelDatasetVO objects 数据集列表 page_info PageInfo object 分页信息 表6 LabelDatasetVO 参数 参数类型 描述 id String id name String 名称 description String 描述 data_type String 数据类型 枚举值: IMAGE(图片) POINT_CLOUD(点云) TEXT(文本) VIDEO(视频) dataset_form String 数据集形式 枚举值: DATASET(数据集) SUBSET(子集) source_dataset_id String 子集的源数据集ID latest_version Integer 最新版本 data_source String 数据来源 枚举值: LABEL(标注) LOCAL(本地) OBS HOUSE(数据仓库) DATASET(数据集) owner String 数据集类型 枚举值: CUSTOMER(自定义数据集) SYSTEM(内置数据集) frame_num Long 文件数 frame_size Long 数据集下版本帧文件总大小,单位字节 project_id String 项目id label_format String 标注格式 枚举值: OCTOPUS(OCTOPUS格式) USER_DEFINE(自定义格式) label_count Long 标注物数量 label_names Array of strings 所有标注物名称 create_at Long 创建时间,UTC标准时间毫秒时间戳 update_at Long 修改时间,UTC标准时间毫秒时间戳 label_taged Boolean 标注数据集tag,已标注是true label_associated Boolean 标注服务中,标注任务是否关联该数据集,关联了为true data_source_info DataSourceInfoList object 数据相关信息 tags Array of strings 标签 最大长度:64 custom_attributes Array of strings 自定义属性,格式形如"key:value" version_count Integer 版本数量 has_finished Boolean 是否结束,该数据集下没有非终止状态下的版本表示结束,成功或失败表示终止状态 version_success_count Integer 数据集下状态为成功的版本数量 publish_status String 发布状态 枚举值: SUC CES S(成功) DOING(导入中) FAIL(失败) UN_PUBLISH(未发布) file_size String 数据集所有版本文件总大小,包含具体单位 表7 DataSourceInfoList 参数 参数类型 描述 label_project_package_id String 任务项目包ID label_project_package_name String 任务项目包名称 batch_task_ids Array of strings 批次任务ID data_warehouse_id String 数据仓库ID raw_data_ids Array of strings 原始数据包ID data_process_task_ids Array of strings 处理任务ID 表8 PageInfo 参数 参数类型 描述 total Long 资源总数 offset Long 查询偏移量 limit Long 返回个数上限 表9 MetaInfo 参数 参数类型 描述 current_time String 请求时间,UTC时间格式,时间为UTC标准时间
  • 响应示例 状态码: 200 查询成功 获取数据集列表 { "payload" : { "list" : [ { "id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "dataset_name", "description" : "", "data_type" : "IMAGE", "latest_version" : 3, "data_source" : "HOUSE", "frame_num" : 123, "frame_size" : 93398989, "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "label_format" : "OCTOPUS", "label_count" : 0, "label_taged" : "false,", "label_associated" : "false,", "create_at" : 1701077827974, "update_at" : 1701335688724, "data_source_info" : { "data_warehouse_id" : "ee9784a5-dde5-4a47-a006-fac074c5bee8", "data_process_task_ids" : [ "frame-extract-2077" ] }, "tags" : [ "接管", "大客车", "停车位", "小区内部路", "乡村道路", "卡车", "一般道路", "轿车" ], "custom_attributes" : [ "city:tencent", "city:sunny", "city:not-a-plate" ], "version_count" : 3, "has_finished" : true, "version_success_count" : 0, "publish_status" : "UN_PUBLISH", "file_size" : "89.07MB" } ], "page_info" : { "total" : 237, "offset" : 0, "limit" : 10 } }, "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }}
  • URI GET /v1.0/{project_id}/common/datasets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 名称 最小长度:1 最大长度:64 data_type 否 String 枚举值: IMAGE(图片) POINT_CLOUD(点云) TEXT(文本) VIDEO(视频) dataset_form 否 String 数据集类别 枚举值: DATASET(数据集) SUBSET(子集) source_dataset_id 否 String 源数据集id label_format 否 String 按标注格式筛选 枚举值: OCTOPUS(OCTOPUS格式) USER_DEFINE(自定义格式) data_source 否 String 枚举值: LABEL(标注任务) LOCAL(本地) OBS HOUSE(数据仓库) DATASET(数据集) owner 否 String 数据集类型 枚举值: CUSTOMER(自定义数据集) SYSTEM(内置数据集) order 否 String 查询结果的排序方式 缺省值:DESC 枚举值: DESC(更新时间降序排列) ASC(更新时间升序排列) offset 否 Integer 查询偏移量 最小值:0 缺省值:0 limit 否 Integer 返回个数上限 最小值:1 最大值:100 缺省值:10 statuses 否 Array 枚举值: CREATING(创建中) IN_INTEGRATION(整合中) EXPORTING(导出中) SUCCESS(成功) INTEGRATION_FAILED(整合失败) EXPORT_FAILED(导出失败) EXPORT_PRE_SUCCESS(导出中) UPLOAD_SUSPENDED(上传中断) INITIALIZING(初始化) label_taged 否 Boolean 标注数据集tag,已标注是true,未标注是false select_source_dataset 否 Boolean 是否查询源数据集list,是true,否false
  • 响应示例 状态码: 200 查询成功 { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "item" : { "id" : 1, "type" : "F RAM E_EXTRACT", "data_id" : "DPK0000001", "status" : "FINISHED", "create_at" : 1640966400000, "update_at" : 1640966400000, "start_at" : 1640966400000, "end_at" : 1640966400000, "project_id" : "087679f0aa80d32a2f4ec0172f5e902b", "user_id" : "087679f0aa80d32a2f4ec0172f5e902b" } }}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 payload DataSystemJobDeatilItem object 实际返回信息 meta_info RespMetaInfo object 元数据 表4 DataSystemJobDeatilItem 参数 参数类型 描述 item DataSystemJobDeatilVo object 内部作业详情 表5 DataSystemJobDeatilVo 参数 参数类型 描述 id Long 作业id type String 内部作业类型 枚举值: PACKAGE_IMPORT(数据包导入) PACKAGE_DELETE(数据包删除) SCENARIO_AUTO_MINING(场景挖掘) SCENARIO_TO_SIM(转仿真场景) FRAME_EXTRACT(数据抽帧) SCENARIO_EXTRACT(场景提取) data_id String 数据id status String 作业状态 枚举值: QUEUING(排队中) SUBMIT_FAILED(提交失败) RUNNING(运行中) RUN_FAILED(运行异常) FINISHED(已完成) STOPPED(已停止) LAUNCHING(启动中) UPLOADING(上传中) UPLOAD_FAILED(上传失败) create_at Long 创建时间,UTC标准时间毫秒时间戳 update_at Long 更新时间,UTC标准时间毫秒时间戳 start_at Long 开始时间,UTC标准时间毫秒时间戳 end_at Long 结束时间,UTC标准时间毫秒时间戳 project_id String 项目id user_id String 用户id 表6 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间,UTC时间格式,时间为UTC标准时间
  • 请求示例 创建回放转仿真场景作业 POST https://{endpoint}/v1.0/{project_id}/data/episodes/scenarios{ "start" : 1640966400000, "end" : 1640966500000, "tag_ids" : [ 1000 ], "dpk_id" : "DPK0000001", "sim_name" : "仿真场景", "scenario_description" : "description", "sim_format" : "SIM_PRO_TOOLS"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) Content-Type 是 String 内容类型。填application/json 表3 请求Body参数 参数 是否必选 参数类型 描述 start 是 Long 起始时间,UTC标准时间毫秒时间戳 最小值:1000000000000 最大值:2000000000000 end 是 Long 结束时间,UTC标准时间毫秒时间戳 最小值:1000000000000 最大值:2000000000000 dpk_id 是 String 数据包id,以DPK开头,加7-13位数字 sim_name 是 String 仿真场景名称 最大长度:256 sim_format 否 String 仿真器。VTD_TOOLS:VTD,SIM_PRO_TOOLS:SimPro scenario_description 否 String 场景描述 最大长度:255 priority 否 Integer 作业优先级 最小值:-50 最大值:50 缺省值:40 tag_ids 否 Array of longs 标签列表,最多50个 data_warehouse_id 否 String 作业输出若需保存到数据仓库,此处填写数据仓库id
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 payload payloadWithSingleNumber object 实际返回信息 meta_info RespMetaInfo object 元数据 表5 payloadWithSingleNumber 参数 参数类型 描述 item Long 资源id 表6 RespMetaInfo 参数 参数类型 描述 current_time String 请求时间,UTC时间格式,时间为UTC标准时间
  • 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 payload RepoVersionAccountPayload object 实际返回信息 meta_info MetaInfo object 元数据 表5 RepoVersionAccountPayload 参数 参数类型 描述 item RepoVersionAccount object 登录及操作指令相关信息 表6 RepoVersionAccount 参数 参数类型 描述 username String docker login登录名称 password String docker login登录密码 action String docker操作命令 枚举值: pull push expire_at Long 过期时间戳,单位为秒 path String 镜像版本完整路径 表7 MetaInfo 参数 参数类型 描述 current_time String 请求时间,UTC时间格式,时间为UTC标准时间
  • 响应示例 状态码: 201 创建成功 { "meta_info" : { "current_time" : "2022-01-01T08:08:29Z" }, "payload" : { "item" : { "username" : "cn-north-1@XXXXXXXXXXXXXXXXXXXX", "path" : "swr.cn-north-1.myhuaweicloud.com/octopus-087679f0aa80d32a2f4ec0172f5e902b/image-10001:v1.0", "password" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "action" : "push", "expire_at" : 1701485924 } }}
  • URI POST /v1.0/{project_id}/common/image-registry/image-repos/{id}/versions/{version}/accounts 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,获取方法请参见获取项目ID id 是 Long 镜像仓库id 最小值:1 version 是 Integer 版本号 最小值:1 表2 Query参数 参数 是否必选 参数类型 描述 action 是 String 镜像操作动作 枚举值: PUSH(推送) PULL(拉取)
  • 功能介绍 创建镜像仓库版本操作账号。 使用说明:假设发送请求后得到用户名cn-north-1@XXXXXXXXXX、密码YYYYYYYYYYY、镜像版本路径 swr.cn-north-1.myhuaweicloud.com/octopus-087679f0aa80d32a2f4ec0172f5e902b/image-10001:v1.0 、动作为pull,在本地一台安装了docker软件的计算机上输入"docker login -u cn-north-1@XXXXXXXXXX -p YYYYYYYYYYY swr.cn-north-1.myhuaweicloud.com"进行登录,然后输入"docker pull swr.cn-north-1.myhuaweicloud.com/octopus-087679f0aa80d32a2f4ec0172f5e902b/image-10001:v1.0" 拉取对应镜像。如果动作是push,则需要先在本地构建出标签为"swr.cn-north-1.myhuaweicloud.com/octopus-087679f0aa80d32a2f4ec0172f5e902b/image-10001:v1.0" 的镜像,然后通过"docker push swr.cn-north-1.myhuaweicloud.com/octopus-087679f0aa80d32a2f4ec0172f5e902b/image-10001:v1.0" 命令推送到octopus平台。
  • 响应示例 状态码: 200 创建成功 创建数据仓库类型的数据集版本 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "102575d5-cf89-4aca-b856-0d39ae2a69c5", "label_dataset_id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "V1", "label_format" : "OCTOPUS", "status" : "INITIALIZING", "frame_num" : 0, "frame_size" : 0, "label_count" : 0, "custom_image" : "10293:1", "command" : "command", "description" : "数据集版本", "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "create_at" : 1701403732492, "update_at" : 1701403732492, "agreement_confirm" : true } }} 创建标注类型的数据集版本 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "102575d5-cf89-4aca-b856-0d39ae2a69c5", "label_dataset_id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "V1", "label_format" : "OCTOPUS", "status" : "INITIALIZING", "frame_num" : 0, "frame_size" : 0, "label_count" : 0, "custom_image" : "10293:1", "command" : "command", "description" : "数据集版本", "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "create_at" : 1701403732492, "update_at" : 1701403732492, "search_status" : "labeled", "hard_mining" : true, "only_valid" : true, "label_meta_names" : [ "Person_sitting" ], "batch_task_id" : "e3d7ede3817541d29467388ac14b0eee", "agreement_confirm" : true } }} 创建本地类型的数据集版本 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "102575d5-cf89-4aca-b856-0d39ae2a69c5", "label_dataset_id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "V1", "label_format" : "OCTOPUS", "status" : "INITIALIZING", "frame_num" : 0, "frame_size" : 0, "label_count" : 0, "custom_image" : "10293:1", "command" : "command", "description" : "数据集版本", "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "create_at" : 1701403732492, "update_at" : 1701403732492, "agreement_confirm" : true } }} 创建OBS类型的数据集版本 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "102575d5-cf89-4aca-b856-0d39ae2a69c5", "label_dataset_id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "V1", "label_format" : "OCTOPUS", "status" : "INITIALIZING", "frame_num" : 0, "frame_size" : 0, "label_count" : 0, "custom_image" : "10293:1", "command" : "command", "description" : "数据集版本", "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "create_at" : 1701403732492, "update_at" : 1701403732492, "agreement_confirm" : true } }} 创建子集版本 { "meta_info" : { "current_time" : "2024-01-02T02:04:22Z" }, "payload" : { "item" : { "id" : "102575d5-cf89-4aca-b856-0d39ae2a69c5", "label_dataset_id" : "61a22ebc-49b3-40b5-b16f-ab9aebd2b231", "name" : "V1", "label_format" : "OCTOPUS", "status" : "INITIALIZING", "frame_num" : 0, "frame_size" : 0, "label_count" : 0, "custom_image" : "10293:1", "command" : "command", "description" : "数据集版本", "project_id" : "64d37c8f25af4277a1ff4ee9772687bf", "create_at" : 1701403732492, "update_at" : 1701403732492, "agreement_confirm" : true, "source_version_id" : "8d6df90a-8cd2-4ee6-ae12-36ae090600b5" } }}
  • 请求示例 创建数据仓库类型的数据集版本 POST https://{endpoint}/v1.0/{project_id}/common/datasets/61a22ebc-49b3-40b5-b16f-ab9aebd2b231/versions{ "agreement_confirm" : true, "description" : "数据集版本", "command" : "command", "custom_image" : "10293:1", "warehouse_params" : { "raw_data_ids" : [ "DPK0003878" ], "and_tags" : [ 956 ], "and_custom_attributes" : [ "61153deb-88ad-4f66-8bad-e3877bed309e" ], "file_types" : [ "TEXT" ], "start_time" : 1701360000000, "end_time" : 1701532799999 }} 创建标注类型的数据集版本 POST https://{endpoint}/v1.0/{project_id}/common/datasets/61a22ebc-49b3-40b5-b16f-ab9aebd2b231/versions{ "agreement_confirm" : true, "description" : "数据集版本", "command" : "command", "custom_image" : "10293:1", "status" : "labeled", "batch_task_id" : "e3d7ede3817541d29467388ac14b0eee", "label_meta_names" : [ "Person_sitting" ], "only_valid" : true, "hard_mining" : true} 创建本地类型的数据集版本 POST https://{endpoint}/v1.0/{project_id}/common/datasets/61a22ebc-49b3-40b5-b16f-ab9aebd2b231/versions{ "agreement_confirm" : true, "description" : "数据集版本", "command" : "command", "custom_image" : "10293:1"} 创建OBS类型的数据集版本 POST https://{endpoint}/v1.0/{project_id}/common/datasets/61a22ebc-49b3-40b5-b16f-ab9aebd2b231/versions{ "agreement_confirm" : true, "description" : "数据集版本", "command" : "command", "custom_image" : "10293:1", "bucket_name" : "octopus-raw-64d37c8f25af4277a1ff4ee9772687bf", "bucket_path" : "test/test"} 创建子集版本 POST https://{endpoint}/v1.0/{project_id}/common/datasets/61a22ebc-49b3-40b5-b16f-ab9aebd2b231/versions{ "agreement_confirm" : true, "description" : "数据集版本", "command" : "command", "custom_image" : "10293:1"}
共99354条