华为云用户手册

请求示例 更新调度信息 PUT https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/schedules/fa4ac58e-088b-4fd7-ae8c-b36fee50f884 { "content" : { "cron" : "0 0 0 * * Thu,Tue", "method" : "fixed" }, "enable" : true }

响应示例 状态码： 200 OK { "total" : 5, "items" : [ { "time" : "2022-10-28T15:31:43.409368+08:00", "duration" : 366181, "workflow_id" : "bd711470-e00f-422a-8da4-8a7fa06f4b8c", "workflow_name" : "wf-test-service-xiahou", "execution_id" : "837f989e-ff44-4089-90f5-ec6d790d339d", "step_name" : "service_step", "step_title" : "install service", "status" : "wait_inputs" }, { "time" : "2022-10-28T15:31:28.753908+08:00", "duration" : 366196, "workflow_id" : "acf1a43e-3037-4e97-8438-d21fe38d31dd", "workflow_name" : "workflow-service-infer2", "execution_id" : "2d235b72-c9e2-4277-9a10-b826746d38e7", "step_name" : "service_step", "step_title" : "service_step", "status" : "wait_inputs" }, { "time" : "2022-10-27T15:01:33.644611+08:00", "duration" : 454391, "workflow_id" : "79232863-7d4c-4e36-af8a-b4030da7b525", "workflow_name" : "MAssist_checkpoint_url_beta2_4dc3a098-2687-400a-a621-11fe1ff6542", "execution_id" : "2d2affa3-892f-4b2f-87de-a22f8b8d018a", "step_name" : "condition_step", "step_title" : "skip training", "status" : "wait_inputs" }, { "time" : "2022-10-20T15:01:42.650076+08:00", "duration" : 1059182, "workflow_id" : "b94d87ad-ccc3-4d7a-ac3e-a4907ccf8247", "workflow_name" : "MAssist_checkpoint_url2_c508a2ac-e146-42dd-8e5b-249dc4a117ee", "execution_id" : "0f2bb91c-3a60-49bd-a32e-190797d90ebd", "step_name" : "condition_step_test", "step_title" : "condition_step_test", "status" : "wait_inputs" }, { "time" : "2022-10-20T14:53:13.05412+08:00", "duration" : 1059692, "workflow_id" : "e6d01c2e-0ff7-42ea-a0da-363660b730bd", "workflow_name" : "MAssist_checkpoint_url3_2086aa8f-09b7-4dae-b262-642d0d80519e", "execution_id" : "2aa33bf2-7ddb-4401-adb9-627952a282e9", "step_name" : "labeling", "step_title" : "data labeling", "status" : "hold" } ] }

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 items Array of WorkflowTodo objects 待办列表。 total Integer 条目个数。 表4 WorkflowTodo 参数 参数类型 描述 time String 时间。 duration Integer 运行时长。 workflow_id String Workflow工作流ID。 workflow_name String 工作流名称。填写1-64位，仅包含英文、数字、下划线（_）和中划线（-），并且以英文开头的名称。 execution_id String 工作流执行ID。 step_name String 节点名称。 step_title String 节点的Title。 status String 状态。

响应示例 状态码： 200 OK { "total" : 1, "count" : 1, "items" : [ { "created_at" : "2022-09-09T11:28:29.639658+08:00", "workflow_id" : "6b596c75-fe1f-440b-be83-fe5e240133c4", "name" : "graph-test-has-condition-step", "description" : "", "user_name" : "zuoping", "workspace_id" : "0", "labels" : [ "subgraph" ], "data" : [ { "name" : "a2ff296da618452daa8243399f06db8e", "type" : "obs", "value" : { "obs_url" : "/test-lh/test-metrics/" }, "used_steps" : [ "training_job1" ] }, { "name" : "f78e46676a454ccdacb9907f589f8d67", "type" : "obs", "value" : { "obs_url" : "/test-lh/test-metrics/" }, "used_steps" : [ "training_job2" ] }, { "name" : "dee65054c96b4bf3b7ac98c0709f9ae0", "type" : "obs", "value" : { "obs_url" : "/test-lh/test-metrics/" }, "used_steps" : [ "training_job3" ] } ], "parameters" : [ { "name" : "is_true", "type" : "bool", "delay" : true, "value" : true, "used_steps" : [ "condition_step_test" ] }, { "name" : "train_spec", "type" : "str", "format" : "flavor", "description" : "training specification", "default" : "modelarts.vm.cpu.8u", "used_steps" : [ "training_job1", "training_job2", "training_job3" ] }, { "name" : "service_config1", "type" : "str", "default" : "/test-lh/test-metrics/metrics.json", "used_steps" : [ "training_job1" ] }, { "name" : "service_config2", "type" : "str", "default" : "/test-lh/test-metrics/metrics.json", "used_steps" : [ "training_job2" ] }, { "name" : "service_config3", "type" : "str", "default" : "/test-lh/test-metrics/metrics.json", "used_steps" : [ "training_job3" ] } ], "sub_graphs" : [ { "name" : "stage_A", "steps" : [ "training_job1", "training_job2" ] } ], "policy" : { }, "last_modified_at" : "2022-10-28T16:49:13.056726+08:00", "source_workflow_id" : "05427e9d-42ac-4816-bd45-360c1bfd780b", "latest_execution" : { "execution_id" : "43e317e2-34b0-4348-9c1b-08d3083512e1", "created_at" : "2022-10-28T16:49:03.894771+08:00", "status" : "completed", "duration" : 209 }, "run_count" : 2, "param_ready" : true } ] }

