华为云用户手册

请求示例 注册 自定义镜像 。设置镜像支持的规格为“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" }

响应示例 状态码：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" }

请求参数 表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”，存在创建并使用的工作空间，以实际取值为准。 flavor_type 否 String 资源类型 -ASCEND_SNT9 -ASCEND_SNT9B -ASCEND_SNT3

响应参数 状态码：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”，存在创建并使用的工作空间，以实际取值为准。 flavor_type String 镜像的资源类型,枚举值： -ASCEND_SNT9 -ASCEND_SNT9B -ASCEND_SNT3

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

请求示例 通过patch操作对服务进行更新。 PATCH https://{endpoint}/v1/{project_id}/services/{service_id} [ { "op" : "replace", "path" : "/config/0/envs", "value" : { } }, { "op" : "replace", "path" : "/config/0/model_id", "value" : "a9542b46-8dfd-4184-bd81-c8d8946edb47" }, { "op" : "replace", "path" : "/config/0/additional_properties", "value" : { "persistent_volumes" : [ { "storage_type" : "obs_pfs", "source_address" : "/dongcong4", "mount_path" : "/var/tmp", "storage_type_text" : "atelier_webservice_detail_model_config_volumes_type_obs" } ] } }, { "op" : "replace", "path" : "/config/0/specification", "value" : "modelarts.vm.ai1.a310" }, { "op" : "replace", "path" : "/config/0/pool_name", "value" : "pool-c8e2-04f258c84780d5a52f3bc00dc15aa5e7" } ]

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-ModelArts-User-ID 否 String 委托Token校验workspace时需要填写user id。 X-Auth-Token 是 String 用户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of PatchServiceV2RequestBody objects 服务PATCH操作请求体。 表4 PatchServiceV2RequestBody 参数 是否必选 参数类型 描述 op 否 String 操作类型，目前仅支持replace，代表值替换操作。 path 否 String 操作路径，符合标准的Json PATCH格式，代表以服务详情的Json返回体为基准，想要执行替换的值的目标路径（Json PATH）。当前支持且仅支持对模型相关所有参数的替换更新，因此前缀固定为“/config/”。例如，当期望更新第一个模型中的实例数量，则路径为“/config/0/instance_count”。 value 否 String 替换的目标值。

响应示例 状态码：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" : 3 } ], "network" : { "name" : "network-maos-86c13962597848eeb29c5861153a391f" } }, "status" : { "phase" : "Running", "root" : "auto-pool-os-86c13962597848eeb29c5861153a391f", "scope" : [ { "scopeType" : "Train", "state" : "Enabled" }, { "scopeType" : "Infer", "state" : "Enabled" } ], "resources" : { "creating" : [ { "flavor" : "modelarts.vm.cpu.4ud", "count" : 1, "azs" : [ { "az" : "cn-north-7c", "count" : 1 } ] } ], "available" : [ { "flavor" : "modelarts.vm.cpu.4ud", "count" : 2, "azs" : [ { "az" : "cn-north-7c", "count" : 2 } ] } ] } } } 状态码：400 Bad request { "error_code" : "ModelArts.50004000", "error_msg" : "Bad request" } 状态码：404 Not Found。 { "error_code" : "ModelArts.50015001", "error_msg" : "pool not found" }

