华为云用户手册

响应示例 状态码： 200 OK { "auths" : [ { "app" : { "app_id" : "fb1a9eadd87b48abbd74b8ba1755dffd", "app_name" : "app_13e0", "app_remark" : "ds", "app_key" : "b11ae87581b04b5284aa92b0d4ae332c", "app_secret" : "cb5d1b57368b4f129b635332a03bf0e3", "user_id" : "04f258c8fb00d42a1f65c00df88cc4dc", "project_id" : "04f258c84780d5a52f3bc00dc15aa5e7", "app_type" : "APIG", "app_codes" : [ "53a7c6de82be4671b93414adf98c1c507d5cef29fbdd48d88a4dddb668b0f0ad" ], "created_at" : 1683173880900, "updated_at" : 1700531228874, "bounded_api_count" : 28 }, "authed" : true } ], "count" : 1, "total_count" : 1 }

URI GET /v1/{project_id}/services/{service_id}/app-auth-apis/{api_id}/api-auths 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID。 service_id 是 String 服务 ID。 api_id 是 String API编号。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 分页展示时，一页展示多少项。默认为1000。 offset 否 String 分页展示时，从第几页开始。默认为0。 app_name 否 String APP名称，支持模糊查找。 order 否 String 返回的APP列表排序方式，可选值包括asc、desc。默认为asc。 show_only 否 String 可选值包括： AUTH（只显示已授权的APP信息） UNAUTH（只显示未授权的APP信息） 默认为空，即显示全部可见的APP信息。 sort_by 否 String 返回的APP列表按何属性排序， 可选值包括 app_name(应用名称) created_at(应用创建时间) updated_at(应用更新时间) 默认为app_name。 workspace_id 否 String 工作空间id iphertext_enabled 否 Boolean 是否明文展示appsecret app_ids 否 Array 明文展示的app_id集合

