华为云用户手册

URI GET /v1/{project_id}/services/specifications 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 is_personal_cluster 否 Boolean 是否查询专属资源池支持的服务部署规格列表，默认为false。 infer_type 否 String 推理方式，枚举值如下： real-time：在线服务，默认值 batch：批量服务 edge: 边缘服务 limit 否 String 指定每一页返回的最大条目数，默认为1000。 offset 否 String 返回数据的起始偏移量，默认为0。

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

响应示例 状态码： 200 查询训练作业镜像保存任务成功 { "name" : "imagesave", "namespace" : "dev", "tag" : 0.1, "description" : "hello world!", "status" : "ACTIVE", "message" : "building", "create_time" : 1686718209968 }

URI GET /v2/{project_id}/training-jobs/{training_job_id}/tasks/{task_id}/save-image-job 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 training_job_id 是 String 训练作业ID。获取方法请参见查询训练作业列表。 task_id 是 String 训练作业的任务名称。可从训练作业详情中的status.tasks字段中获取。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 name String 镜像名称，长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 namespace String 镜像所属组织，可以在SWR控制台“组织管理”创建和查看。 tag String 镜像tag，长度限制64个字符， 支持大小写字母、数字、中划线、下划线和点。 description String 该镜像所对应的描述信息，长度限制512个字符。 status String 镜像状态。枚举值如下： INIT：初始化。 CREATING：镜像保存中，此时训练作业不可用。 CREATE_FAILED：镜像保存失败。 ACTIVE：镜像保存成功，保存的镜像可以在SWR控制台查看，同时可以基于保存的镜像创建训练作业。 message String 镜像创建的时间，UTC毫秒。 create_time Long 镜像保存操作过程中，展示构建信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 changed_property 是 String 属性名称，目前只支持instance_count(更新模型服务实例数量)。 configs 否 Array of UpdateServiceConfig objects 服务配置。 表4 UpdateServiceConfig 参数 是否必选 参数类型 描述 changed_value 是 String 属性值，只支持整数，changed_property属性值为"instance_count"时，该值必须大于或小于当前实例数。 model_id 是 String 模型ID。

响应参数 状态码： 200 表5 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪ID。 表6 响应Body参数 参数 参数类型 描述 update_time String 本次更新时间，仅触发服务配置升级时会返回，比如修改config参数，可根据此时间从服务更新记录中过滤出此次的更新结果；修改描述或启停服务不会返回此参数。 resource_ids String 更新的资源ID。 状态码： 401 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪ID。 表8 响应Body参数 参数 参数类型 描述 error_code String 服务内部错误码。 error_msg String 错误信息。

请求示例 更新模型服务单个属性。 PUT https://{endpoint}/v1/{project_id}/services/{service_id}/property { "changed_property" : "instance_count", "configs" : [ { "model_id" : "98240f41-6c69-437c-b894-9c488b1d9c43", "changed_value" : 2 } ] }

