华为云用户手册

URI GET /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}/results 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 task_id 是 String 数据处理任务ID。 version_id 是 String 数据处理任务的版本ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定每一页返回的最大条目数，取值范围[1,100]，默认为10。 offset 否 Integer 分页列表的起始页，默认为0。 process_parameter 否 String 图像缩略设置，同OBS缩略图设置，详见OBS缩略图设置。如：image/resize,m_lfit,h_200表示等比缩放目标缩略图并设置高度为200像素。 result_property 否 String 样本状态，不传或传-1默认返回全部样本。可选值如下： -1：全部 0：保留 1：修改 2：删除 3：新增

URI GET /v1/{project_id}/pools/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定每一页查询返回的最大条目数，默认为200。 offset 否 Integer 分页列表的起始页，默认为0。

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 tags Array of PoolTag objects 资源标签的列表。 表4 PoolTag 参数 参数类型 描述 key String 资源类型的标签 values Array of strings 资源类型的标签值 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

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

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 表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 创建时间。 annotations NodeVOAnnotations object 节点annotation 表7 NodeVOAnnotations 参数 参数类型 描述 os.modelarts/npu-topology-placement String 910卡占用拓扑信息。 将16进制转换成二进制后，比特位从右往左卡编号0-15，比特位1代表占用。 表8 NodeSpec 参数 参数类型 描述 flavor String 节点规格。 extendParams extendParams object 自定义配置参数。 os Os object 操作系统镜像信息。 表9 extendParams 参数 参数类型 描述 dockerBaseSize String 指定资源池节点的容器引擎空间大小。值为0时表示不限制大小。 表10 Os 参数 参数类型 描述 name String 操作系统名称。 imageId String 操作系统镜像id。 imageType String 操作系统镜像类型。 private：私有镜像。 表11 NodeStatus 参数 参数类型 描述 phase String 节点当前状态。可选值如下： Available：节点可用 Creating：节点创建中 Deleting：节点删除中 Abnormal：节点不正常 Checking: 节点自检中 az String 节点所在的可用区。 privateIp String 节点的IP地址。 resources NodeResource object 节点资源量信息。 availableResources NodeResource object 节点可用资源量信息。 表12 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 表13 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应示例 状态码：200 OK。 { "kind" : "NodeList", "apiVersion" : "v2", "metadata" : { }, "items" : [ { "kind" : "Node", "apiVersion" : "v2", "metadata" : { "name" : "node-dly-4", "creationTimestamp" : "2024-01-29T09:28:26Z" }, "spec" : { "flavor" : "modelarts.vm.2u4g.dcc" }, "status" : { "phase" : "Available", "az" : "cn-north-7c", "privateIp" : "192.168.1.132", "resources" : { "cpu" : "1930m", "memory" : "1912Mi" } } } ] } 状态码：400 Bad request { "error_code" : "ModelArts.50004000", "error_msg" : "Bad request. invalid nodepool name" }

请求示例 查询节点池的节点列表。 GET https://{endpoint}/v2/{project_id}/pools/{pool_name}/nodepools/{nodepool_name}/nodes { "kind" : "NodeList", "apiVersion" : "v2", "metadata" : { }, "items" : [ { "kind" : "Node", "apiVersion" : "v2", "metadata" : { "name" : "node-dly-4", "creationTimestamp" : "2024-01-29T09:28:26Z", "labels" : { "os.modelarts.node/cluster" : "dly-lite", "os.modelarts.node/nodepool" : "nodepool-1" } }, "spec" : { "flavor" : "modelarts.vm.2u4g.dcc", "hostNetwork" : { "vpc" : "277e9abc-0e6b-431a-9232-cfd25d5fc566", "subnet" : "03796378-c356-4c14-826b-e4913aa9c8b9", "securityGroups" : [ "0a15b48d-06f1-41e4-b782-ade90087bf59" ] } }, "status" : { "phase" : "Available", "az" : "cn-north-7c", "privateIp" : "192.168.1.132", "resources" : { "cpu" : "1930m", "memory" : "1912Mi" } } } ] }

