华为云用户手册

约束限制 需已具备CodeArts Repo服务的操作权限，具体操作可参考授权使用CodeArts Repo服务。 目前该功能仅支持代码源为CodeArts Repo的C/C++语言构建工程的编译构建加速。 使用构建加速能力需要额外购买配套构建加速包，构建加速包因加速原理以及效果的不同，共有三种规格以供购买，规格介绍及购买指南请参考购买构建加速包。本实践需要购买X86架构和L3级别的加速包。 基于自定义执行机的构建任务，无法使用构建加速能力。 需在本地已准备好C++工程代码。

配置构建步骤并执行构建任务 配置“Npm构建”。 在命令编辑器里，npm run build命令前加“#”，新增zip -r ./nodeserver.zip ./命令，用来将代码打包成“nodeserver.zip”，如图1所示。其他参数保持默认即可。 图1 命令示例 按图2所示配置“上传软件包到软件发布库”。 图2 配置上传软件包到软件发布库 配置完所有构建步骤，单击“保存并执行”，执行编译构建任务。

云搜索服务 CSS CloudTable使用云搜索服务（Cloud Search Service，简称CSS）中的Elasticsearch搜索引擎来补充全文检索能力。用户在HBase的建表语句中，通过METADATA来定义索引字段的Elasticsearch schema并指定云搜索服务集群的连接地址，在建表时会自动连接云搜索服务集群并在Elasticsearch中创建索引。用户的源数据存储在CloudTable的HBase中，索引数据存放在云搜索服务的Elasticsearch中。 了解更多CSS的相关信息，请参见云搜索服务。

HBase产品简介 HBase是一个稳定可靠，性能卓越、可伸缩、面向列的分布式 云存储 系统，适用于海量数据存储以及分布式计算的场景，用户可以利用HBase搭建起TB至PB级数据规模的存储系统，对数据轻松进行过滤分析，毫秒级得到响应，快速发现数据价值。 HBase适用场景有： 海量数据存储。 适用于TB～PB级以上的数据存储，提供动态伸缩能力，方便用户在性能或容量需要改变时，改变集群资源，轻松构建企业海量数据存储系统。 实时查询。 HBase的列式KeyValue存储机制，适用于企业用户明细数据即时查询，基于主键的低时延点查，响应时延一般为秒级或毫秒级，方便用户对数据的实时分析。 HBase的架构和详细原理介绍，请参见：https://hbase.apache.org/book.html 当前CloudTable HBase暂无安全认证机制，如果需使用认证鉴权机制的HBase服务，建议使用华为云 MapReduce服务 。

集群管理功能 CloudTable服务是华为云提供的一项分布式、可扩展的KeyValue数据存储服务。CloudTable提供Web官网服务界面，CloudTable HBase集群管理的具体功能如下： 创建集群：在CloudTable服务界面完成集群的创建。支持按照用户创建集群时选择的计算单元个数、实际使用存储容量计费。用户可以自主地选择服务提供的高级特性，独立安装、独立收费。扣费时余额不足先提醒用户续费，在保留期冻结集群资源，续费后再解冻。通过计算存储分离架构和计算资源动态调整，尽可能的为用户降低成本。 扩容集群：支持集群扩容计算单元。 扩容计算单元：用户根据实际需要或业务情况，动态的增加计算单元的个数，保证读写性能。集群自适应的实现负载均衡，保证业务不中断，平滑扩容。扩容计算单元将会产生额外的费用。 管理集群：对创建的集群进行管理。 指标监控：集群运行中，收集各项监控数据，上报 云监控 （Cloud Eye），向用户以图形化的方式呈现集群运行状况。当指标出现异常时，通过 消息通知 用户和管理员，及时人工介入。 删除集群：当用户不再需要集群时，可选择删除集群。此操作为高危操作，删除集群可能导致数据丢失，因此在执行删除操作之前，请确认不存在正在运行的业务，所有数据都已经保存。 重启集群：当修改完集群HBase参数后，或者因长时间不重启导致系统运行缓慢等情况下，用户需要重启集群。重启操作将有可能会导致正在运行中的业务数据丢失，如果需要执行重启操作，请确定不存在正在运行的业务，所有数据都已经保存。 查询告警：集群运行异常或系统故障时，CloudTable服务会收集故障信息并上报网管系统，维护人员可根据用户提供的告警信息定位问题原因。 日志查询：记录用户对集群操作信息，便于集群运行异常时定位分析问题原因。