URI GET /v2/{project_id}/workflows 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 工作流名称。 description 否 String 工作流描述信息。 status 否 String 工作流状态。 labels 否 String 工作流标签。 template_id 否 String 工作流模板ID。 limit 否 String 分页参数limit，表示单次查询的条目数上限。假如要查询20~29条记录，offset为20，limit为10。 offset 否 String 分页参数offset，表示单次查询的条目偏移数量。假如要查询20~29条记录，offset为20，limit为10。 sort_by 否 String 排序依据字段，例如sort_by=create_time，则表示以条目的创建时间进行排序。 search_type 否 String 过滤方式。可选值如下： equal表示精确匹配。 contain表示模糊匹配。 具体过滤的字段，由各个接口额外定义参数。例如Workflow支持按照名称（name）进行过滤，则相应的过滤字段为name。name=workflow&search_type=contain表示查询名称中含有Workflow字样的所有工作流。

响应示例 状态码： 200 创建工作空间成功的响应参数。 { "id" : "**d05d1a553b4e188ea878e7dcb85e**", "name" : "test-workspace", "description" : "It is a test project'", "owner" : "testUser", "create_time" : 1470000020000, "update_time" : 1470000030000, "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", "enterprise_project_name" : "test-eps", "auth_type" : "public", "status" : "NORMAL", "status_info" : "" }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 owner String 创建者名称。 auth_type String 授权类型。默认值为PUBLIC。PUBLIC：租户内部公开访问。PRIVATE：仅创建者和主账号可访问。INTERNAL：创建者、主账号、指定 IAM 子账号可访问，需要与grants参数配合使用。 enterprise_project_id String 企业项目ID。 update_time Integer 最后修改时间，UTC。 create_time Integer 创建时间，UTC。 enterprise_project_name String 企业项目名称。 name String 工作空间名称。 description String 工作空间描述。 id String 工作空间ID，系统生成的32位UUID，不带橫线。 status String 工作空间状态。 CREATE_FAILED：创建失败。 NORMAL：状态正常。 DELETING：正在删除。 DELETE_FAILED：删除失败。 status_info String 状态描述，默认为空。该字段会补充显示状态的详细信息。如删除失败时，可通过该字段查看删除失败的原因。 grants Array of grants objects 授权用户列表。默认为空。需要与“auth_type”参数配合使用，且仅当授权类型为“INTERNAL”时才会生效。 表6 grants 参数 参数类型 描述 user_id String 用户ID,此参数与user_name必填一个。两者都填优先使用user_id。 user_name String IAM用户名称。此参数与user_id必填一个。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 - String 状态码： 403 表8 响应Body参数 参数 参数类型 描述 - String 状态码： 500 表9 响应Body参数 参数 参数类型 描述 - String