响应示例 状态码： 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 OK。 { "kind" : "Pool", "apiVersion" : "v2", "metadata" : { "name" : "auto-pool-os-86c13962597848eeb29c5861153a391f", "creationTimestamp" : "2022-09-16T03:10:40Z", "labels" : { "os.modelarts/name" : "auto-pool-os", "os.modelarts/workspace.id" : "0", "os.modelarts/resource.id" : "maos-auto-pool-os-72w8d" }, "annotations" : { "os.modelarts/description" : "", "os.modelarts/billing.mode" : "0" } }, "spec" : { "type" : "Dedicate", "scope" : [ "Train", "Infer" ], "resources" : [ { "flavor" : "modelarts.vm.cpu.4ud", "count" : 2 } ], "network" : { "name" : "network-maos-86c13962597848eeb29c5861153a391f" } }, "status" : { "phase" : "Running", "root" : "auto-pool-os-86c13962597848eeb29c5861153a391f", "scope" : [ { "scopeType" : "Train", "state" : "Enabled" }, { "scopeType" : "Infer", "state" : "Enabled" } ], "resources" : { "available" : [ { "flavor" : "modelarts.vm.cpu.4ud", "count" : 2, "azs" : [ { "az" : "cn-north-7c", "count" : 2 } ] } ] } } } 状态码： 404 Not Found。 { "error_code" : "ModelArts.50015001", "error_msg" : "pool not found" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 apiVersion String API版本。可选值如下： v2 kind String 资源类型。可选值如下： Pool：资源池 metadata PoolMetadataDeletion object 资源池的metadata信息。 spec PoolSpecModel object 资源池的描述信息。 status PoolStatus object 资源池的状态信息。 表4 PoolMetadataDeletion 参数 参数类型 描述 name String 系统自动生成的pool名称，相当于poolId。 creationTimestamp String 时间戳，例如"2021-11-01T03:49:41Z"。 deletionTimestamp String 时间戳，例如"2021-11-01T03:49:41Z"。 labels PoolMetaLabels object 资源池的标签信息。 annotations PoolMetaAnnotations object 资源池的注释信息。 表5 PoolMetaLabels 参数 参数类型 描述 os.modelarts/workspace.id String 工作空间id。 os.modelarts/name String 用户指定的pool名称。 os.modelarts/resource.id String 资源池的主资源id，通常提供给cbc使用。 os.modelarts/tenant.domain.id String 资源池的租户id，记录资源池创建在哪个租户账号下。 表6 PoolMetaAnnotations 参数 参数类型 描述 os.modelarts/description String 资源池的描述信息。 os.modelarts/billing.mode String 计费模式。可选值如下： 0：按需计费 1：包周期计费 os.modelarts/period.num String 包周期订购周期，比如2。 os.modelarts/period.type String 包周期订购类型。可选值如下： 2：月 3：年 4：小时 os.modelarts/auto.renew String 是否自动续费.可选值如下： 0：不自动续费，默认值 1：自动续费 os.modelarts/promotion.info String 用户在cbc选择的折扣信息。 os.modelarts/service.console.url String 订购订单支付完成后跳转的url地址。 os.modelarts/order.id String 订单id，包周期资源池创建或者计费模式变更的时候该参数必需。 os.modelarts/flavor.resource.ids String 每种规格对应的resourceId，主要和cbc交互使用。 os.modelarts/tms.tags String 创建的时候由用户指定的TMS标签。 表7 PoolSpecModel 参数 参数类型 描述 type String 资源池类型。可选值如下： Dedicate：物理资源池，独立的网络，支持网络打通，定制驱动，定制作业类型 scope Array of strings 资源池支持的作业类型。至少选择一种，物理资源池支持全部选择。可选值如下： Train：训练作业 Infer：推理作业 Notebook：Notebook作业 resources Array of resources objects 资源池中的资源规格信列表，包括资源规格和相应规格的资源数量。 network network object 资源池网络参数。物理资源池时必选。 jobFlavors Array of strings 资源池支持的作业规格信息列表，内容为作业规格名称。 driver PoolDriver object 资源池的驱动信息。 controlMode Integer 资源池的受限状态。可选值如下： 0：代表不受限 1：转包周期受限 2：规格变更受限 4：服务受限 8：冻结 16：公安冻结（不可退订）。 另外状态是可以叠加的，比如9代表转包周期受限+冻结状态 表8 resources 参数 参数类型 描述 flavor String 资源规格，比如：modelarts.vm.gpu.t4u8。 count Integer 相应规格资源数量。 azs Array of PoolNodeAz objects az列表信息。 表9 PoolNodeAz 参数 参数类型 描述 az String az名称。 count Integer 指定az扩容时，指定az的节点数。 表10 network 参数 参数类型 描述 name String 网络名称；用户接口通过指定网络名称创建网络，系统会自动创建子网，用户无法创建子网。默认将创建在第一个子网下。 表11 PoolDriver 参数 参数类型 描述 gpuVersion String GPU驱动版本，物理资源池中含有GPU规格时可填，例如： "440.33"。 npuVersion String NPU驱动版本，物理资源池中含有ascend规格时可填，例如："C78"。 updateStrategy String 驱动升级策略。可选值如下： force：强制升级，立即升级节点驱动，可能影响节点上正在运行的作业 idle：安全升级，待节点上没有作业运行时进行驱动升级 表12 PoolStatus 参数 参数类型 描述 phase String 资源池集群状态。可选值如下： Creating：创建中 Running：运行中 Abnormal：资源池不正常 Deleting：删除中 Error：资源池错误 message String 资源池处于当前状态的提示信息。 resources resources object 资源池中不同状态的资源量。 scope Array of scope objects 资源池业务状态信息。 driver driver object 资源池驱动信息。 parent String 资源池父节点名称，物理池为空。 root String 资源池根节点名称，物理池为自己的名称。 表13 resources 参数 参数类型 描述 creating PoolResourceFlavorCount object 状态为创建中状态的资源量。 available PoolResourceFlavorCount object 状态为可用状态的资源量。 abnormal PoolResourceFlavorCount object 状态为非正常状态的资源量。 deleting PoolResourceFlavorCount object 状态为删除中状态的资源量。 表14 PoolResourceFlavorCount 参数 参数类型 描述 flavor String 资源规格名称，比如：modelarts.vm.gpu.t4u8。 count Integer 规格保障使用量。 maxCount Integer 资源规格的弹性使用量，物理池该值和count相同。 azs Array of azs objects 资源所在的AZ的数量。 表15 azs 参数 参数类型 描述 az String AZ的名称。 count Integer AZ的资源数量。 表16 scope 参数 参数类型 描述 scopeType String 业务类型。可选值如下： Train：训练任务 Infer：推理任务 Notebook：Notebook作业 state String 业务状态。可选值如下： Enabling：启动中 Enabled：已启动 Disabling：关闭中 Disabled：已关闭 表17 driver 参数 参数类型 描述 gpu PoolDriverStatus object GPU驱动信息。 npu PoolDriverStatus object NPU驱动信息。 表18 PoolDriverStatus 参数 参数类型 描述 version String 当前驱动版本。 state String 当前驱动状态。可选值如下： Creating：创建中 Upgrading：升级中 Running：运行中 Abnormal：不正常 状态码： 404 表19 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码 error_msg String 具体错误信息

响应示例 状态码： 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必填一个。

请求参数 表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必填一个。

请求示例 创建工作空间。设置工作空间名称为“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" } ] }

请求示例 PUT https://{endpoint}/v1/{project_id}/workspaces/ccd05d1a553b4e188ea878e7dcb85e47 { "name" : "my_workspace", "description" : "It is my workspace", "auth_type" : "INTERNAL", "grants" : [ { "user_name" : "my_iam_user" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 grants 否 Array of grants objects 训练作业使用的数据集。不可与data_url或dataset_id/dataset_version_id同时使用。 auth_type 否 String 授权类型。可选值有PUBLIC、PRIVATE、INTERNAL。默认值为PUBLIC。 PUBLIC：租户内部公开访问。 PRIVATE：仅创建者和主账号可访问。 INTERNAL：创建者、主账号、指定IAM子账号可访问，需要与grants参数配合使用。 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必填一个。

请求示例 创建专属资源池。设置资源类型为“Pool”，资源池名称为“pool-001”，资源池类型为“Dedicate”（物理资源池），资源池支持的作业类型为“训练作业”。 POST https://{endpoint}/v2/{project_id}/pools { "kind" : "Pool", "apiVersion" : "v2", "metadata" : { "labels" : { "os.modelarts/name" : "pool-001", "os.modelarts/workspace.id" : "0" }, "annotations" : { "os.modelarts/description" : "", "os.modelarts/billing.mode" : "0" } }, "spec" : { "type" : "Dedicate", "scope" : [ "Train" ], "network" : { "name" : "net-0123-86c13962597848eeb29c5861153a391f" }, "resources" : [ { "flavor" : "modelarts.vm.gpu.t4u8", "count" : 2 } ], "driver" : { "gpuVersion" : "440.31" } } }

响应示例 状态码： 400 Bad request { "error_code" : "ModelArts.50004000", "error_msg" : "Bad request" } 状态码： 409 Already exists { "error_code" : "ModelArts.50015000", "error_msg" : "Pool already exists." }

响应参数 状态码： 200 表11 响应Body参数 参数 参数类型 描述 apiVersion String API版本。可选值如下： v2 kind String 资源类型。可选值如下： Pool：资源池 metadata PoolMetadata object 资源池的metadata信息。 spec PoolSpecModel object 资源池的期望信息。 status PoolStatus object 资源池的状态信息。 表12 PoolMetadata 参数 参数类型 描述 name String 系统自动生成的pool名称，相当于pool ID。 creationTimestamp String 时间戳，例如"2021-11-01T03:49:41Z"。 labels PoolMetaLabels object 资源池的标签信息。 annotations PoolMetaAnnotations object 资源池的注释信息。 表13 PoolMetaLabels 参数 参数类型 描述 os.modelarts/workspace.id String 工作空间id。 os.modelarts/name String 用户指定的pool名称。 os.modelarts/resource.id String 资源池的主资源id，通常提供给cbc使用。 os.modelarts/tenant.domain.id String 资源池的租户id，记录资源池创建在哪个租户账号下。 表14 PoolMetaAnnotations 参数 参数类型 描述 os.modelarts/description String 资源池的描述信息。 os.modelarts/billing.mode String 计费模式。可选值如下： 0：按需计费 1：包周期计费 os.modelarts/period.num String 包周期订购周期，比如2。 os.modelarts/period.type String 包周期订购类型。可选值如下： 2：月 3：年 4：小时 os.modelarts/auto.renew String 是否自动续费.可选值如下： 0：不自动续费，默认值 1：自动续费 os.modelarts/promotion.info String 用户在cbc选择的折扣信息。 os.modelarts/service.console.url String 订购订单支付完成后跳转的url地址。 os.modelarts/order.id String 订单id，包周期资源池创建或者计费模式变更的时候该参数必需。 os.modelarts/flavor.resource.ids String 每种规格对应的resourceId，主要和cbc交互使用。 os.modelarts/tms.tags String 创建的时候由用户指定的TMS标签。 表15 PoolSpecModel 参数 参数类型 描述 type String 资源池类型。可选值如下： Dedicate：物理资源池，独立的网络，支持网络打通，定制驱动，定制作业类型 scope Array of strings 资源池支持的作业类型。至少选择一种，物理资源池支持全部选择。可选值如下： Train：训练作业 Infer：推理作业 Notebook：Notebook作业 resources Array of resources objects 资源池中的资源规格信列表，包括资源规格和相应规格的资源数量。 network network object 资源池网络参数。物理资源池时必选。 jobFlavors Array of strings 资源池支持的作业规格信息列表，内容为作业规格名称。 driver PoolDriver object 资源池的驱动信息。 controlMode Integer 资源池的受限状态。可选值如下： 0：代表不受限 1：转包周期受限 2：规格变更受限 4：服务受限 8：冻结 16：公安冻结（不可退订）。 另外状态是可以叠加的，比如9代表转包周期受限+冻结状态 表16 resources 参数 参数类型 描述 flavor String 资源规格，比如：modelarts.vm.gpu.t4u8。 count Integer 相应规格资源数量。 azs Array of PoolNodeAz objects az列表信息。 表17 PoolNodeAz 参数 参数类型 描述 az String az名称。 count Integer 指定az扩容时，指定az的节点数。 表18 network 参数 参数类型 描述 name String 网络名称；用户接口通过指定网络名称创建网络，系统会自动创建子网，用户无法创建子网。默认将创建在第一个子网下。 表19 PoolDriver 参数 参数类型 描述 gpuVersion String GPU驱动版本，物理资源池中含有GPU规格时可填，例如： "440.33"。 npuVersion String NPU驱动版本，物理资源池中含有ascend规格时可填，例如："C78"。 updateStrategy String 驱动升级策略。可选值如下： force：强制升级，立即升级节点驱动，可能影响节点上正在运行的作业 idle：安全升级，待节点上没有作业运行时进行驱动升级 表20 PoolStatus 参数 参数类型 描述 phase String 资源池集群状态。可选值如下： Creating：创建中 Running：运行中 Abnormal：资源池不正常 Deleting：删除中 Error：资源池错误 message String 资源池处于当前状态的提示信息。 resources resources object 资源池中不同状态的资源量。 scope Array of scope objects 资源池业务状态信息。 driver driver object 资源池驱动信息。 parent String 资源池父节点名称，物理池为空。 root String 资源池根节点名称，物理池为自己的名称。 表21 resources 参数 参数类型 描述 creating PoolResourceFlavorCount object 状态为创建中状态的资源量。 available PoolResourceFlavorCount object 状态为可用状态的资源量。 abnormal PoolResourceFlavorCount object 状态为非正常状态的资源量。 deleting PoolResourceFlavorCount object 状态为删除中状态的资源量。 表22 PoolResourceFlavorCount 参数 参数类型 描述 flavor String 资源规格名称，比如：modelarts.vm.gpu.t4u8。 count Integer 规格保障使用量。 maxCount Integer 资源规格的弹性使用量，物理池该值和count相同。 azs Array of azs objects 资源所在的AZ的数量。 表23 azs 参数 参数类型 描述 az String AZ的名称。 count Integer AZ的资源数量。 表24 scope 参数 参数类型 描述 scopeType String 业务类型。可选值如下： Train：训练任务 Infer：推理任务 Notebook：Notebook作业 state String 业务状态。可选值如下： Enabling：启动中 Enabled：已启动 Disabling：关闭中 Disabled：已关闭 表25 driver 参数 参数类型 描述 gpu PoolDriverStatus object GPU驱动信息。 npu PoolDriverStatus object NPU驱动信息。 表26 PoolDriverStatus 参数 参数类型 描述 version String 当前驱动版本。 state String 当前驱动状态。可选值如下： Creating：创建中 Upgrading：升级中 Running：运行中 Abnormal：不正常 状态码： 400 表27 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码 error_msg String 具体错误信息 状态码： 409 表28 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码 error_msg String 具体错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-ModelArts-User-ID 否 String 实际的外部租户ID，如果有的话，工作空间鉴权以该ID为准。 表3 请求Body参数 参数 是否必选 参数类型 描述 apiVersion 是 String API版本。可选值如下： v2 kind 是 String 资源类型。可选值如下： Pool：资源池 metadata 是 PoolMetadataCreation object 资源池的metadata信息。 spec 否 PoolSpecCreation object 资源池的描述信息。 表4 PoolMetadataCreation 参数 是否必选 参数类型 描述 labels 是 PoolLabelsCreation object 资源池的标签信息。 annotations 否 PoolAnnotationsCreation object 资源池的注释信息。 表5 PoolLabelsCreation 参数 是否必选 参数类型 描述 os.modelarts/workspace.id 否 String 工作空间ID，默认值0。 os.modelarts/name 是 String 用户指定的pool名称。 表6 PoolAnnotationsCreation 参数 是否必选 参数类型 描述 os.modelarts/description 否 String 资源池的描述信息。 os.modelarts/billing.mode 否 String 计费模式，可选值如下： 0：按需计费 1：包周期计费 os.modelarts/period.num 否 String 包周期订购周期，比如2。当计费模式为包周期时该参数必传。 os.modelarts/period.type 否 String 包周期订购类型。可选值如下： 2：月 3：年 当计费模式为包周期时该参数必传。 os.modelarts/auto.renew 否 String 是否自动续费.可选值如下： 0：不自动续费，默认值 os.modelarts/promotion.info 否 String 用户在cbc选择的折扣信息。 os.modelarts/service.console.url 否 String 订购订单支付完成后跳转的url地址。 os.modelarts/order.id 否 String 订单id，包周期资源池创建或者计费模式变更的时候该参数必需。 表7 PoolSpecCreation 参数 是否必选 参数类型 描述 type 是 String 资源池类型。可选值如下： Dedicate：物理资源池，独立的网络，支持网络打通，定制驱动，定制作业类型 scope 是 Array of strings 资源池支持的作业类型。至少选择一种，物理资源池支持全部选择。可选值如下： Train：训练作业 Infer：推理作业 Notebook：Notebook作业 resources 是 Array of PoolResourceFlavor objects 资源池中的资源规格信列表，包括资源规格和相应规格的资源数量。 network 是 network object 资源池网络参数。物理资源池时必选。 jobFlavors 否 Array of strings 资源池支持的作业规格信息列表，内容为作业规格名称。 driver 否 PoolDriver object 资源池的驱动信息。 表8 PoolResourceFlavor 参数 是否必选 参数类型 描述 flavor 是 String 资源规格，比如：modelarts.vm.gpu.t4u8。 count 是 Integer 相应规格资源数量。 表9 network 参数 是否必选 参数类型 描述 name 是 String 网络名称，即网络详情中的metadata.name字段的值。用户接口通过指定网络名称创建网络，系统会自动创建子网，用户无法创建子网。默认将创建在第一个子网下。 表10 PoolDriver 参数 是否必选 参数类型 描述 gpuVersion 否 String GPU驱动版本，物理资源池中含有GPU规格时可填，例如： "440.33"。 npuVersion 否 String NPU驱动版本，物理资源池中含有ascend规格时可填，例如："C78"。 updateStrategy 否 String 驱动升级策略。可选值如下： force：强制升级，立即升级节点驱动，可能影响节点上正在运行的作业 idle：安全升级，待节点上没有作业运行时进行驱动升级

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 grants Array of grants objects 授权用户列表。默认为空。需要与“auth_type”参数配合使用，且仅当授权类型为“INTERNAL”时才会生效。 owner String 创建者名称。 auth_type String 授权类型。可选值有PUBLIC、PRIVATE、INTERNAL。默认值为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 工作空间名称。长度限制为4-64字符，支持中文、大小写字母、数字、中划线和下划线。同时'default'为系统预留的默认工作空间名称，用户无法自己创建名为'default'的工作空间。 description String 工作空间描述，默认为空。长度限制为0-256字符。 id String 工作空间ID，系统生成的32位UUID，不带橫线。 status String 工作空间状态。 CREATE_FAILED：创建失败。 NORMAL：状态正常。 DELETING：正在删除。 DELETE_FAILED：删除失败。 status_info String 状态描述，默认为空。该字段会补充显示状态的详细信息。如删除失败时，可通过该字段查看删除失败的原因。 表4 grants 参数 参数类型 描述 user_id String IAM用户ID。此参数与user_name必填一个。两者都填优先使用user_id。 user_name String IAM用户名称。此参数与user_id必填一个。

响应示例 状态码： 200 查询工作空间详情成功的响应参数. { "id" : "**d05d1a553b4e188ea878e7dcb85e**", "name" : "test-workspace", "status" : "NORMAL", "status_info" : "", "description" : "", "owner" : "testUser", "create_time" : 1470000020000, "update_time" : 1470000030000, "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", "enterprise_project_name" : "test-eps", "auth_type" : "INTERNAL", "grants" : [ { "user_id" : "***55d2cd53b4x458ea878e7dcb85***", "user_name" : "test-iam-user" } ] }

响应示例 状态码： 200 ok { "header" : [ "done", "pid", "best_reward", "time_total_s", "config", "acc", "loss", "trial_id", "training_iteration", "reward_attr" ], "data" : [ [ "False", "314", "0.0625", "19.477163314819336", { "batch_size" : 32, "learning_rate" : 0.05512301741232006, "trial_index" : 0, "param/batch_size" : 32, "param/learning_rate" : 0.05512301741232006 }, "0.0625", "tensor(0.0754, device='cuda:0', requires_grad=True)", "ae544174", "2", "0.0625" ], [ "True", "314", "0.0625", "19.477163314819336", { "batch_size" : 32, "learning_rate" : 0.05512301741232006, "trial_index" : 0, "param/batch_size" : 32, "param/learning_rate" : 0.05512301741232006 }, "0.0625", "tensor(0.0754, device='cuda:0', requires_grad=True)", "ae544174", "2", "0.0625" ] ] }

URI GET /v2/{project_id}/training-jobs/{training_job_id}/autosearch-trials/{trial_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 training_job_id 是 String 训练作业ID。 trial_id 是 String 超参搜索的trial_id。

请求示例 如以下查询training_job_id为5b60a667-1438-4eb5-9705-85b860e623dc的作业中trial为ae544174的信息。 GET https://endpoint//v2/{project_id}/training-jobs/5b60a667-1438-4eb5-9705-85b860e623dc/autosearch-trials/ae544174

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 app ApigAppDetailInfo object 创建的APP基础信息。 表5 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 表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 具体错误信息

响应示例 状态码： 200 OK { "app" : { "app_id" : "f29eddd1443e4dceb76898f881c07a4d", "app_name" : "app_xq0XT", "app_remark" : "autotest", "app_key" : "bcb835430eab4c72bd45e2315d98fdb9", "app_secret" : "80dc4ab97b34456fbf73a04e83164a1b", "user_id" : "04f258c8fb00d42a1f65c00df88cc4dc", "project_id" : "04f258c84780d5a52f3bc00dc15aa5e7", "app_type" : "APIG", "app_codes" : [ "873810a2cd4e4a9c88df5979411d6a50753c0af4024840fcac59e37ce38364e4" ], "created_at" : 1698745606957, "updated_at" : 1703162907779, "bounded_api_count" : 0 } }

URI PUT /v1/{project_id}/app-auth/apps/{app_id}/app-code/{app_code} 表1 路径参数 参数 是否必选 参数类型 描述 app_code 是 String 待重置的AppCode。 app_id 是 String APP编号，可通过APP列表接口获取。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 消息体的类型。设置为text/plain，返回临时预览链接。设置为application/octet-stream，返回临时下载链接。 X-Auth-Token 是 String 用户token 表3 请求Body参数 参数 是否必选 参数类型 描述 app_name 是 String app名称 app_remark 否 String app备注 workspace_id 否 String 工作空间id

URI GET /v2/{project_id}/workflows/{workflow_id}/executions/{execution_id}/step-executions/{step_execution_id}/metrics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 workflow_id 是 String 工作流的ID execution_id 是 String 工作流执行ID step_execution_id 是 String 工作流的一次执行中一个节点的执行ID

响应示例 状态码： 200 OK [ { "created_at" : "2022-11-03T17:30:49.735253+08:00", "key" : "accuracy", "title" : "accuracy", "type" : "line chart", "data" : { "x_axistrhrth" : [ { "title" : "step", "value" : [ 1, 2, 3, 4, 5 ] }, { "title" : "timestamp", "value" : [ 1667467812015, 1667467817223, 1667467822783, 1667467828078, 1667467833344 ] } ], "y_axishdsfgsdvg" : [ { "title" : "value", "value" : [ 0.5, 0.6, 0.7, 0.8, 0.9 ] } ], "z_wefwe" : [ ] } }, { "created_at" : "2022-11-03T17:30:49.009943+08:00", "key" : "loss", "title" : "loss", "type" : "line chart", "data" : { "x_axis" : [ { "title" : "step", "value" : [ 1, 2, 3, 4, 5 ] }, { "title" : "timestamp", "value" : [ 1667467811884, 1667467817178, 1667467822255, 1667467827822, 1667467833115 ] } ], "y_axis" : [ { "title" : "value", "value" : [ 0.5, 0.6, 0.7, 0.8, 0.9 ] } ] } } ]

响应示例 状态码： 200 查询工作空间配额成功的响应参数。 { "quotas" : [ { "max_quota" : 60000, "update_time" : 1470000020000, "resource" : "exemlProject.gpu_duration", "used_quota" : 5, "quota" : 10, "min_quota" : -1, "name_cn" : "自动学习（图像分类、物体检测、声音分类）训练时长", "unit_cn" : "分钟", "name_en" : "ExeMLtraining duration (image classification, object detection, and soundclassification)", "unit_en" : "minute" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 quotas Array of WorkspaceQuotasResponse objects 工作空间配额数据。 表4 WorkspaceQuotasResponse 参数 参数类型 描述 max_quota Integer 配额允许设置的最大值。 update_time Integer 最后修改时间，UTC。如用户未修改过该资源配额,则该值默认为该工作空间的创建时间。 resource String 资源的唯一标识。 quota Integer 当前配额值。配额值为-1代表不限制配额。 min_quota Integer 配额允许设置的最小值。 name_cn String 配额名称(中文)。 unit_cn String 数量单位(中文)。 name_en String 工作空间ID，系统生成的32位UUID，不带橫线。默认的工作空间id为'0'。 unit_en String 数量单位(英文)。 used_quota Integer 已用配额值。当quota为-1（不限制配额）时，used_quota为null。

响应示例 状态码： 200 OK。 { "kind" : "PoolList", "apiVersion" : "v2", "items" : [ { "kind" : "Pool", "apiVersion" : "v2", "metadata" : { "name" : "auto-pool-os-86c13962597848eeb29c5861153a391f", "creationTimestamp" : "2022-09-16T03:10:40Z", "labels" : { "os.modelarts/name" : "auto-pool-os", "os.modelarts/workspace.id" : "0", "os.modelarts/resource.id" : "maos-auto-pool-os-72w8d" }, "annotations" : { "os.modelarts/description" : "", "os.modelarts/billing.mode" : "0" } }, "spec" : { "type" : "Dedicate", "scope" : [ "Train", "Infer" ], "resources" : [ { "flavor" : "modelarts.vm.cpu.4ud", "count" : 2 } ], "network" : { "name" : "network-maos-86c13962597848eeb29c5861153a391f" } }, "status" : { "phase" : "Running", "root" : "auto-pool-os-86c13962597848eeb29c5861153a391f", "scope" : [ { "scopeType" : "Train", "state" : "Enabled" }, { "scopeType" : "Infer", "state" : "Enabled" } ], "resources" : { "available" : [ { "flavor" : "modelarts.vm.cpu.4ud", "count" : 2, "azs" : [ { "az" : "cn-north-7c", "count" : 2 } ] } ] } } } ] }