首次使用CloudTable 如果您是首次使用CloudTable的用户，建议您学习并了解如下信息： 基础知识了解 通过CloudTable产品功能章节的内容，了解CloudTable相关的基础知识，包含CloudTable各组件的基本原理和场景介绍，以及CloudTable服务的特有概念和功能的详细介绍。 入门使用 您可以参考《快速入门》学习并上手使用CloudTable。《快速入门》提供了样例的详细操作指导，您可以基于此操作指导，创建和使用CloudTable集群。 使用更多的功能，并查看其相关操作指导 如果您是一个CloudTable集群使用人员，可以参考用户指南完成集群创建、参数配置、查看告警等操作。 如果您是一个开发者，可以参考CloudTable提供的开发指南操作指导及样例工程开发并运行调测自己的应用程序。您也可以通过API调用完成CloudTable集群创建/查询操作，您可以参考《API参考》获取详情。

CloudTable权限 默认情况下，管理员创建的 IAM 用户没有任何权限，需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 CloudTable部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域（如华北-北京1）对应的项目（cn-north-1）中设置相关权限，并且该权限仅对此项目生效；如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问CloudTable时，需要先切换至授权区域。 如表1所示，包括了CloudTable的所有系统角色。由于华为云各服务之间存在业务交互关系， 表格存储服务 的角色依赖其他服务的角色实现功能。因此给用户授予 表格存储 服务的角色时，需要同时授予依赖的角色，表格存储服务的权限才能生效。 表1 CloudTable系统角色 系统角色 描述 类别 依赖关系 cloudtable Administrator 表格存储服务的管理员权限。 系统角色 依赖Tenant Guest和Server Administrator角色，在同项目中勾选依赖的角色。 表2列出了CloudTable常用操作与系统权限的授权关系，您可以参照该表选择合适的系统权限。 表2 CloudTable操作与系统策略关系 模式 操作 cloudtable Administrator 集群模式 创建集群 √ 重启集群 √ 扩容集群 √ 删除集群 √ 参数配置 √ 查看CloudTable服务集群列表、集群详细信息 √ 查看监控信息 √ 查看审计日志 √

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表4 请求Body参数 参数 是否必选 参数类型 描述 apps 是 Array of Apps objects app列表。 workspace_id 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 表5 Apps 参数 是否必选 参数类型 描述 app_id 否 String APP的编号，可通过查询APP列表获取。

响应参数 状态码： 200 表6 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪编号 表7 响应Body参数 参数 参数类型 描述 unauth_result Array of AppAuthResultInfo objects 取消授权结果。 表8 AppAuthResultInfo 参数 参数类型 描述 api_id String API的编号。 app_id String APP的编号，可通过查询APP列表获取。 auth_id String 授权编号，授权失败时为空。 reason String 授权或者取消授权失败原因，授权成功时为空。 success Boolean 授权或者取消授权是否成功。 状态码： 401 表9 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪编号 表10 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 403 表11 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪编号 表12 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应示例 状态码： 200 OK { "unauth_result" : [ { "api_id" : "logic-api-fe84e858-49ec-41c6-80d7-a34fc22435c2", "app_id" : "logic-app-9b9acb40-6df6-4623-9f87-e0dae781d867", "success" : true } ] }

URI DELETE /v1/{project_id}/services/{service_id}/app-auth-apis/{api_id}/app-auth-api 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 service_id 是 String API所属的服务ID。 api_id 是 String API编号。 表2 Query参数 参数 是否必选 参数类型 描述 workspace_id 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

