华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 apiVersion String API版本。可选值如下： v2 kind String 资源类型。可选值如下： PoolList：资源池列表 items Array of PoolModel objects 资源池列表。 表4 PoolModel 参数 参数类型 描述 apiVersion String API版本。可选值如下： v2 kind String 资源类型。可选值如下： Pool：资源池 metadata PoolMetadata object 资源池的metadata信息。 spec PoolSpecModel object 资源池的期望信息。 status PoolStatus object 资源池的状态信息。 表5 PoolMetadata 参数 参数类型 描述 name String 系统自动生成的pool名称，相当于pool ID。 creationTimestamp String 时间戳，例如"2021-11-01T03:49:41Z"。 labels PoolMetaLabels object 资源池的标签信息。 annotations PoolMetaAnnotations object 资源池的注释信息。 表6 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，记录资源池创建在哪个租户账号下。 表7 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标签。 表8 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代表转包周期受限+冻结状态。 表9 resources 参数 参数类型 描述 flavor String 资源规格，比如：modelarts.vm.gpu.tnt004。 count Integer 相应规格资源数量。 azs Array of PoolNodeAz objects az列表信息。 表10 PoolNodeAz 参数 参数类型 描述 az String 可用区名称。 count Integer 指定可用区扩容时，指定可用区的节点数。 表11 network 参数 参数类型 描述 name String 网络名称；用户接口通过指定网络名称创建网络，系统会自动创建子网，用户无法创建子网。默认将创建在第一个子网下。 表12 PoolDriver 参数 参数类型 描述 gpuVersion String GPU驱动版本，物理资源池中含有GPU规格时可填，例如："440.33"。 npuVersion String NPU驱动版本，物理资源池中含有ascend规格时可填，例如："C78"。 updateStrategy String 驱动升级策略。可选值如下： force：强制升级，立即升级节点驱动，可能影响节点上正在运行的作业 idle：安全升级，待节点上没有作业运行时进行驱动升级 表13 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 资源池根节点名称，物理池为自己的名称。 表14 resources 参数 参数类型 描述 creating PoolResourceFlavorCount object 状态为创建中状态的资源量。 available PoolResourceFlavorCount object 状态为可用状态的资源量。 abnormal PoolResourceFlavorCount object 状态为非正常状态的资源量。 deleting PoolResourceFlavorCount object 状态为删除中状态的资源量。 表15 PoolResourceFlavorCount 参数 参数类型 描述 flavor String 资源规格名称，比如：modelarts.vm.gpu.tnt004。 count Integer 规格保障使用量。 maxCount Integer 资源规格的弹性使用量，物理池该值和count相同。 azs Array of azs objects 资源所在的AZ的数量。 表16 azs 参数 参数类型 描述 az String AZ的名称。 count Integer AZ的资源数量。 表17 scope 参数 参数类型 描述 scopeType String 业务类型。可选值如下： Train：训练任务 Infer：推理任务 Notebook：Notebook作业 state String 业务状态。可选值如下： Enabling：启动中 Enabled：已启动 Disabling：关闭中 Disabled：已关闭 表18 driver 参数 参数类型 描述 gpu PoolDriverStatus object GPU驱动信息。 npu PoolDriverStatus object NPU驱动信息。 表19 PoolDriverStatus 参数 参数类型 描述 version String 当前驱动版本。 state String 当前驱动状态。可选值如下： Creating：创建中 Upgrading：升级中 Running：运行中 Abnormal：不正常

URI GET /v2/{project_id}/pools 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 workspaceId 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 labelSelector 否 String 标签筛选。 status 否 String 资源池状态。状态为空时，返回当前有效的资源池，包括创建中和创建成功的资源池。可选值如下： created: 创建成功的资源池。 failed：创建失败的资源池，创建失败的资源池记录保留3天。 creating：创建中的资源池。