响应参数 状态码：200 表10 响应Body参数 参数 参数类型 描述 apiVersion String API版本。可选值如下： v2 kind String 资源类型。可选值如下： Pool：资源池 metadata PoolMetadata object 资源池的metadata信息。 spec PoolSpecModel object 资源池的期望信息。 status PoolStatus object 资源池的状态信息。 表11 PoolMetadata 参数 参数类型 描述 name String 系统自动生成的pool名称，相当于pool ID。 creationTimestamp String 时间戳，例如"2021-11-01T03:49:41Z"。 labels PoolMetaLabels object 资源池的标签信息。 annotations PoolMetaAnnotations object 资源池的注释信息。 表12 PoolMetaLabels 参数 参数类型 描述 os.modelarts/workspace.id String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 os.modelarts/name String 用户指定的pool名称。 os.modelarts/resource.id String 资源池的主资源id，通常提供给cbc使用。 os.modelarts/tenant.domain.id String 资源池的租户id，记录资源池创建在哪个租户账号下。 表13 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标签。 表14 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代表转包周期受限+冻结状态。 表15 resources 参数 参数类型 描述 flavor String 资源规格，比如：modelarts.vm.gpu.tnt004。 count Integer 相应规格资源数量。 azs Array of PoolNodeAz objects az列表信息。 extendParams extendParams object 自定义配置参数。 os Os object 操作系统镜像信息。 表16 PoolNodeAz 参数 参数类型 描述 az String 可用区名称。 count Integer 指定可用区扩容时，指定可用区的节点数。 表17 extendParams 参数 参数类型 描述 dockerBaseSize String 指定资源池节点的容器引擎空间大小。值为0时表示不限制大小。 表18 Os 参数 参数类型 描述 name String 操作系统名称。 imageId String 操作系统镜像id。 imageType String 操作系统镜像类型。 private：私有镜像。 表19 network 参数 参数类型 描述 name String 网络名称；用户接口通过指定网络名称创建网络，系统会自动创建子网，用户无法创建子网。默认将创建在第一个子网下。 表20 PoolDriver 参数 参数类型 描述 gpuVersion String GPU驱动版本，物理资源池中含有GPU规格时可填，例如："440.33"。 npuVersion String NPU驱动版本，物理资源池中含有ascend规格时可填，例如："C78"。 updateStrategy String 驱动升级策略。可选值如下： force：强制升级，立即升级节点驱动，可能影响节点上正在运行的作业 idle：安全升级，待节点上没有作业运行时进行驱动升级 表21 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 资源池根节点名称，物理池为自己的名称。 表22 resources 参数 参数类型 描述 creating PoolResourceFlavorCount object 状态为创建中状态的资源量。 available PoolResourceFlavorCount object 状态为可用状态的资源量。 abnormal PoolResourceFlavorCount object 状态为非正常状态的资源量。 deleting PoolResourceFlavorCount object 状态为删除中状态的资源量。 表23 PoolResourceFlavorCount 参数 参数类型 描述 flavor String 资源规格名称，比如：modelarts.vm.gpu.tnt004。 count Integer 规格保障使用量。 maxCount Integer 资源规格的弹性使用量，物理池该值和count相同。 azs Array of azs objects 资源所在的AZ的数量。 nodePool String 节点池名称。比如：nodePool-1。 表24 azs 参数 参数类型 描述 az String AZ的名称。 count Integer AZ的资源数量。 表25 scope 参数 参数类型 描述 scopeType String 业务类型。可选值如下： Train：训练任务 Infer：推理任务 Notebook：Notebook作业 state String 业务状态。可选值如下： Enabling：启动中 Enabled：已启动 Disabling：关闭中 Disabled：已关闭 表26 driver 参数 参数类型 描述 gpu PoolDriverStatus object GPU驱动信息。 npu PoolDriverStatus object NPU驱动信息。 表27 PoolDriverStatus 参数 参数类型 描述 version String 当前驱动版本。 state String 当前驱动状态。可选值如下： Creating：创建中 Upgrading：升级中 Running：运行中 Abnormal：不正常 状态码：400 表28 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码：404 表29 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应示例 状态码：200 OK。 { "spec" : { "resources" : { "nodePool" : "modelarts.vm.2u4g.dcc-Default", "flavor" : "modelarts.vm.2u4g.dcc", "count" : 1, "maxCount" : 1, "network" : { "vpc" : "277e9abc-0e6b-431a-9232-cfd25d5fc566", "subnet" : "03796378-c356-4c14-826b-e4913aa9c8b9", "securityGroups" : [ "0a15b48d-06f1-41e4-b782-ade90087bf59" ] } } } } 状态码：400 Bad request { "error_code" : "ModelArts.50004000", "error_msg" : "Bad request." }