请求示例 创建工作空间。设置工作空间名称为“test-workspace”，授权类型为“internal”，授权的IAM用户名称为“test”。 POST https://{endpoint}/v1/{project_id}/workspaces { "name" : "test-workspace", "description" : "It is a test project", "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", "auth_type" : "internal", "grants" : [ { "user_name" : "test" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 grants 否 Array of grants objects 授权用户列表，默认为空。需要与“auth_type”参数配合使用，且仅当授权类型为“INTERNAL”时才会生效。 auth_type 否 String 授权类型。可选值有PUBLIC、PRIVATE、INTERNAL。默认值为PUBLIC。 PUBLIC：租户内部公开访问。 PRIVATE：仅创建者和主账号可访问。 INTERNAL：创建者、主账号、指定IAM子账号可访问，需要与grants参数配合使用。 enterprise_project_id 否 String 企业项目ID。 name 是 String 工作空间名称。长度限制为4-64字符，支持中文、大小写字母、数字、中划线和下划线。同时'default'为系统预留的默认工作空间名称，用户无法自己创建名为'default'的工作空间。 description 否 String 工作空间描述，默认为空。长度限制为0-256字符。 表4 grants 参数 是否必选 参数类型 描述 user_id 否 String IAM用户ID。此参数与user_name必填一个。两者都填优先使用user_id。 user_name 否 String IAM用户名称。此参数与user_id必填一个。

响应示例 状态码： 200 OK { "charging_mode" : "POST_PAID", "cloud_server" : { "type" : "E CS " }, "create_at" : 1699348284990, "flavor" : "Si2.large.4", "id" : "62383738-e52a-450a-9f84-f9e705402be8", "image" : { "arch" : "X86", "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7", "name" : "Ubuntu18.04_x86_64_CPU", "server_type" : "ECS" }, "name" : "EI-evs-1107", "status" : "DELETING", "update_at" : 1699348285077 }

响应示例 状态码： 200 OK { "create_at" : 1638841805440, "description" : "update", "feature" : "DEFAULT", "flavor" : "modelarts.vm.cpu.free", "id" : "f9937afa-ca78-45b6-bc12-7ecf42553c48", "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" : 1638841805439, "duration" : 3600000, "enable" : true, "update_at" : 1638841805439 }, "name" : "notebook_5ee4bf0e", "status" : "DELETING", "token" : "58ba50c6-e8ff-245c-4840-49e51aa70737", "update_at" : 1638842504178, "workspace_id" : "0" }

响应示例 状态码： 200 OK { "current" : 0, "data" : [ { "description" : "api-test", "feature" : "DEFAULT", "flavor" : "modelarts.vm.cpu.free", "id" : "f9937afa-ca78-45b6-bc12-7ecf42553c48", "image" : { "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", "type" : "BUILD_IN" }, "lease" : { "create_at" : 1638841805439, "duration" : 3600000, "enable" : true, "update_at" : 1638841805439 }, "name" : "notebook_5ee4bf0e", "status" : "CREATING", "token" : "58ba50c6-e8ff-245c-4840-49e51aa70737", "volume" : { "category" : "EVS", "ownership" : "MANAGED", "mount_path" : "/home/ma-user/work/", "capacity" : 50 }, "workspace_id" : "0" }, { "description" : "api-test", "feature" : "NOTEBOOK", "flavor" : "modelarts.vm.cpu.2u", "id" : "f9937afa-4451-42db-a76b-72d624749f66", "image" : { "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", "type" : "BUILD_IN" }, "lease" : { "create_at" : 1638841744515, "duration" : 3600000, "enable" : true, "update_at" : 1638841744515 }, "name" : "notebooks_test", "status" : "CREATING", "token" : "3eff13f2-3d70-5456-6dc7-e3f99f562022", "volume" : { "category" : "EVS", "ownership" : "MANAGED", "mount_path" : "/home/ma-user/work/", "capacity" : 50 }, "workspace_id" : "0" } ], "pages" : 1, "size" : 10, "total" : 2 }

URI GET /v1/{project_id}/notebooks/all 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 feature 否 String 实例类别，默认为NOTEBOOK。枚举值如下： DEFAULT：CodeLab免费规格实例，每个用户最多只能创建一个。 NOTEBOOK：计费规格实例。 limit 否 Integer 每一页的数量，默认值10。 name 否 String 实例名称，支持模糊匹配查询。限制128个字符，支持大小写字母、数字、中划线和下划线。 pool_id 否 String 专属资源池ID，获取方法请参见查询资源池列表。 offset 否 Integer 分页记录的起始位置偏移量，默认值0。 owner 否 String 实例归属的User Id，长度为32位小写字母、数字，在主账号/有admin权限场景下生效，值通常为当前登录用户ID。 sort_dir 否 String 排序方式，ASC升序，DESC降序，默认DESC。 sort_key 否 String 排序的字段，多个字段使用(“,”)逗号分割。 status 否 String 实例状态。枚举值如下： INIT：初始化 CREATING：创建中 STARTING：启动中 STOPPING：停止中 DELETING：删除中 RUNNING：运行中 STOPPED：已停止 SNAPSHOTTING：快照中(保存镜像时的状态) CREATE_FAILED：创建失败 START_FAILED：启动失败 DELETE_FAILED：删除失败 ERROR：错误 DELETED：已删除 FROZEN：冻结 workspaceId 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