URI PUT /v2/{project_id}/workflows/{workflow_id}/executions/{execution_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 workflow_id 是 String 工作流的ID。 execution_id 是 String 工作流执行ID。

响应示例 状态码： 200 OK { "created_at" : "2022-06-16T23:12:48.458022+08:00", "name" : "execution-056", "execution_id" : "fa412c98-6d94-42a2-891a-99cd1da93916", "description" : "", "status" : "stopped", "workspace_id" : "0", "workflow_id" : "f1642618-43eb-4ab1-a0b1-9cc584182c60", "workflow_name" : "workflow_model_service_no_modify_xiahou_copy", "steps_execution" : [ { "created_at" : "2022-06-16T23:12:48.466906+08:00", "uuid" : "5e8456bd-35ff-4cc9-9624-935c37dabe47", "instance_id" : "{\"model_id\":\"7d795a48-e646-43b0-b4cb-759454acaf2b\"}", "step_name" : "model_step", "step_title" : "model release", "status" : "completed", "duration" : 17, "inputs" : [ { "name" : "model_input", "type" : "obs", "data" : "$ref/data_requirements/model_input", "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/test-crq/train_output/" } } ], "outputs" : [ { "name" : "model_output", "type" : "model", "config" : { "model_id" : "7d795a48-e646-43b0-b4cb-759454acaf2b" } } ], "properties" : { "model_name" : "lh-xh", "model_type" : "TensorFlow" }, "events" : [ "2022-06-16 23:12:49 change status from init to creating", "2022-06-16 23:12:51 change status from creating to created", "2022-06-16 23:12:51 change status from created to running", "2022-06-16 23:13:05 change status from running to completed" ], "policy" : { } }, { "created_at" : "2022-06-16T23:13:05.620354+08:00", "uuid" : "9b452016-cc7b-4bfe-snt9-f9d53dcb4cc1", "step_name" : "service_step", "step_title" : "service install", "status" : "stopped", "duration" : 1, "events" : [ "2022-06-16 23:13:06 change status from init to wait_inputs", "2022-06-16 23:16:13 change status from wait_inputs to stopped" ], "policy" : { } } ], "duration" : 204, "events" : [ "2022-06-16 23:12:49 step model_step change status from init to creating", "2022-06-16 23:12:51 step model_step change status from creating to created", "2022-06-16 23:12:51 step model_step change status from created to running", "2022-06-16 23:13:05 step model_step change status from running to completed", "2022-06-16 23:13:06 step service_step change status from init to wait_inputs", "2022-06-16 23:16:13 step service_step change status from wait_inputs to stopped" ], "data_requirements" : [ { "name" : "model_input", "type" : "obs", "conditions" : [ { "attribute" : "object_type", "operator" : "equal", "value" : "directory" } ], "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/test-crq/train_output/" }, "used_steps" : [ "model_step" ] }, { "name" : "service_model", "type" : "model_list", "delay" : true, "conditions" : [ { "attribute" : "model_name", "operator" : "equal", "value" : "lh-xh" } ], "used_steps" : [ "service_step" ] } ], "parameters" : [ { "name" : "schedule_d5sm", "type" : "int", "format" : "schedule", "description" : "Set how long the deployed service will stop in hours, where -1 means the service will always run", "delay" : true, "used_steps" : [ "service_step" ] } ], "policies" : { } }

响应示例 状态码： 200 OK { "created_at" : "2021-12-14T11:34:24.541809+08:00", "workflow_id" : "a8f31367-3534-4644-a2fe-75d187341ae7", "name" : "demo_workflow", "description" : "this is a demo workflow", "user_name" : "ei_modelarts_z00424192_01", "workspace_id" : "0", "steps" : [ { "created_at" : "2021-12-14T11:34:24.545451+08:00", "name" : "model_step", "title" : "model release", "description" : "", "type" : "model", "inputs" : [ { "name" : "model_input", "type" : "obs", "data" : "$ref/data_requirements/model_input" } ], "outputs" : [ { "name" : "model_output", "type" : "model" } ], "properties" : { "model_name" : "model-name-xh", "model_type" : "TensorFlow" }, "policy" : { } }, { "created_at" : "2021-12-14T11:34:24.549514+08:00", "name" : "service_step", "title" : "service install", "description" : "", "type" : "service", "inputs" : [ { "name" : "service_input", "type" : "model_list", "data" : "$ref/data_requirements/service_model" } ], "outputs" : [ { "name" : "service_output", "type" : "service" } ], "properties" : { "infer_type" : "real-time", "schedule" : "$ref/parameters/schedule_d0MY" }, "depend_steps" : [ "model_step" ], "policy" : { } } ], "data_requirements" : [ { "name" : "model_input", "type" : "obs", "conditions" : [ { "attribute" : "object_type", "operator" : "equal", "value" : "directory" } ], "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/cwf-test/csv/" }, "used_steps" : [ "model_step" ] }, { "name" : "service_model", "type" : "model_list", "delay" : true, "conditions" : [ { "attribute" : "model_name", "operator" : "equal", "value" : "model-name-xh" } ], "used_steps" : [ "service_step" ] } ], "parameters" : [ { "name" : "schedule_1zHw", "type" : "int", "format" : "schedule", "description" : "Set how long the deployed service will stop in hours, where -1 means the service will always run", "delay" : true, "used_steps" : [ "service_step" ] } ], "policy" : { }, "last_modified_at" : "2022-05-20T14:16:40.373445+08:00" }