响应参数 状态码：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 创建时间。 annotations NodeVOAnnotations object 节点annotation 表7 NodeVOAnnotations 参数 参数类型 描述 os.modelarts/npu-topology-placement String 910卡占用拓扑信息。 将16进制转换成二进制后，比特位从右往左卡编号0-15，比特位1代表占用。 表8 NodeSpec 参数 参数类型 描述 flavor String 节点规格。 extendParams extendParams object 自定义配置参数。 os Os object 操作系统镜像信息。 表9 extendParams 参数 参数类型 描述 dockerBaseSize String 指定资源池节点的容器引擎空间大小。值为0时表示不限制大小。 表10 Os 参数 参数类型 描述 name String 操作系统名称。 imageId String 操作系统镜像id。 imageType String 操作系统镜像类型。 private：私有镜像。 表11 NodeStatus 参数 参数类型 描述 phase String 节点当前状态。可选值如下： Available：节点可用 Creating：节点创建中 Deleting：节点删除中 Abnormal：节点不正常 Checking: 节点自检中 az String 节点所在的可用区。 privateIp String 节点的IP地址。 resources NodeResource object 节点资源量信息。 availableResources NodeResource object 节点可用资源量信息。 表12 NodeResource 参数 参数类型 描述 cpu String CPU资源量。 memory String 内存资源量。 nvidia.com/gpu String GPU节点的GPU资源量。 huawei.com/ascend-snt3 String 昇腾节点的NPU资源量。 huawei.com/ascend-snt9 String 昇腾节点的NPU资源量。 状态码：400 表13 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

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

响应示例 状态码：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 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 表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 总文件大小(字节)。

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

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。

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

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 表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 具体错误信息。

响应示例 状态码： 200 OK { "total_number" : 1, "datasets" : [ { "dataset_id" : "gfghHSokody6AJigS5A", "dataset_name" : "dataset-f9e8", "dataset_type" : 0, "data_format" : "Default", "next_version_num" : 4, "status" : 1, "data_sources" : [ { "data_type" : 0, "data_path" : "/test-obs/classify/input/animals/" } ], "create_time" : 1605690595404, "update_time" : 1605690595404, "description" : "", "current_version_id" : "54IXbeJhfttGpL46lbv", "current_version_name" : "V003", "total_sample_count" : 10, "annotated_sample_count" : 10, "work_path" : "/test-obs/classify/output/", "inner_work_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/", "inner_annotation_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/", "inner_data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/data/", "inner_log_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/logs/", "inner_temp_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/temp/", "inner_task_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/task/", "work_path_type" : 0, "workspace_id" : "0", "enterprise_project_id" : "0", "exist_running_task" : false, "exist_workforce_task" : false, "running_tasks_id" : [ ], "workforce_task_count" : 0, "feature_supports" : [ "0" ], "managed" : false, "import_data" : false, "label_task_count" : 1, "dataset_format" : 0, "content_labeling" : true, "samples" : [ { "url" : "https://test-obs.obs.xxx.com:443/classify/input/animals/15.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=tuUo9jl6lqoMKAwNBz5g8dxO%2FdE%3D", "create_time" : 1605690596035 }, { "url" : "https://test-obs.obs.xxx.com:443/classify/input/animals/8.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=NITOdBnkUXtdnKuEgDzZpkQzNfM%3D", "create_time" : 1605690596046 }, { "url" : "https://test-obs.obs.xxx.com:443/classify/input/animals/9.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=%2BwUo1BL38%2F2d7p7anPi4fNzm1VU%3D", "create_time" : 1605690596050 }, { "url" : "https://test-obs.obs.xxx.com:443/classify/input/animals/7.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=tOrHfcWo%2FEJ0wRzfi1M5Wk2MrXg%3D", "create_time" : 1605690596043 } ] } ] }