请求示例 更新节点池。 PATCH https://{endpoint}/v2/{project_id}/pools/{pool_name}/nodepools/{nodepool_name} { "spec" : { "resources" : { "nodePool" : "modelarts.vm.2u4g.dcc-Default", "flavor" : "modelarts.vm.2u4g.dcc", "count" : 1, "maxCount" : 1, "network" : { "vpc" : "277e9abc-0e6b-431a-9232-cfd25d5fc566", "subnet" : "03796378-c356-4c14-826b-e4913aa9c8b9", "securityGroups" : [ "0a15b48d-06f1-41e4-b782-ade90087bf59" ] } } } }

请求示例 打通VPC。 PATCH https://{endpoint}/v1/{project_id}/networks/{network_name} { "spec" : { "connection" : { "peerConnectionList" : [ { "peerVpcId" : "03e4f4d7-fc62-409b-9c52-df885525e30b", "peerSubnetId" : "42aeebc3-f7c7-45aa-b884-e6e9ac2f841d", "defaultGateWay" : false } ] } } }

响应示例 状态码：200 OK。 { "kind" : "Network", "apiVersion" : "v1", "metadata" : { "name" : "network-7a03-86c13962597848eeb29c5861153a391f", "creationTimestamp" : "2022-09-16T09:44:59Z", "labels" : { "os.modelarts/name" : "network-7a03", "os.modelarts/workspace.id" : "0" }, "annotations" : { } }, "spec" : { "cidr" : "192.168.128.0/17", "connection" : { "peerConnectionList" : [ { "peerVpcId" : "03e4f4d7-fc62-409b-9c52-df885525e30b", "peerSubnetId" : "42aeebc3-f7c7-45aa-b884-e6e9ac2f841d", "defaultGateWay" : false } ] } }, "status" : { "phase" : "Active", "connectionStatus" : { } } } 状态码：400 Bad request { "error_code" : "ModelArts.50004000", "error_msg" : "Bad request." } 状态码：404 Not Found。 { "error_code" : "ModelArts.50025001", "error_msg" : "Network not exist." }

URI GET /v1/{project_id}/workspaces 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页列表的起始页，默认为'0'。 limit 否 Integer 指定每一页返回的最大条目数，默认为'1000'。 sort_by 否 String 指定排序字段，可选'name'、'update_time'、'status'，默认是'name'。 order 否 String 可选值。'asc'为递增排序。'desc'为递减排序，默认为'desc'。 enterprise_project_id 否 String 企业项目id，指定此参数会只返回该企业项目id下的工作空间。默认显示所有工作空间。 name 否 String 工作空间名称查询参数，指定此参数会模糊查询该名称的工作空间。默认显示所有工作空间。 filter_accessible 否 Boolean 该参数用于筛选可访问的工作空间。指定该参数为true，则会筛选掉当前用户无权限访问的工作空间。该参数默认为false，即为显示所有工作空间。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 工作空间的总数。 count Integer 此次请求返回的工作空间个数。 workspaces Array of WorkspaceResponse objects workspace属性列表。 表5 WorkspaceResponse 参数 参数类型 描述 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，不带橫线。默认的工作空间id为'0'。 status String 工作空间状态。 CREATE_FAILED：创建失败。 NORMAL：状态正常。 DELETING：正在删除。 DELETE_FAILED：删除失败。 status_info String 状态描述，默认为空。该字段会补充显示状态的详细信息。如删除失败时，可通过该字段查看删除失败的原因。

响应示例 状态码：200 查询工作空间列表成功的响应参数。 { "total_count" : 10, "count" : 1, "workspaces" : [ { "id" : 0, "name" : "default", "description" : "", "owner" : "testUser", "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", "enterprise_project_name" : "default", "auth_type" : "public", "create_time" : 1460000010000, "update_time" : 1460000010000, "status" : "NORMAL", "status_info" : "" } ] }