响应示例 状态码： 200 OK。 { "kind" : "NodeList", "apiVersion" : "v2", "metadata" : { }, "items" : [ { "kind" : "Node", "apiVersion" : "v2", "metadata" : { "name" : "os-node-created-zlncn", "creationTimestamp" : "2022-09-16T05:32:44Z" }, "spec" : { "flavor" : "modelarts.vm.cpu.4ud" }, "status" : { "phase" : "Available", "az" : "cn-north-7c", "privateIp" : "192.168.0.1", "resources" : { "cpu" : "3920m", "memory" : "6270Mi" }, "availableResources" : { "cpu" : "2970m", "memory" : "4558Mi" } } }, { "kind" : "Node", "apiVersion" : "v2", "metadata" : { "name" : "os-node-created-4s522", "creationTimestamp" : "2022-09-16T03:20:53Z" }, "spec" : { "flavor" : "modelarts.vm.cpu.4ud" }, "status" : { "phase" : "Available", "az" : "cn-north-7c", "privateIp" : "192.168.0.2", "resources" : { "cpu" : "3920m", "memory" : "6270Mi" }, "availableResources" : { "cpu" : "2970m", "memory" : "4558Mi" } } }, { "kind" : "Node", "apiVersion" : "v2", "metadata" : { "name" : "os-node-created-v7hfj", "creationTimestamp" : "2022-09-16T09:16:37Z" }, "spec" : { "flavor" : "modelarts.vm.cpu.4ud" }, "status" : { "phase" : "Available", "az" : "cn-north-7c", "privateIp" : "192.168.0.3", "resources" : { "cpu" : "3920m", "memory" : "6270Mi" }, "availableResources" : { "cpu" : "3720m", "memory" : "5670Mi" } } } ] } 状态码： 404 Not Found。 { "error_code" : "ModelArts.50015001", "error_msg" : "pool not found" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 apiVersion String API版本。可选值如下： v2 kind String 资源类型。可选值如下： NodeList：节点列表 metadata NodeListMetadata object 资源列表的metadata信息。 items Array of Node objects 节点列表。 表4 NodeListMetadata 参数 参数类型 描述 continue String 分页查询时，下一次查询位置。 remainingItemCount Long 剩余资源个数。 表5 Node 参数 参数类型 描述 apiVersion String API版本。可选值如下： v2 kind String 资源类型。可选值如下： Node：节点 metadata metadata object 节点metadata信息。 spec NodeSpec object 节点期望信息。 status NodeStatus object 节点状态信息。 表6 metadata 参数 参数类型 描述 name String 节点名称。 creationTimestamp String 创建时间。 表7 NodeSpec 参数 参数类型 描述 flavor String 节点规格。 表8 NodeStatus 参数 参数类型 描述 phase String 节点当前状态。可选值如下： Available：节点可用 Creating：节点创建中 Deleting：节点删除中 Abnormal：节点不正常 Checking: 节点自检中 az String 节点所在的可用区。 privateIp String 节点的IP地址。 resources NodeResource object 节点资源量信息。 availableResources NodeResource object 节点可用资源量信息。 表9 NodeResource 参数 参数类型 描述 cpu String CPU资源量。 memory String 内存资源量。 nvidia.com/gpu String GPU节点的GPU资源量。 huawei.com/ascend-snt3 String 昇腾节点的NPU资源量。 huawei.com/ascend-snt9 String 昇腾节点的NPU资源量。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

URI GET /v2/{project_id}/pools/{pool_name}/nodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 pool_name 是 String 资源池名称。 表2 Query参数 参数 是否必选 参数类型 描述 continue 否 String 分页查询时上一页位置。 limit 否 Integer 分页单次查询返回数。

响应示例 状态码： 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 表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 实例归属的用户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 OK。 { "kind" : "NetworkList", "apiVersion" : "v1", "metadata" : { }, "items" : [ { "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" : { } }, "status" : { "phase" : "Active", "connectionStatus" : { } } } ] }

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