URI DELETE /v2/{project_id}/workflows/{workflow_id}/schedules/{schedule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 workflow_id 是 String 工作流的ID。 schedule_id 是 String 工作流调度信息ID。

响应示例 状态码： 201 OK { "created_at" : "2022-11-01T21:36:04.264564372+08:00", "name" : "execution-065", "execution_id" : "46c682b6-0310-4774-9c8e-62d7fb7e0b55", "description" : "", "workspace_id" : "0", "workflow_id" : "f1642618-43eb-4ab1-a0b1-9cc584182c60", "workflow_name" : "workflow_model_service_no_modify_xiahou_copy", "steps_execution" : null, "duration" : 0, "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" : { } }

请求示例 创建训练作业标签。设置TMS标签的key/value为“111”和“k3”，TMS标签的key/value为"k3"和“v2”。 POST https://endpoint/v2/{project_id }/trainJob/{training_job_id}/tags/create { "tags" : [ { "key" : "111", "value" : "v2" }, { "key" : "k3", "value" : "v2" } ] }

响应示例 状态码： 200 ok { "total" : 20, "items" : [ { "engine_id" : "caffe-1.0.0-python2.7", "engine_name" : "Caffe", "engine_version" : "caffe-1.0.0-python2.7", "v1_compatible" : true, "run_user" : "", "image_info" : { "cpu_image_url" : "modelarts-job-dev-image/caffe1-cpu-cp27:1.0.0", "gpu_image_url" : "modelarts-job-dev-image/caffe1-gpu-cuda8-cp27:1.0.0", "image_version" : "3.1.0" } }, { "engine_id" : "horovod-cp36-tf-1.16.2", "engine_name" : "Horovod", "engine_version" : "0.16.2-TF-1.13.1-python3.6", "v1_compatible" : true, "run_user" : "", "image_info" : { "cpu_image_url" : "modelarts-job-dev-image/tensorflow-gpu-cuda10-cp36-horovod0162:1.13.1", "gpu_image_url" : "modelarts-job-dev-image/tensorflow-gpu-cuda10-cp36-horovod0162:1.13.1", "image_version" : "3.2.1" } }, { "engine_id" : "horovod_0.20.0-tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64", "engine_name" : "Horovod", "engine_version" : "horovod_0.20.0-tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64", "v1_compatible" : false, "run_user" : "1102", "image_info" : { "cpu_image_url" : "aip/horovod_tensorflow:train", "gpu_image_url" : "aip/horovod_tensorflow:train", "image_version" : "horovod_0.20.0-tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64-20210912152543-1e0838d" } }, "......", { "engine_id" : "tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64", "engine_name" : "TensorFlow", "engine_version" : "tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64", "v1_compatible" : false, "run_user" : "1102", "image_info" : { "cpu_image_url" : "aip/tensorflow_2_1:train", "gpu_image_url" : "aip/tensorflow_2_1:train", "image_version" : "tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64-20210912152543-1e0838d" } }, { "engine_id" : "xgboost-sklearn-python3.6", "engine_name" : "XGBoost-Sklearn", "engine_version" : "XGBoost-0.80-Sklearn-0.18.1-python3.6", "v1_compatible" : true, "run_user" : "", "image_info" : { "cpu_image_url" : "modelarts-job-dev-image/python-train-py36:secure", "gpu_image_url" : "", "image_version" : "2.0.10-20211101113705" } } ] }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 total Integer 训练作业引擎规格总数。 items Array of items objects 引擎规格参数列表。 表3 items 参数 参数类型 描述 engine_id String 引擎规格的ID。如“caffe-1.0.0-python2.7”。 engine_name String 引擎规格的名称。如“Caffe”。 engine_version String 引擎规格的版本。对一个引擎名称，有多个版本的引擎，如使用python2.7的"Caffe-1.0.0-python2.7"等。 v1_compatible Boolean 是否为v1兼容模式。 run_user String 引擎默认启动用户uid。 image_info image_info object 引擎具体信息。 表4 image_info 参数 参数类型 描述 cpu_image_url String cpu规格下对应镜像。 gpu_image_url String gpu或者Ascend规格下对应镜像。 image_version String 镜像版本。

响应示例 状态码： 400 Bad Request。 { "error_code" : "ModelArts.50004000", "error_msg" : "Bad request." } 状态码： 404 Not Found。 { "error_code" : "ModelArts.50015001", "error_msg" : "Pool {name} not found." }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 statistics statistics object 作业的统计信息。 表3 statistics 参数 参数类型 描述 total Integer 统计信息列表数量。 items Array of WorkloadStatistics objects 特定作业类型统计信息。 表4 WorkloadStatistics 参数 参数类型 描述 type String 作业类型。可选值如下： train：训练作业 infer：推理作业 notebook：Notebook作业 total Integer 作业个数。 status status object 不同状态下作业个数。 表5 status 参数 参数类型 描述 Queue Integer 排队中的作业个数。 Pending Integer 等待中的作业个数。 Abnormal Integer 异常的作业个数。 Terminating Integer 终止中的作业个数。 Creating Integer 创建中的作业个数。 Running Integer 运行中的作业个数。 Completed Integer 已完成的作业个数。 Terminated Integer 已终止的作业个数。 Failed Integer 运行失败的作业个数。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 api AuthTypeApiBasicInfo object API认证详情。 表5 AuthTypeApiBasicInfo 参数 参数类型 描述 api_id String API编号。 api_method String 请求方式包含GET、POST、PUT、DELETE、HEAD、PATCH、OPTIONS、ANY，固定返回ANY。 api_name String API名称。 api_remark String API描述。字符长度不超过255。 auth_type String API的认证方式。枚举值如下： NONE：无认证 APP：APP认证 IAM ：IAM认证 predict_url String 预测地址。 service_id String 服务编号。 service_name String 服务名称。 support_app_code Boolean 是否支持APP CODE。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

请求示例 POST https://{endpoint}/v1/{project_id}/app-auth/{service_id}/apis { "workspace_id" : "0", "support_app_code" : true, "auth_type" : "APIG", "api_name" : "app_test", "api_url" : "https://d566c7efafe04a26a83d3a8475602ee3.apig.xxxxxx.com/v1/infers/456963f1-737c-4de0-8bee-5b4f6f3a8fa3", "api_path" : "/v1/infers/456963f1-737c-4de0-8bee-5b4f6f3a8fa3", "api_method" : "GET", "api_remark" : "test" }

响应示例 状态码： 200 OK { "api" : { "api_id" : "7e0d272df0e94297b7d4046bada3f158", "api_name" : "infer_ae20fc9fb37c48c28ebc3f3a638c9f48", "api_method" : "ANY", "predict_url" : "https://b86b2d069324491fbd66940e4533b45c.apig.xxxxxx.com/v1/infers/ae20fc9f-b37c-48c2-8ebc-3f3a638c9f48", "support_app_code" : true, "service_id" : "ae20fc9f-b37c-48c2-8ebc-3f3a638c9f48", "service_name" : "service-3c02", "auth_type" : "APP", "api_remark" : "test" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 workspace_id 否 String 工作空间id。 support_app_code 否 Boolean 是否支持APP CODE。 auth_type 否 String API的认证方式。 枚举值如下： NONE：无认证 APP：APP认证 IAM：IAM认证 api_name 否 String API名称。 api_url 否 String API的URL。字符长度不超过255。 api_path 否 String API的PATH。字符长度不超过255。 api_method 否 String 请求方式包含GET、POST、PUT、DELETE、HEAD、PATCH、OPTIONS、ANY，固定返回ANY。 api_remark 否 String API描述。字符长度不超过255。

响应示例 状态码： 201 create image save job successfully { "name" : "imagesave", "namespace" : "dev", "tag" : 0.1, "description" : "hello world!", "status" : "ACTIVE", "message" : "building", "create_time" : 1686718209968 }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 镜像名称，长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 namespace 否 String 镜像所属组织，可以在SWR控制台“组织管理”创建和查看。 tag 否 String 镜像tag，长度限制64个字符， 支持大小写字母、数字、中划线、下划线和点。 description 否 String 该镜像所对应的描述信息，长度限制512个字符。

请求示例 如下以创建uuid为2cd88daa-31a4-40a8-a58f-d186b0e93e4f的训练作业对应worker-0镜像保存任务为例。 POST https://endpoint/v2/{project_id}/training-jobs/2cd88daa-31a4-40a8-a58f-d186b0e93e4f/tasks/worker-0/save-image-job { "name" : "imagesave", "namespace" : "dev", "tag" : 0.1, "description" : "hello world!" }

响应参数 状态码： 201 表3 响应Body参数 参数 参数类型 描述 name String 镜像名称，长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 namespace String 镜像所属组织，可以在SWR控制台“组织管理”创建和查看。 tag String 镜像tag，长度限制64个字符， 支持大小写字母、数字、中划线、下划线和点。 description String 该镜像所对应的描述信息，长度限制512个字符。 status String 镜像状态。枚举值如下： INIT：初始化。 CREATING：镜像保存中，此时训练作业不可用。 CREATE_FAILED：镜像保存失败。 ACTIVE：镜像保存成功，保存的镜像可以在SWR控制台查看，同时可以基于保存的镜像创建训练作业。 message String 镜像创建的时间，UTC毫秒。 create_time Long 镜像保存操作过程中，展示构建信息。

URI POST /v2/{project_id}/training-jobs/{training_job_id}/tasks/{task_id}/save-image-job 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 training_job_id 是 String 训练作业ID。获取方法请参见查询训练作业列表。 task_id 是 String 训练作业的任务名称。可从训练作业详情中的status.tasks字段中获取。

URI DELETE /v1/{project_id}/notebooks/{instance_id}/storage/{storage_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String Notebook实例ID，可通过调用查询Notebook实例列表接口获取。 project_id 是 String 用户项目ID，获取方法请参见获取项目ID和名称。 storage_id 是 String OBS存储ID。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 category String 存储类型。可选值为OBS。 id String 动态挂载实例ID。 mount_path String 在Notebook实例中挂载的路径。 status String 动态挂载OBS状态。枚举值如下： MOUNTING：挂载中 MOUNT_FAILED：挂载失败 MOUNTED：已挂载 UNMOUNTING：卸载中 UNMOUNT_FAILED：卸载失败 UNMOUNTED：卸载完成 uri String OBS对象路径。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 tags Array of CombineTmsTags objects 标签的融合结构，相同key合并。 表3 CombineTmsTags 参数 参数类型 描述 key String 标签的key。 values Array of strings 相同key的标签value合并后的列表。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应示例 状态码： 400 Bad Request。 { "error_code" : "ModelArts.50004000", "error_msg" : "Bad request." } 状态码： 404 Not Found。 { "error_code" : "ModelArts.50015001", "error_msg" : "Pool {name} not found." }

URI GET /v2/{project_id}/pools/{pool_name}/workloads 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 pool_name 是 String 作业所属的命名空间。 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String 作业所属业务。可选值如下： train：训练作业 infer：推理服务 notebook：Notebook作业 status 否 String 作业状态。可选值如下： Queue：排队中 Pending：等待中 Abnormal：异常 Terminating：中止中 Creating：创建中 Running：运行中 Completed：已完成 Terminated：已终止 Failed：运行失败 sort 否 String 排序依据字段。可选值： create_time：根据作业创建时间排序 ascend 否 Boolean 是否按照升序排序。 offset 否 String 分页查询，起始位置。 limit 否 Integer 单页查询最大数量，值为空或者0时默认为500，最大值为500。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 apiVersion String API版本。可选值如下： v1 kind String 资源类型。可选值如下： WorkloadList：作业列表 items Array of Workload objects 作业列表。 表4 Workload 参数 参数类型 描述 apiVersion String 资源版本。可选值如下： v1 kind String 资源类型，可选值如下： Workload type String 作业所属业务类型。可选值如下： train：训练作业 namespace String 作业所属资源池名称。 name String 作业名称。 jobName String 上层业务作业名称。 uid String 作业uid。 jobUUID String 上层业务作业id。 flavor String 作业规格。 status String 作业状态。 resourceRequirement resourceRequirement object 运行作业的资源请求量。 priority String 作业优先级。 runningDuration Integer 作业运行时长。 pendingDuration Integer 作业排队时长。 pendingPosition Integer 作业排队位置。 createTime Integer 作业创建时间。 gvk String 作业的k8s资源类型、分组和版本。 hostIps String 作业运行的节点IP列表，逗号分隔。 表5 resourceRequirement 参数 参数类型 描述 cpu String CPU使用量。 memory String 内存使用量。 nvidia.com/gpu String GPU资源使用量。 huawei.com/ascend-snt3 String 昇腾资源使用量。 huawei.com/ascend-snt9 String 昇腾资源使用量。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。