请求示例 更新工作流信息 PUT https://{endpoint}/v2/{project_id}/workflows/a8f31367-3534-4644-a2fe-75d187341ae7 { "parameters" : [ { "name" : "schedule_1zHw", "type" : "int", "format" : "schedule", "description" : "Set how long the deployed service will stop in hours, where -1 means the service will always run", "delay" : true, "used_steps" : [ "service_step" ] } ], "smn_switch" : true }

响应示例 状态码： 200 OK { "total" : 1, "count" : 1, "items" : [ { "created_at" : "2022-06-17T17:08:16.91019+08:00", "name" : "execution-064", "execution_id" : "918cd9bd-62dd-4179-b5f0-773dd7184a56", "description" : "", "status" : "completed", "workspace_id" : "0", "workflow_id" : "f1642618-43eb-4ab1-a0b1-9cc584182c60", "workflow_name" : "workflow_model_service_no_modify_xiahou_copy", "steps_execution" : [ { "created_at" : "2022-06-17T17:08:16.920281+08:00", "uuid" : "d6148a4a-4a5e-47a3-bc90-3183905b4941", "instance_id" : "{\"model_id\":\"253aba02-4bd6-4f64-8d37-66022ae7af4d\"}", "step_name" : "model_step", "step_title" : "model release", "status" : "completed", "duration" : 16, "inputs" : [ { "name" : "model_input", "type" : "obs", "data" : "$ref/data_requirements/model_input", "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/test-crq/train_output/" } } ], "outputs" : [ { "name" : "model_output", "type" : "model", "config" : { "model_id" : "253aba02-4bd6-4f64-8d37-66022ae7af4d" } } ], "properties" : { "model_name" : "lh-xh", "model_type" : "TensorFlow" }, "events" : [ "2022-06-17 17:08:17 change status from init to creating", "2022-06-17 17:08:19 change status from creating to created", "2022-06-17 17:08:20 change status from created to running", "2022-06-17 17:08:33 change status from running to completed" ], "policy" : { } }, { "created_at" : "2022-06-17T17:08:33.038184+08:00", "uuid" : "b34b2b54-eb70-4c7f-a92d-05f849d8c39a", "instance_id" : { "type" : "deploy", "service_id" : "81f22d60-5488-4e3d-bba9-08c812ae84b0", "status" : "", "update_time" : 0 }, "step_name" : "service_step", "step_title" : "service install", "status" : "completed", "duration" : 83430, "inputs" : [ { "name" : "service_input", "type" : "model_list", "data" : "$ref/data_requirements/service_model", "value" : { "model_list" : [ { "envs" : { }, "instance_count" : 1, "model_id" : "253aba02-4bd6-4f64-8d37-66022ae7af4d", "model_name" : "lh-xh", "model_version" : "0.0.62", "specification" : "modelarts.vm.ai1", "weight" : 100 } ] } } ], "outputs" : [ { "name" : "service_output", "type" : "service", "config" : { "service_id" : "81f22d60-5488-4e3d-bba9-08c812ae84b0" } } ], "properties" : { "infer_type" : "real-time", "schedule" : -1 }, "events" : [ "2022-06-17 17:08:34 change status from init to wait_inputs", "2022-06-18 16:16:58 change status from wait_inputs to creating", "2022-06-18 16:17:01 change status from creating to created", "2022-06-18 16:17:02 change status from created to running", "2022-06-18 16:19:03 change status from running to completed" ], "policy" : { } } ], "duration" : 11852428, "events" : [ "2022-06-17 17:08:17 step model_step change status from init to creating", "2022-06-17 17:08:19 step model_step change status from creating to created", "2022-06-17 17:08:20 step model_step change status from created to running", "2022-06-17 17:08:33 step model_step change status from running to completed", "2022-06-17 17:08:34 step service_step change status from init to wait_inputs", "2022-06-18 16:16:58 step service_step change status from wait_inputs to creating", "2022-06-18 16:17:01 step service_step change status from creating to created", "2022-06-18 16:17:02 step service_step change status from created to running", "2022-06-18 16:19:03 step service_step change status from running to completed" ], "data_requirements" : [ { "name" : "model_input", "type" : "obs", "conditions" : [ { "attribute" : "object_type", "operator" : "equal", "value" : "directory" } ], "value" : { "object_type" : [ "DIRECTORY" ], "obs_url" : "/test-crq/train_output/" }, "used_steps" : [ "model_step" ] }, { "name" : "service_model", "type" : "model_list", "delay" : true, "conditions" : [ { "attribute" : "model_name", "operator" : "equal", "value" : "lh-xh" } ], "value" : { "model_list" : [ { "envs" : { }, "instance_count" : 1, "model_id" : "253aba02-4bd6-4f64-8d37-66022ae7af4d", "model_name" : "lh-xh", "model_version" : "0.0.62", "specification" : "modelarts.vm.ai1", "weight" : 100 } ] }, "used_steps" : [ "service_step" ] } ], "parameters" : [ { "name" : "schedule_d5sm", "type" : "int", "format" : "schedule", "description" : "Set how long the deployed service will stop in hours, where -1 means the service will always run", "delay" : true, "value" : -1, "used_steps" : [ "service_step" ] } ], "policies" : { } } ] }