响应示例 状态码：200 OK。 { "kind" : "WorkloadList", "apiVersion" : "v1", "items" : [ { "kind" : "Workload", "apiVersion" : "v1", "uid" : "837ad51b-7c39-41f7-82e9-ea904cbb8ed6", "jobUUID" : "19d05662-0f87-43c7-8426-1ccf4b30179b", "name" : "ma-job-19d05662-0f87-43c7-8426-1ccf4b30179b", "jobName" : "DI-job-202412022313-hlyh5", "type" : "train", "namespace" : "os-pool-train-dsnt9b-memarts1-1ccf4b30179b", "status" : "Running", "resourceRequirement" : { "cpu" : "360 Cores", "memory" : "2.36 TiB" }, "priority" : "1", "createTime" : 1733152598000, "runningDuration" : 1857065, "pendingPosition" : -1, "gvk" : "batch.volcano.sh/v1alpha1, Kind=Job", "hostIps" : "192.168.81.93,192.168.73.217", "nodes" : [ { "hostIp" : "192.168.81.93", "npuTopologyPlacement" : "0x00ff", "resourceRequirement" : { "cpu" : "180 Cores", "memory" : "1.18 TiB", "huawei.com/ascend-1980" : "8" } }, { "hostIp" : "192.168.73.217", "npuTopologyPlacement" : "0x00ff", "resourceRequirement" : { "cpu" : "180 Cores", "memory" : "1.18 TiB", "huawei.com/ascend-1980" : "8" } } ] } ] } 状态码：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 表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列表，逗号分隔。 nodes Array of WorkloadNodeVO objects 作业所使用的节点资源信息 表5 resourceRequirement 参数 参数类型 描述 cpu String CPU使用量。 memory String 内存使用量。 nvidia.com/gpu String GPU资源使用量。 huawei.com/ascend-snt3 String 昇腾资源使用量。 huawei.com/ascend-snt9 String 昇腾资源使用量。 表6 WorkloadNodeVO 参数 参数类型 描述 hostIp String 节点ip npuTopologyPlacement String 910卡占用拓扑信息， 将16进制转换成二进制后，比特位从右往左卡编号0-15，比特位1代表占用。 resourceRequirement ResourceRequirementVO object 请求资源量 表7 ResourceRequirementVO 参数 参数类型 描述 cpu String cpu使用信息 memory String memory使用信息 nvidia.com/gpu String nvidia.com/gpu使用信息 huawei.com/ascend-310 String huawei.com/ascend-310使用信息 huawei.com/ascend-1980 String huawei.com/ascend-1980使用信息 状态码：400 表8 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

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 OK { "total_number" : 2, "workforces" : [ { "workforce_id" : "ZUH8gqkjuaib8pxkDdz", "workforce_name" : "team-123", "description" : "my team", "worker_count" : 0, "create_time" : 1606354772548, "update_time" : 1606354772548 }, { "workforce_id" : "3Ry04NsqvEybuWYLDvC", "workforce_name" : "team-170a", "description" : "", "worker_count" : 1, "create_time" : 1604644946891, "update_time" : 1606238678626 } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total_number Integer 标注团队总数。 workforces Array of Workforce objects 分页查询到的标注团队列表。 表4 Workforce 参数 参数类型 描述 create_time Long 标注团队的创建时间。 description String 标注团队的描述。 update_time Long 标注团队的更新时间。 worker_count Integer 标注团队的成员总数。 workforce_id String 标注团队ID。 workforce_name String 标注团队名称。 workspace_id String 工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

URI GET /v2/{project_id}/workforces 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定每一页返回的最大条目数，取值范围[1,100]，默认为10。 offset 否 Integer 分页列表的起始页，默认为0。 order 否 String 指定查询的排序顺序。可选值如下： asc：递增排序 desc：递减排序（默认值） search_content 否 String 模糊匹配名称，默认为空。 sort_by 否 String 指定查询的排序方式。可选值如下： create_time：按创建时间排序（默认值） workforce_name：按标注团队名称排序 workforce_task_id 否 String 团队标注任务ID。

响应示例 状态码： 200 OK { "count" : 2, "tasks" : [ { "dataset_id" : "WxCREuCkBSAlQr9xrde", "task_id" : "tY330MHxV9dqIPVaTRM", "task_name" : "task-cd60", "status" : 1, "create_time" : 1606224714358, "update_time" : 1606224714358, "repetition" : 1, "workforces_config" : { "workforces" : [ { "workforce_id" : "0PfqwXA8M59pppYBx4k", "workforce_name" : "team-123", "workers" : [ { "email" : "xxx@xxx.com", "worker_id" : "6db04ae0afb54d7274a2982255516c29", "role" : 2 }, { "email" : "xxx@xxx.com", "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", "role" : 0 } ] } ] }, "synchronize_data" : true, "synchronize_auto_labeling_data" : true, "workforce_stats" : { "workforce_count" : 1, "labeler_count" : 1, "reviewer_count" : 0 }, "sample_stats" : { "total_sample_count" : 309, "unannotated_sample_count" : 308, "unreviewed_sample_count" : 0, "uncheck_sample_count" : 1, "sampled_sample_count" : 0, "rejected_sample_count" : 0, "accepted_sample_count" : 0, "auto_annotation_sample_count" : 0 }, "auto_sync_dataset" : true }, { "dataset_id" : "WxCREuCkBSAlQr9xrde", "task_id" : "iYZx7gScPUozOXner9k", "task_name" : "task-e63f", "status" : 1, "create_time" : 1606184400278, "update_time" : 1606184400278, "repetition" : 1, "workforces_config" : { "workforces" : [ { "workforce_id" : "q3ZFSwORu1ztKljDLYQ", "workforce_name" : "modelarts-team", "workers" : [ { "email" : "xxx@xxx.com", "worker_id" : "afdda13895bc66322ffbf36ae833bcf0", "role" : 0 } ] } ] }, "synchronize_data" : false, "synchronize_auto_labeling_data" : false, "workforce_stats" : { "workforce_count" : 1, "labeler_count" : 1, "reviewer_count" : 0 }, "sample_stats" : { "total_sample_count" : 317, "unannotated_sample_count" : 310, "unreviewed_sample_count" : 0, "uncheck_sample_count" : 0, "sampled_sample_count" : 0, "rejected_sample_count" : 0, "accepted_sample_count" : 7, "auto_annotation_sample_count" : 0 }, "checking_task_desc" : { "checking_task_id" : "onSbri2oqYOmDjDyW17", "action" : 0, "overwrite_last_result" : false }, "auto_sync_dataset" : true } ] }

URI GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页列表的起始页，默认为0。 limit 否 Integer 指定每一页返回的最大条目数，取值范围[1,1000]，默认为1000。

响应示例 状态码： 200 OK { "label_stats" : [ { "name" : "Rabbits", "type" : 1, "property" : { "@modelarts:color" : "#3399ff" }, "count" : 0, "sample_count" : 0 }, { "name" : "Bees", "type" : 1, "property" : { "@modelarts:color" : "#3399ff" }, "count" : 1, "sample_count" : 1 } ], "sample_stats" : { "un_annotation" : 308, "total" : 309, "rejected" : 0, "unreviewed" : 1, "accepted" : 0, "auto_annotation" : 0, "uncheck" : 0 }, "key_sample_stats" : { "total" : 309, "non_key_sample" : 309, "key_sample" : 0 }, "metadata_stats" : { }, "data_spliting_enable" : false }

URI GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/stats 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 workforce_task_id 是 String 团队标注任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 sample_state 否 String 查询指定样本状态下的统计信息。可选样本状态如下： __ALL__：已标注 __NONE__：未标注 __UNCHECK__：待验收 __ACCEPTED__：验收通过 __REJECTED__：已驳回 __UNREVIEWED__：待审核 __REVIEWED__：已审核 __WORKFORCE_SAMPLED__：已采样 __WORKFORCE_SAMPLED_UNCHECK__：采样待验收 __WORKFORCE_SAMPLED_CHECKED__：采样已验收 __WORKFORCE_SAMPLED_ACCEPTED__：采样已通过 __WORKFORCE_SAMPLED_REJECTED__：采样已驳回 __AUTO_ANNOTATION__：待确认

响应示例 状态码： 200 OK { "sample_count" : 2, "samples" : [ { "sample_id" : "26c6dd793d80d3274eb89349ec76d678", "sample_type" : 0, "labels" : [ ], "source" : "https://test-obs.obs.xxx.com:443/detect/data/dataset-car-and-person/IMG_kitti_0000_000016.png?AccessKeyId=P19W9X830R1Z39P5X5M5&Expires=1606300137&x-obs-security-token=gQpjbi1ub3J0aC03jKj8N6gtS4VsdTTW3QFoHMtpMoFLtCa6W_J4DxT0nYIfx...", "metadata" : { "@modelarts:import_origin" : 0, "@modelarts:size" : [ 1242, 375, 3 ] }, "sample_time" : 1598263639997, "sample_status" : "UN_ANNOTATION", "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", "labelers" : [ { "email" : "xxx@xxx.com", "worker_id" : "afdda13895bc66322ffbf36ae833bcf0", "role" : 0 } ] }, { "sample_id" : "2971815bbb11a462161b48dddf19344f", "sample_type" : 0, "labels" : [ ], "source" : "https://test-obs.obs.xxx.com:443/detect/data/dataset-car-and-person/IMG_kitti_0000_000011.png?AccessKeyId=P19W9X830R1Z39P5X5M5&Expires=1606300137&x-obs-security-token=gQpjbi1ub3J0aC03jKj8N6gtS4VsdTTW3QFoHMtpMoFLtC...", "metadata" : { "@modelarts:import_origin" : 0, "@modelarts:size" : [ 1242, 375, 3 ] }, "sample_time" : 1598263639997, "sample_status" : "UN_ANNOTATION", "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", "labelers" : [ { "email" : "xxx@xxx.com", "worker_id" : "305595e1901a526017d2e11f3ab0ffe1", "role" : 0 } ] } ] }

URI GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 workforce_task_id 是 String 团队标注任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 label_name 否 String 标签名。 label_type 否 Integer 标注类型。可选值如下： 0：图像分类 1：物体检测 3: 图像分割 100：文本分类 101：命名实体 102：文本三元组 200：声音分类 201：语音内容 202：语音分割 400：表格数据集 600：视频标注 900：自由格式 limit 否 Integer 指定每一页返回的最大条目数，取值范围[1,100]，默认为10。 locale 否 String 语言。可选值如下： zh-cn：中文 en-us：英文（默认值） offset 否 Integer 分页列表的起始页，默认为0。 process_parameter 否 String 图像缩略设置，同OBS缩略图设置，详见OBS缩略图设置。如：image/resize,m_lfit,h_200表示等比缩放目标缩略图并设置高度为200像素。 sample_state 否 String 样本状态。可选样本状态如下： __ALL__：已标注 __NONE__：未标注 __UNCHECK__：待验收 __ACCEPTED__：验收通过 __REJECTED__：已驳回 __UNREVIEWED__：待审核 __REVIEWED__：已审核 __WORKFORCE_SAMPLED__：已采样 __WORKFORCE_SAMPLED_UNCHECK__：采样待验收 __WORKFORCE_SAMPLED_CHECKED__：采样已验收 __WORKFORCE_SAMPLED_ACCEPTED__：采样已通过 __WORKFORCE_SAMPLED_REJECTED__：采样已驳回 __AUTO_ANNOTATION__：待确认 search_conditions 否 String URL编码后的多维筛选条件（多个SearchCondition之间为and的关系）。

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 { "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 } ] }