响应示例 状态码： 200 模型列表 { "total_count" : 1, "count" : 1, "models" : [ { "model_name" : "mnist", "model_version" : "1.0.0", "model_id" : "10eb0091-887f-4839-9929-cbc884f1e20e", "model_type" : "tensorflow", "model_size" : 5012312, "tenant" : "6d28e85aa78b4e1a9b4bd83501bcd4a1", "project" : "d04c10db1f264cfeb1966deff1a3527c", "owner" : "6d28e85aa78b4e1a9b4bd83501bcd4a1", "create_at" : 1533041553000, "description" : "mnist model", "workspace_id" : "0", "specification" : { } } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 models Array of ModelListItem objects 模型元数据信息。 total_count Integer 不分页的情况下符合查询条件的总模型数量。 count Integer 符合查询条件的模型数量。 表5 ModelListItem 参数 参数类型 描述 owner String 模型所属租户的用户id。 model_version String 模型版本。 model_type String 模型类型。 description String 模型描述信息。 project String 模型所属租户的项目id。 source_type String 模型来源的类型，仅当模型为自动学习部署过来时有值，取值为auto。 model_id String 模型id。 model_source String 模型来源。auto：自动学习；algos：预置算法；custom：自定义。 install_type Array of strings 模型支持的部署类型列表。 model_size Integer 模型大小，单位为字节数。 workspace_id String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 model_status String 模型状态。 market_flag Boolean 标识模型是否来自市场。 tunable Boolean 标识模型是否支持二次调优。true表示支持，false表示不支持。 model_name String 模型名称。 create_at Long 模型创建时间，距“1970.1.1 0:0:0 UTC”毫秒数。 publishable_flag Boolean 标识模型是否可发布至市场。 source_copy String 镜像复制开关，仅当“model_type”为“Image”时有效。 true：表示复制镜像模式，无法极速创建AI应用，SWR源目录中的镜像更改或删除不影响服务部署。 false：表示不复制镜像模式，可极速创建AI应用，更改或删除SWR源目录中的镜像会影响服务部署。 不设置值时，默认为复制镜像模式。 tenant String 模型所属租户的账号id。 subscription_id String 模型订阅ID。 extra String 扩展字段。 specification ModelSpecification object 模型部署最小部署规格。 表6 ModelSpecification 参数 参数类型 描述 min_cpu String 最小CPU规格。 min_gpu String 最小GPU规格。 min_memory String 最小内存。 min_ascend String 最小Ascend规格。

URI GET /v1/{project_id}/models 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 model_name 否 String 模型名称，可支持模糊匹配。当模型名称包含下划线时，由于下划线涉及转义处理，因此需要在请求中增加exact_match参数，且参数值设置为true，确保能够正常执行查询操作。 exact_match 否 String 是否对下划线进行转义处理，当模型名称包含下划线时，需要将该参数值设置为true，确保能够正常执行查询操作。默认不填该值。 model_version 否 String 模型版本。格式需为“数值：数值：数值”，其中数值为1-2位正整数，注意：版本不可以出现例如01.01.01等以0开头的版本号形式。 model_status 否 String 模型状态，可根据模型状态执行查询。模型状态： publishing：发布中 published：已发布 failed：发布失败 building： 构建镜像中 building_failed： 构建失败 description 否 String 描述信息，可支持模糊匹配。 offset 否 Integer 指定要查询页的索引，默认为“0”。 limit 否 Integer 指定每一页返回的最大条目数，默认为“1000”。 sort_by 否 String 指定排序字段，枚举值如下： create_at：默认值，AI应用创建时间 model_version：AI应用版本 model_size：AI应用大小 order 否 String 排序方式，枚举值如下： asc: 递增排序 desc: 递减排序，默认值 workspace_id 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 model_type 否 String 模型类型，查询属于该类型的模型列表。model_type与not_model_type为互斥关系，不能同时存在。可选值为TensorFlow、PyTorch、MindSpore、Image、Custom、Template。 not_model_type 否 String 模型类型，查询不属于该类型的模型列表。可选值为TensorFlow、PyTorch、MindSpore、Image、Custom、Template。

响应示例 状态码： 200 OK { "total_number" : 2, "labels" : [ { "name" : "Rabbits", "type" : 1, "property" : { "@modelarts:color" : "#3399ff" } }, { "name" : "Bees", "type" : 1, "property" : { "@modelarts:color" : "#3399ff" } } ] }

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

响应示例 状态码： 200 OK { "total_count" : 1, "import_tasks" : [ { "status" : "COMPLETED", "task_id" : "gfghHSokody6AJigS5A_RHJ1zOkIoI3Nzwxj8nh", "dataset_id" : "gfghHSokody6AJigS5A", "import_path" : "obs://test-obs/daoLu_images/animals/", "import_type" : 0, "total_sample_count" : 20, "imported_sample_count" : 20, "annotated_sample_count" : 20, "total_sub_sample_count" : 0, "imported_sub_sample_count" : 0, "total_file_size" : 0, "finished_file_count" : 0, "finished_file_size" : 0, "total_file_count" : 0, "create_time" : 1606114833874, "elapsed_time" : 2 } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 import_tasks Array of ImportTaskStatusResp objects 导入任务列表。 total_count Integer 导入任务的数量。 表4 ImportTaskStatusResp 参数 参数类型 描述 annotated_sample_count Long 已标注样本数量。 create_time Long 任务创建时间。 data_source DataSource object 数据来源。 dataset_id String 数据集ID。 elapsed_time Long 任务运行时间，单位秒。 error_code String 错误码。 error_msg String 错误信息。 file_statistics FileCopyProgress object 文件复制进度。 finished_file_count Long 传输完成文件数。 finished_file_size Long 传输完成文件大小（字节）。 import_path String 导入的OBS路径或manifest路径。 导入manifest时，path必须精确到具体manifest文件。 导入为目录时，目前仅支持数据集类型为图片分类、物体检测、文本分类、声音分类。 import_type Integer 导入方式。可选值如下： 0：目录导入 1：按manifest文件导入 imported_sample_count Long 已导入的样本数量。 imported_sub_sample_count Long 已导入的子样本数量。 processor_task_id String 预处理任务ID。 processor_task_status Integer 预处理任务状态。 status String 导入任务的当前状态。可选值如下： QUEUING：排队中 STARTING：开始执行 RUNNING：运行中 COMPLETED：已完成 FAILED：已失败 NOT_EXIST：不存在 task_id String 任务ID。 total_file_count Long 总文件数。 total_file_size Long 总文件大小(字节)。 total_sample_count Long 样本总数量。 total_sub_sample_count Long 从父样本生成的子样本总数。 unconfirmed_sample_count Long 待确认样本数量。 update_ms Long 任务更新时间。 表5 DataSource 参数 参数类型 描述 data_path String 数据源所在路径。 data_type Integer 数据类型。可选值如下： 0：OBS桶（默认值） 1： GaussDB (DWS)服务 2： DLI 服务 3：RDS服务 4： MRS 服务 5：AI Gallery 6：推理服务 schema_maps Array of SchemaMap objects 表格数据对应的schema映射信息。 source_info SourceInfo object 导入表格数据源所需的信息。 with_column_header Boolean 文件中首行是否是列名，用于表格数据集。可选值如下： true：文件首行为列名 false：文件首行不为列名 表6 SchemaMap 参数 参数类型 描述 dest_name String 目的方的列名。 src_name String 来源方的列名。 表7 SourceInfo 参数 参数类型 描述 cluster_id String MRS集群ID。可登录MRS控制台查看。 cluster_mode String MRS集群运行模式。可选值如下： 0：普通集群 1：安全集群 cluster_name String MRS集群名称。可登录MRS控制台查看。 database_name String 导入表格数据集，数据库名字。 input String 表格数据集，HDFS路径。例如/datasets/demo。 ip String 用户GaussDB(DWS)集群的IP地址。 port String 用户GaussDB(DWS)集群的端口。 queue_name String 表格数据集，DLI队列名。 subnet_id String MRS集群的子网ID。 table_name String 导入表格数据集，表名。 user_name String 用户名，GaussDB(DWS)数据需提供此参数。 user_password String 用户密码，GaussDB(DWS)数据需提供此参数。 vpc_id String MRS集群所在的vpc的ID。 表8 FileCopyProgress 参数 参数类型 描述 file_num_finished Long 传输完成文件数。 file_num_total Long 总文件数。 file_size_finished Long 传输完成文件大小（字节）。 file_size_total Long 总文件大小(字节)。

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

URI GET /v1/{project_id}/images/group 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 镜像名称，长度限制512个字符，支持小写字母、数字、中划线、下划线和点。 name_fuzzy_match 否 Boolean 镜像名称是否模糊匹配，默认为true。 namespace 否 String 镜像所属组织,可以在SWR控制台“组织管理”创建和查看。 type 否 String 镜像类型。枚举值如下： BUILD_IN：系统内置镜像。 DEDICATED：用户保存的镜像。 workspace_id 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

响应示例 状态码： 200 OK { "current" : 1, "data" : [ { "create_at" : 1652878011643, "name" : "123", "namespace" : "cnnorth7-infer-model-dev", "update_at" : 1652878531791, "version_count" : 1 }, { "create_at" : 1671708630448, "name" : "pytorch_1_8", "namespace" : "op_svc_modelarts_container2", "update_at" : 1671708630448, "version_count" : 1 }, { "create_at" : 1671093486722, "name" : "mock-service-python", "namespace" : "mock-service1", "update_at" : 1671093486722, "version_count" : 1 } ], "pages" : 1, "size" : 3, "total" : 3 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 current Integer 当前页数。 data Array of ImageGroup objects 数据。 pages Integer 总的页数。 size Integer 每一页的数量。 total Long 总的记录数量。 表4 ImageGroup 参数 参数类型 描述 name String 镜像名称。 create_at Long 镜像创建的时间，UTC毫秒。 namespace String 镜像所述的SWR组织。 update_at Long 镜像最后更新的时间，UTC毫秒。 version_count Integer 镜像版本个数。

响应参数 状态码： 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”，存在创建并使用的工作空间，以实际取值为准。

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

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”，存在创建并使用的工作空间，以实际取值为准。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 current Integer 当前页数。 data Array of NotebookFlavor objects 分页数据。 flavors Array of NotebookFlavor objects 支持切换的规格列表。 pages Integer 总的页数。 size Integer 每一页的数量。 total Long 总的记录数量。 表4 NotebookFlavor 参数 参数类型 描述 arch String 架构类型。 X86_64 AARCH64 ascend AscendInfo object NPU信息。 billing BillingInfo object 话单信息。 category String 规格处理器类型。 CPU GPU ASCEND description String 规格描述信息。 feature String 规格类别，可选值如下： DEFAULT：CodeLab规格。 NOTEBOOK：Notebook规格。 free Boolean 是否为免费规格。 gpu GPUInfo object GPU信息。 id String 规格ID。 memory Long 内存大小。 name String 规格名称。 sold_out Boolean 资源是否充足。 true 资源不足 false 资源充足 storages Array of strings 规格支持的存储类型。 EFS EVS vcpus Integer CPU核数。 表5 AscendInfo 参数 参数类型 描述 npu Integer NPU数量。 npu_memory String NPU内存。 type String NPU类型。 表6 BillingInfo 参数 参数类型 描述 code String 计费码。 unit_num Integer 计费单元。 表7 GPUInfo 参数 参数类型 描述 gpu Integer GPU卡数。 gpu_memory String GPU内存。 type String GPU类型。

响应示例 状态码： 200 OK { "current" : 1, "data" : [ { "arch" : "x86_64", "billing" : { "code" : "modelarts.vm.cpu.2u", "unit_num" : 1 }, "category" : "CPU", "description" : "Intel CPU通用规格，用于快速数据探索和实验", "feature" : "NOTEBOOK", "free" : false, "id" : "modelarts.vm.cpu.2u", "memory" : 8388608, "name" : "CPU: 2核 8GB", "sold_out" : false, "storages" : [ "EVS", "OBSFS", "EFS", "OBS" ], "vcpus" : 2 } ], "pages" : 1, "size" : 1, "total" : 1 }

URI GET /v1/{project_id}/notebooks/flavors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 category 否 String 规格处理器类型。 CPU GPU ASCEND limit 否 Integer 每一页的数量，默认不限制。 offset 否 Integer 分页记录的起始位置偏移量，默认值0。 type 否 String 集群类型。枚举值如下： MANAGED：公共集群 DEDICATED：专属集群 sort_dir 否 String 排序方式，ASC升序，DESC降序，默认DESC。 sort_key 否 String 排序的字段，多个字段使用(“,”)逗号分割。

响应示例 状态码： 200 OK。 { "kind" : "EventList", "apiVersion" : "v1", "metadata" : { "continue" : "52eddc13-cfad-42d3-aee4-92fea5813e7f" }, "items" : [ { "kind" : "Event", "apiVersion" : "v1", "type" : "Warning", "firstTimestamp" : "2022-12-30T02:16:19Z", "lastTimestamp" : "2022-12-30T02:16:19Z", "count" : 1, "reason" : "PoolResourcesStatusChange", "message" : "Pool resources status changed, available/abnormal/creating/deleting count from 1/0/0/0 to 0/1/0/0, timestamp: 1672366579." }, { "kind" : "Event", "apiVersion" : "v1", "type" : "Normal", "firstTimestamp" : "2023-01-02T09:02:45Z", "lastTimestamp" : "2023-01-02T09:02:45Z", "count" : 1, "reason" : "PoolResourcesStatusChange", "message" : "Pool resources status changed, available/abnormal/creating/deleting count from 0/1/0/0 to 1/0/0/0, timestamp: 1672650165." }, { "kind" : "Event", "apiVersion" : "v1", "type" : "Warning", "firstTimestamp" : "2023-01-16T06:55:35Z", "lastTimestamp" : "2023-01-16T06:55:35Z", "count" : 1, "reason" : "PoolStatusChange", "message" : "Pool status changed, from Running to Abnormal, details: ." }, { "kind" : "Event", "apiVersion" : "v1", "type" : "Warning", "firstTimestamp" : "2023-01-16T06:57:51Z", "lastTimestamp" : "2023-01-16T06:57:51Z", "count" : 1, "reason" : "PoolResourcesStatusChange", "message" : "Pool resources status changed, available/abnormal/creating/deleting count from 1/0/0/0 to 0/1/0/0, timestamp: 1673852271." }, { "kind" : "Event", "apiVersion" : "v1", "type" : "Normal", "firstTimestamp" : "2023-01-29T02:29:04Z", "lastTimestamp" : "2023-01-29T02:29:04Z", "count" : 1, "reason" : "PoolStatusChange", "message" : "Pool status changed, from Abnormal to Running." } ] } 状态码： 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 资源类型。可选值如下： EventList：事件列表 metadata EventListMeta object 事件列表的元信息。 items Array of EventModel objects 事件列表。 表4 EventListMeta 参数 参数类型 描述 continue String 分页标记。 remainingItemCount Integer 分页剩余数量。 表5 EventModel 参数 参数类型 描述 apiVersion String API版本。可选值如下： v1 kind String 资源类型。可选值如下： Event：事件 type String 事件类型。可选值如下： Normal：正常 Warning：异常 firstTimestamp String 事件第一次出现时间。 lastTimestamp String 事件最后一次出现时间。 count Integer 事件连续出现次数。 reason String 事件产生的原因。 message String 事件详细信息。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

URI GET /v1/{project_id}/events 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 resource 是 String 事件所属资源类型。可选值为pools，表示资源池。 name 是 String 事件所属资源名称。 limit 否 Integer 单页查询最大数量，该值为空或者0时默认返回500条记录，单页最大允许查询500条记录。 continue 否 String 分页查询的上一页标记，内容为UUID字符串，查询第一页时为空。 since 否 Integer 事件开始时间戳。 until 否 Integer 事件结束时间戳。 type 否 String 事件类型。可选值如下： Normal：正常 Warning：异常

响应示例 状态码： 200 OK { "current" : 0, "data" : [ { "charging_mode" : "POST_PAID", "cloud_server" : { "id" : "eb8b4e32-afc9-4f71-8372-1f55f3d7ab28", "type" : "E CS " }, "create_at" : 1699352013484, "endpoints" : [ { "service" : "SSH", "uri" : "192.168.0.23" } ], "flavor" : "Si2.large.4", "id" : "c65c4f27-f791-452b-9098-a2726fa2e922", "image" : { "arch" : "X86", "image_id" : "c90fb553-2cdb-4b81-b56a-ef68812c6cf7", "name" : "Ubuntu18.04_x86_64_CPU", "server_type" : "ECS" }, "name" : "EI-evs-01", "status" : "RUNNING", "update_at" : 1699352058465, "vpc_id" : "05982b48-a70f-43a1-a2b0-1fe36a236172" }, { "charging_mode" : "POST_PAID", "cloud_server" : { "type" : "ECS" }, "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" : "CREATING", "update_at" : 1699348285077 } ], "pages" : 1, "size" : 2, "total" : 2 }