响应示例 状态码： 200 删除成功或者失败的提示信息。 { "delete_success_list" : [ "10eb0091-887f-4839-9929-cbc884f1e20e" ], "delete_failed_list" : [ { "error_msg" : "Failed to delete model, model（759645d9-3672-4db1-bb6d-49ed58b84e10) already deploy service.", "error_code" : "ModelArts.3009", "model_id" : "e527d311-a947-46da-a6e0-66c49945dfaa" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 delete_success_list Array of strings 删除成功的模型id列表。 delete_failed_list Array of DeleteModelResponseFailedList objects 删除失败的模型id及其失败原因列表。 表5 DeleteModelResponseFailedList 参数 参数类型 描述 error_msg String 删除该模型失败的错误提示信息。 error_code String 删除该模型失败的错误码。 model_id String 删除失败的模型id。

URI DELETE /v1/{project_id}/models/{model_id} 表1 路径参数 参数 是否必选 参数类型 描述 model_id 是 String 需要删除的AI应用ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 cascade 否 Boolean 是否级联删除。默认为false，只删除当前模型ID所对应的模型。取值为true时除了删除模型ID指定的模型，还会删除与指定模型同名不同版本的所有模型。一次最多删除20个模型，超过的模型不删除。

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪ID。 表4 响应Body参数 参数 参数类型 描述 dns_domain_name String 页面调用指南展示的访问 域名 ，可用于添加内网DNS解析。 vpcep_info Array of InternalChannelDetail objects 检索到的VPC访问通道信息。 表5 InternalChannelDetail 参数 参数类型 描述 vpcep_service_id String VPC访问通道vpcep终端节点服务ID。 vpcep_service_name String VPC访问通道vpcep终端节点服务名称。 service_port Integer VPC访问通道的端口。 状态码： 401 表6 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪ID 表7 响应Body参数 参数 参数类型 描述 error_code String 服务内部错误码。 error_msg String 错误信息。

响应示例 状态码： 200 获取推理VPC访问通道信息。 { "dns_domain_name" : "xxx.xxx.com", "vpcep_info" : [ { "vpcep_service_id" : "2275xxxx-c96f-4xxx-820c-c7xxxxxa7899", "vpcep_service_name" : "cn-nxxxx-x.vpcepname.2275xxxx-c96f-4xxx-820c-c7xxxxxa7899", "service_port" : 443 } ] } 状态码： 401 鉴权失败 { "error_code" : "ModelArts.0203", "error_msg" : "Invalid token." }

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

响应示例 状态码： 200 ok { "obs_url" : "http://10.155.101.248:20000/cnnorth4-test/xk/00chess_test/test11/logs/modelarts-job-0f2ccdbb-4f34-4d53-afb9-d526f3be8c68-ma-platform-init-worker-0-172.16.24.51-01909681.log?AWSAccessKeyId=xxxxx" }

请求示例 如下以查询uuid为2cd88daa-31a4-40a8-a58f-d186b0e93e4f的训练作业对应work-0日志OBS临时链接为例。 GET https://endpoint/v2/{project_id}/training-jobs/2cd88daa-31a4-40a8-a58f-d186b0e93e4f/tasks/worker-0/logs/url?Content-Type=text/plain

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

响应示例 状态码： 200 OK { "current" : 4, "data" : [ { "arch" : "x86_64", "create_at" : 1638841805439, "description" : "AI inference application development, preconfigured ModelBox and AI engine LibTorch, only SSH connection supported.", "dev_services" : [ "AI_FLOW", "SSH" ], "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54103", "name" : "modelbox1.3.0-libtorch1.9.1-cuda10.2-cudnn8-euler2.9.6", "resource_categories" : [ "GPU" ], "service_type" : "TRAIN", "status" : "ACTIVE", "swr_path" : "swr.xxx.com/atelier/modelarts-modelbox-libtorch-gpu-x86:1.3.0-20221027202714-160a680", "tag" : "1.3.0-20221027202714-160a680", "type" : "BUILD_IN", "update_at" : 1638234504492, "workspace_id" : "0" }, { "arch" : "x86_64", "create_at" : 1638841805439, "description" : "CPU and GPU general algorithm development and training, preconfigured with AI engine PyTorch1.8", "dev_services" : [ "NOTEBOOK", "SSH" ], "id" : "278e88d1-5b71-4766-8502-b3ba72e824d9", "name" : "pytorch1.8-cuda10.2-cudnn7-ubuntu18.04", "resource_categories" : [ "GPU", "CPU" ], "service_type" : "COMMON", "status" : "ACTIVE", "swr_path" : "swr.xxx.com/atelier/pytorch_1_8:pytorch_1.8.0-cuda_10.2-py_3.7-ubuntu_18.04-x86_64-20220926104358-041ba2e", "tag" : "pytorch_1.8.0-cuda_10.2-py_3.7-ubuntu_18.04-x86_64-20220926104358-041ba2e", "type" : "BUILD_IN", "update_at" : 1638234504492, "workspace_id" : "0" } ], "pages" : 54, "size" : 2, "total" : 107 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 current Integer 当前页数。 data Array of ImageResponse objects 数据。 pages Integer 总的页数。 size Integer 每一页的数量。 total Long 总的记录数量。 表4 ImageResponse 参数 参数类型 描述 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 镜像保存操作过程中，构建信息展示。 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”，存在创建并使用的工作空间，以实际取值为准。

URI GET /v1/{project_id}/images 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 每一页的数量，默认值200。 name 否 String 镜像名称，长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 name_fuzzy_match 否 Boolean 镜像名称是否模糊匹配，默认为true。 namespace 否 String 镜像所属组织，可以在SWR控制台“组织管理”创建和查看。 offset 否 Integer 分页记录的起始位置偏移量，默认值0。 service_type 否 String 镜像支持服务类型。枚举值如下： COMMON：通用镜像。 INFERENCE: 建议仅在推理部署场景使用。 TRAIN: 建议仅在训练任务场景使用。 DEV: 建议仅在开发调测场景使用。 UNKNOWN: 未明确设置的镜像支持的服务类型。 sort_dir 否 String 排序方式，ASC升序，DESC降序，默认DESC。 sort_key 否 String 排序的字段，多个字段使用(“,”)逗号分割。 type 否 String 镜像类型。枚举值如下： BUILD_IN：系统内置镜像。 DEDICATED：用户保存的镜像。 workspace_id 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

URI GET /v1/{project_id}/resourceflavors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 continue 否 String 分页查询时上一页位置。 labelSelector 否 String 标签筛选。 limit 否 Integer 分页数目。

响应示例 状态码： 200 OK。 { "kind" : "ResourceFlavorList", "apiVersion" : "v1", "metadata" : { }, "items" : [ { "kind" : "ResourceFlavor", "apiVersion" : "v1", "metadata" : { "name" : "modelarts.vm.cpu8u32g", "labels" : { } }, "spec" : { "cpuArch" : "x86", "cpu" : "8", "memory" : "32Gi", "type" : "Dedicate", "billingCode" : "modelarts.vm.cpu.8ud", "billingModes" : [ 0 ] }, "status" : { "phase" : { "cn-north-7a" : "soldout", "cn-north-7b" : "soldout", "cn-north-7c" : "normal" } } } ] } 状态码： 401 Authorization failed. { "error_code" : "ModelArts.50001000", "error_msg" : "token is invalid" } 状态码： 404 Not found. { "error_code" : "ModelArts.50005101", "error_msg" : "Resourceflavor not found." }

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中user_name为用户名，domain_name为用户所属的账号名，user_password为用户登录密码，cn-north-1为项目名称，获取方法请参见获取用户名、获取账号名和账号ID和获取项目名称。 scope参数定义了Token的作用域，示例中获取的Token仅能访问project下的资源。Modelarts使用区域的Endpoint（非全局域名）调用该接口，推荐您将scope设置为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": "user_name", "password": "user_password", "domain": { "name": "domain_name" } } } }, "scope": { "project": { "name": "cn-north-1" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”的值，就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

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