URI GET /v2/{project_id}/workflows/{workflow_id}/executions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 workflow_id 是 String 工作流的ID。 表2 Query参数 参数 是否必选 参数类型 描述 workspace_id 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 limit 否 String 分页参数limit，表示单次查询的条目数上限。假如要查询20~29条记录，offset为20，limit为10。 sort_by 否 String 排序依据字段，例如sort_by=create_time，则表示以条目的创建时间进行排序。 offset 否 String 分页参数offset，表示单次查询的条目偏移数量。假如要查询20~29条记录，offset为20，limit为10。 labels 否 String 执行记录标签。 status 否 String 执行记录状态。 scene_id 否 String 场景ID。 order 否 String 排序的方式。该字段必须与sort_by同时使用。 缺省值: desc 枚举值： asc：表示升序排列， desc：降序排列。

URI POST /v1/{project_id}/notebooks/{id}/start 表1 路径参数 参数 是否必选 参数类型 描述 id 是 String Notebook实例ID，可通过调用查询Notebook实例列表接口获取。 project_id 是 String 用户项目ID，获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 duration 否 Long 启动后运行时长（单位:毫秒）。 type 否 String 自动停止类别，默认为timing。 timing：自动停止。 idle：空闲停止。

响应示例 状态码： 200 OK { "description" : "api-test", "feature" : "NOTEBOOK", "flavor" : "modelarts.vm.cpu.2u", "id" : "f9937afa-4451-42db-a76b-72d624749f66", "image" : { "description" : "description", "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090", "name" : "notebook2.0-mul-kernel-cpu-cp36", "swr_path" : "swr.xxxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.2-release_v1", "tag" : "3.3.2-release_v1", "type" : "BUILD_IN" }, "lease" : { "create_at" : 1638841744515, "duration" : 6327212, "enable" : true, "type" : "TIMING", "update_at" : 1638844471727 }, "name" : "notebooks_test", "status" : "STARTING", "token" : "5cc60e8b-8772-7690-efd6-a5874ca387c0", "url" : "https://authoring-modelarts-xxxxx.xxxxx.com/f9937afa-4451-42db-a76b-72d624749f66/lab", "volume" : { "category" : "EFS", "ownership" : "MANAGED", "mount_path" : "/home/ma-user/work/", "capacity" : 50 }, "workspace_id" : "0" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 created_at 否 String 创建时间。 subscription_id 否 String 订阅ID，唯一性标识。创建订阅时，后台自动生成。 topic_urns 是 Array of strings 订阅的主题。 entity 否 String 订阅的主体。 events 否 Array of strings 订阅的事件。

请求示例 创建消息订阅。设置订阅的主题为“fengbin26”，订阅的主体为“238947895793875835893490”，订阅的事件为“[ "*:failed,completed", "job_step:stop" ]”。订阅Workflow失败、完成和job_step节点停止三个事件，发生这三个事件时，会有消息提醒。 POST https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/subscriptions { "topic_urns" : [ "fengbin26" ], "entity" : "238947895793875835893490", "events" : [ "*:failed,completed", "job_step:stop" ] }

响应示例 状态码： 201 OK { "created_at" : "2022-11-24T17:30:48.958322+08:00", "subscription_id" : "42e8a77a-512e-4d0e-a56e-4b003db82577", "topic_urns" : [ "fengbin26" ], "entity" : "238947895793875835893490", "events" : [ "*:failed,completed", "job_step:stop" ] }

响应示例 状态码： 200 OK { "arch" : "x86_64", "create_at" : 1671708630448, "description" : "", "dev_services" : [ "NOTEBOOK", "SSH" ], "id" : "708ca95d-c601-4dc7-86b9-670adfd5e818", "name" : "pytorch_1_8", "namespace" : "op_svc_modelarts_container2", "origin" : "CUSTOMIZE", "resource_categories" : [ "CPU" ], "service_type" : "UNKNOWN", "size" : 3376133259, "status" : "ACTIVE", "swr_path" : "swr.xxx.com/op_svc_modelarts_container2/pytorch_1_8:train-pytorch_1.8.0-cuda_10.2-py_3.7", "tag" : "train-pytorch_1.8.0-cuda_10.2-py_3.7", "type" : "DEDICATED", "update_at" : 1671708630448, "visibility" : "PRIVATE", "workspace_id" : "0" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 arch String 该镜像所支持处理器架构类型。枚举值如下： X86_64：x86处理器架构。 AARCH64：ARM体系架构。 create_at Long 镜像创建的时间，UTC毫秒。 description String 该镜像所对应的描述信息，长度限制512个字符。 dev_services Array of strings 镜像支持的服务。枚举值如下： NOTEBOOK：镜像支持通过https协议访问Notebook。 SSH：镜像支持本地IDE通过SSH协议远程连接Notebook。 id String 待创建Notebook实例的镜像，需要指定镜像ID，ID格式为通用唯一识别码（Universally Unique Identifier，简称UUID）。预置镜像的ID参考查询支持的镜像列表获取。 name String 镜像名称，长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 namespace String 镜像所属组织，可以在SWR控制台“组织管理”创建和查看。 origin String 指定镜像来源，可选项，默认自定义构建镜像为CUSTOMIZE。枚举值如下： CUSTOMIZE：用户自定义构建镜像。 IMAGE_SAVE：Notebook实例保存镜像。 resource_categories Array of strings 镜像支持的规格。枚举值如下： CPU GPU ASCEND service_type String 镜像支持服务类型。枚举值如下： COMMON：通用镜像。 INFERENCE: 建议仅在推理部署场景使用。 TRAIN: 建议仅在训练任务场景使用。 DEV: 建议仅在开发调测场景使用。 UNKNOWN: 未明确设置的镜像支持的服务类型。 size Long 镜像大小（单位KB）。 status String 镜像状态。枚举值如下： INIT：初始化。 CREATING：镜像保存中，此时Notebook不可用。 CREATE_FAILED：镜像保存失败。 ERROR：错误。 DELETED：已删除。 ACTIVE：镜像保存成功，保存的镜像可以在SWR控制台查看，同时可以基于保存的镜像创建Notebook实例。 status_message String 镜像保存操作过程中，构建信息展示。 support_res_categories Array of strings 镜像支持的规格。 枚举值如下： CPU GPU ASCEND swr_path String SWR镜像地址。 tag String 镜像Tag。 type String 镜像类型。枚举值如下： BUILD_IN：系统内置镜像。 DEDICATED：用户保存的镜像。 update_at Long 镜像最后更新的时间，UTC毫秒。 visibility String 镜像可见度。枚举值如下： PRIVATE：私有镜像。 PUBLIC: 所有用户可以根据ImageId来进行只读使用。 workspace_id String 工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

请求示例 注册 自定义镜像 。设置镜像支持的规格为“CPU”，支持的处理器架构类型为“X86_64”。 { "description" : "", "resource_category" : [ "CPU" ], "arch" : "X86_64", "swr_path" : "swr.xxx.com/op_svc_modelarts_container2/pytorch_1_8:train-pytorch_1.8.0-cuda_10.2-py_3.7" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 arch 否 String 该镜像所支持处理器架构类型，默认值X86_64。枚举值： X86_64：x86处理器架构。 AARCH64：ARM体系架构。 description 否 String 该镜像所对应的描述信息，长度限制512个字符。 origin 否 String 指定镜像来源，可选项，默认自定义构建镜像为CUSTOMIZE。枚举值： CUSTOMIZE: 用户自定义构建镜像。 IMAGE_SAVE：Notebook实例保存镜像。 resource_category 否 Array of strings 镜像支持的规格，默认值CPU、GPU。 枚举值如下： CPU GPU ASCEND service_type 否 String 镜像支持服务类型。枚举值如下： COMMON：通用镜像。 INFERENCE: 建议仅在推理部署场景使用。 TRAIN: 建议仅在训练任务场景使用。 DEV: 建议仅在开发调测场景使用。 UNKNOWN: 未明确设置的镜像支持的服务类型。 services 否 Array of strings 镜像支持的服务，默认值NOTEBOOK、SSH。枚举值如下: NOTEBOOK：镜像支持通过https协议访问Notebook。 SSH：镜像支持本地IDE通过SSH协议远程连接Notebook。 swr_path 是 String SWR镜像地址。 visibility 否 String 镜像可见度，默认值PRIVATE。枚举值： PRIVATE：私有镜像。 PUBLIC: 所有用户可以根据ImageId来进行只读使用。 workspace_id 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 enable_app_auth Boolean APP是否已授权。 app_auth_api AppAuthApiAuthInfo object API已授权的APP的基本信息。 表5 AppAuthApiAuthInfo 参数 参数类型 描述 api_id String API编号。 authed_apps Array of ApigAppDetailInfo objects API已授权的APP的基本信息。 表6 ApigAppDetailInfo 参数 参数类型 描述 app_codes Array of strings APP Code列表，当APP类型为APIC时，此参数为空。 app_id String APP编号。 app_key String APP的key。 app_name String APP名称。 app_remark String APP描述，默认为空。不超过200个字符。 app_secret String APP密钥。 app_type String APP类型。枚举值如下： APIC：该APP注册在roma connect网关上 APIG：该APP注册在共享API网关上 DEDICATE_APIG：该APP注册在专享API网关上 bounded_api_count Integer APP绑定API数量。 created_at Long APP创建时间。 project_id String 项目ID。 updated_at Long APP更新时间。 user_id String APP创建用户ID。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应示例 状态码： 200 OK { "enable_app_auth" : true, "app_auth_api" : { "api_id" : "string", "authed_apps" : [ { "app_codes" : [ "1f5f6cb703864cc580d1ba2cdfd77a271a74eee8e5a242e8b5adc009f77a8b2a" ], "app_id" : "54d9104db9e7418f9138980da63a857f", "app_key" : "151f1f4dfb20445b97326bde3db0c515", "app_name" : "app_for_9332aab245ea4d56871e75d6966aa274", "app_remark" : "app for user op_svc_modelarts_container0", "app_secret" : "0080fa74e6214d0c8d1b2cb01d9d7708", "app_type" : "APIG", "bounded_api_count" : 0, "created_at" : 1574946998167, "project_id" : "string", "updated_at" : 1574946998167, "user_id" : "9332aab245ea4d56871e75d6966aa274" } ] } }

URI GET /v1/{project_id}/services/{service_id}/api-auths 表1 路径参数 参数 是否必选 参数类型 描述 service_id 是 String 服务ID project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 workspace_id 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

URI DELETE /v1/{project_id}/app-auth/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String APP编号，可通过APP列表接口获取。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 workspace_id 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。