URI GET /v2/{project_id}/datasets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 check_running_task 否 Boolean 是否检测数据集中正在运行（包括初始化）的任务。可选值如下： true：检测数据集中正在运行（包括初始化）的任务 false：不检测数据集中正在运行的任务（默认值） contain_versions 否 Boolean 数据集是否包含版本。 dataset_type 否 Integer 数据集类型。可选值如下： 0：图像分类 1：物体检测 3: 图像分割 100：文本分类 101：命名实体 102：文本三元组 200：声音分类 201：语音内容 202：语音分割 400：表格数据集 600：视频标注 900：自由格式 file_preview 否 Boolean 查询数据集的同时是否支持预览。可选值如下： true：支持预览，同时返回一部分数据集文件列表，每个数据集返回4个。 false：不支持预览（默认值）。 limit 否 Integer 指定每一页返回的最大条目数，取值范围[1,100]，默认为10。 offset 否 Integer 分页列表的起始页，默认为0。 order 否 String 指定查询的排序顺序。可选值如下： asc：递增排序 desc：递减排序（默认值） running_task_type 否 Integer 指定需要检测的正在运行任务（包括初始化）的类型。可选值如下： 0：自动标注 1：预标注 2：导出任务 3：切换版本 4：导出manifest 5：导入manifest 6：发布版本 7：自动分组 search_content 否 String 模糊匹配名称，默认为空。 sort_by 否 String 指定查询的排序方式。可选值如下： create_time：按创建时间排序（默认值） dataset_name：按数据集名称排序 support_export 否 Boolean 是否过滤只支持导出的数据集（当前仅图像分类、物体检测、自由格式三种数据集支持导出），不传该参数或参数取值为false表示不过滤。可选值如下： true：过滤只支持导出的数据集 false：不过滤只支持导出的数据集（默认值） train_evaluate_ratio 否 String 根据版本切分比例筛选数据集。例如：“0.0,1.0”，根据逗号分隔最小和最大切分比例，筛选出切分比例在此范围内的版本。说明：如果参数值为空或无该参数，系统默认不根据版本切分比例筛选数据集。 version_format 否 Integer 根据数据集发布的版本格式筛选数据集，过滤出包含符合筛选条件的数据集列表。可选值如下： 0：默认格式 1：Carbon格式（仅表格数据集支持） 2： CS V格式 with_labels 否 Boolean 返回数据集的标签。可选值如下： true：返回标签信息 false：不返回标签信息（默认值） workspace_id 否 String 工作空间ID。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 dataset_version 否 String 数据集版本（用于区分标注任务解耦前的数据集和解耦后的数据集）。可选值如下： v1：数据集与标注任务解耦前的数据集（默认值） v2：数据集与标注任务解耦后的数据集 all：所有数据集

响应示例 状态码： 200 OK { "total_number" : 3, "versions" : [ { "version_id" : "54IXbeJhfttGpL46lbv", "version_name" : "V003", "version_format" : "Default", "previous_version_id" : "eSOKEQaXhKzxN00WKoV", "status" : 1, "create_time" : 1605930512183, "total_sample_count" : 10, "annotated_sample_count" : 10, "total_sub_sample_count" : 0, "annotated_sub_sample_count" : 0, "manifest_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V003/V003.manifest", "data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V003/data/", "is_current" : true, "analysis_status" : 3, "train_evaluate_sample_ratio" : "0.8", "remove_sample_usage" : false, "export_images" : false, "description" : "", "task_type" : 0, "extract_serial_number" : false }, { "version_id" : "eSOKEQaXhKzxN00WKoV", "version_name" : "V002", "version_format" : "Default", "previous_version_id" : "vlGvUqOcxxGPIB0ugeE", "status" : 1, "create_time" : 1605691027084, "total_sample_count" : 10, "annotated_sample_count" : 10, "total_sub_sample_count" : 0, "annotated_sub_sample_count" : 0, "manifest_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V002/V002.manifest", "data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V002/data/", "is_current" : false, "analysis_status" : 3, "train_evaluate_sample_ratio" : "0.9999", "remove_sample_usage" : false, "export_images" : false, "description" : "", "task_type" : 0, "extract_serial_number" : false }, { "version_id" : "vlGvUqOcxxGPIB0ugeE", "version_name" : "V001", "version_format" : "Default", "status" : 1, "create_time" : 1605690687346, "total_sample_count" : 10, "annotated_sample_count" : 10, "total_sub_sample_count" : 0, "annotated_sub_sample_count" : 0, "manifest_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V001/V001.manifest", "data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V001/data/", "is_current" : false, "analysis_status" : 3, "train_evaluate_sample_ratio" : "0.99", "remove_sample_usage" : false, "export_images" : false, "description" : "", "task_type" : 0, "extract_serial_number" : false } ] }

URI GET /v2/{project_id}/datasets/{dataset_id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 Integer 数据集版本状态。可选值如下： 0：创建中 1：运行中 2：删除中 3：已删除 4：错误 train_evaluate_ratio 否 String 根据版本切分比例筛选版本。根据逗号分隔最小和最大切分比例，筛选出切分比例在此范围内的版本，例如：“0.0,1.0”。说明：如果参数值为空或无该参数，系统默认不根据版本切分比例筛选数据集。 version_format 否 Integer 数据集版本格式。可选值如下： 0：默认格式 1：Carbon格式（仅表格数据集支持） 2：CSV格式 offset 否 Integer 分页列表的起始页，默认为0。 limit 否 Integer 指定每一页返回的最大条目数，取值范围[1,1000]，默认为1000。

响应示例 状态码：200 服务部署规格列表。 { "total_count" : 1, "count" : 1, "clusters" : [ { "cluster_id" : "ff808081673fbb3d01673fbb824d0000", "cluster_name" : "my-cluster", "description" : "", "tenant" : "tenant_id", "project" : "project_id", "owner" : "owner_id", "created_at" : 1574923077927, "status" : "running", "nodes" : { "specification" : "modelarts.vm.cpu.8ud", "count" : 1, "available_count" : 1 }, "allocatable_cpu_cores" : 5.5, "allocatable_memory" : 4096, "allocatable_gpus" : 0.5 } ] }

URI GET /v1/{project_id}/clusters 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 cluster_name 否 String 集群名称，默认不过滤集群名。 status 否 String 集群状态，默认不过滤状态。 offset 否 Integer 分页列表的起始页，默认为0。 limit 否 Integer 指定每一页返回的最大条目数，默认为1000。 sort_by 否 String 指定排序字段，枚举值如下： created_at: 创建时间，默认值。 cluster_name: 集群名称。 order 否 String 排序方式，枚举值如下： asc: 递增排序 desc: 递减排序，默认值

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 不分页的情况下符合查询条件的总集群数量。 count Integer 当前查询结果的集群数量，不设置offset、limit查询参数时，count与total相同。 clusters Array of Cluster objects 查询到的集群列表。 表5 Cluster 参数 参数类型 描述 owner String 集群归属用户。 cluster_name String 集群名称。 period_num Integer 对应订购周期的个数，仅当集群为包周期类型时返回。 created_at Integer 集群创建时间，距“1970.1.1 0:0:0 UTC”的毫秒数。 description String 集群备注。 project String 集群归属项目。 allocatable_memory Integer 可使用的内存数。 cluster_id String 集群ID。 nodes ClusterNode object 集群节点配置。 allocatable_cpu_cores Float 可使用的CPU核数。 product_id String 产品ID，仅当集群为包周期类型时返回。 allocatable_gpus Float 可使用的GPU核数。 order_id String 购买产品的订单ID，仅当集群为包周期类型时返回。 period_type String 订购周期类型，取值year或month，仅当集群为包周期类型时返回。 tenant String 集群归属租户。 status String 集群状态，取值为： deploying：部署中 running：运行中 concerning：告警 abnormal：异常 表6 ClusterNode 参数 参数类型 描述 available_count Integer 可用节点数。 count Integer 节点数。 specification String 节点规格。

URI GET /v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 high_score 否 String 置信度上界，默认为1。 label_name 否 String 标签名。 label_type 否 Integer 标注类型。可选值如下： 0：图像分类 1：物体检测 3: 图像分割 100：文本分类 101：命名实体 102：文本三元组 200：声音分类 201：语音内容 202：语音分割 400：表格数据集 600：视频标注 900：自由格式 limit 否 Integer 指定每一页返回的最大条目数，取值范围[1,100]，默认为10。 low_score 否 String 置信度下界，默认为0。 offset 否 Integer 分页列表的起始页，默认为0。 order 否 String 指定查询的排序顺序。可选值如下： asc：递增排序 desc：递减排序（默认值） process_parameter 否 String 图像缩略设置，同OBS缩略图设置，详见OBS缩略图设置。如：image/resize,m_lfit,h_200表示等比缩放目标缩略图并设置高度为200像素。 search_conditions 否 String URL编码后的多维筛选条件（多个SearchCondition之间为and的关系）。

响应示例 状态码： 200 OK { "sample_count" : 1, "samples" : [ { "sample_id" : "10de574cbf0f09d4798b87ba0eb34e37", "sample_type" : 0, "labels" : [ { "name" : "sunflowers", "type" : 0, "id" : "1", "property" : { "@modelarts:hard_coefficient" : "0.0", "@modelarts:hard" : "false" }, "score" : 1.0 } ], "source" : "https://test-obs.obs.xxx.com:443/animals/8_1597649054631.jpeg?AccessKeyId=alRn0xskf5luJaG2jBJe&Expires=1606299230&x-image-process=image%2Fresize%2Cm_lfit%2Ch_200&Signature=MNAAjXz%2Fmwn%2BSabSK9wkaG6b6bU%3D", "metadata" : { "@modelarts:hard_coefficient" : 1.0, "@modelarts:hard" : true, "@modelarts:import_origin" : 0, "@modelarts:hard_reasons" : [ 8, 6, 5, 3 ] }, "sample_time" : 1601432758000, "sample_status" : "UN_ANNOTATION" } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 apps Array of ApigAppDetailInfo objects APP基础信息数组，可能为空数组。 count Integer 查询到的APP数量。 total_count Integer 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 具体错误信息。