华为云用户手册

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

响应示例 状态码： 200 OK { "email" : "xxx@xxx.com", "worker_id" : "b1e4054407ecb36a7bcde70f52ba37f2", "workforce_id" : "gyb7IaAvkLc5IhEY2dv", "status" : 0, "role" : 2, "description" : "", "create_time" : 1606356324223, "update_time" : 1606356324223 }

响应示例 状态码： 200 OK { "task_version_id" : "qSaudx2sbPvthHygckA", "task_id" : "kM7j9TSa611ZzBThzSr", "version_name" : "V002", "description" : "", "status" : 0, "create_time" : 1606377874450, "inputs" : [ { "type" : "DATASET", "source" : "PYc9H2HGv5BJNwBGXyK", "version_id" : "Osc8SZ7TZStiRV4vYkZ", "name" : "dataset-test", "version_name" : "V0010" } ], "work_path" : { "type" : "DATASET", "path" : "PYc9H2HGv5BJNwBGXyK", "name" : "dataset-test", "version_name" : "V0011", "output_path" : "/test-obs/classify/output/qSaudx2sbPvthHygckA/" }, "template" : { "id" : "sys_data_validation", "name" : "name to translate", "operator_params" : [ { "name" : "MetaValidation", "advanced_params_switch" : false, "params" : { "task_type" : "image_classification", "dataset_type" : "manifest", "source_service" : "select", "filter_func" : "data_validation_select", "image_max_width" : "1920", "image_max_height" : "1920", "total_status" : "[0,1,2]" } } ] }, "duration_seconds" : 312 }

URI GET /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 task_id 是 String 数据处理任务ID。 version_id 是 String 数据处理任务的版本ID。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 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 任务更新时间。 表3 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：文件首行不为列名 表4 SchemaMap 参数 参数类型 描述 dest_name String 目的方的列名。 src_name String 来源方的列名。 表5 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。 表6 FileCopyProgress 参数 参数类型 描述 file_num_finished Long 传输完成文件数。 file_num_total Long 总文件数。 file_size_finished Long 传输完成文件大小（字节）。 file_size_total Long 总文件大小(字节)。

响应示例 状态码： 200 OK { "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, "update_ms" : 1606114833955, "create_time" : 1606114833874, "elapsed_time" : 2 }

响应示例 状态码： 200 OK { "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, "unconfirmed_sample_count" : 0, "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", "workforce_task_count" : 0, "feature_supports" : [ "0" ], "managed" : false, "import_data" : false, "label_task_count" : 1, "dataset_format" : 0, "dataset_version_count" : 3, "content_labeling" : true, "labels" : [ { "name" : "Rabbits", "type" : 0, "property" : { "@modelarts:color" : "#3399ff" } }, { "name" : "Bees", "type" : 0, "property" : { "@modelarts:color" : "#3399ff" } } ] }

URI GET /v2/{project_id}/datasets/{dataset_id} 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 check_running_task 否 Boolean 是否检测数据集中正在运行（包括初始化）的任务。可选值如下： true：检测数据集中正在运行（包括初始化）的任务 false：不检测数据集中正在运行的任务（默认值） running_task_type 否 Integer 指定需要检测的正在运行任务（包括初始化）的类型。可选值如下： 0：自动标注 1：预标注 2：导出任务 3：切换版本 4：导出manifest 5：导入manifest 6：发布版本 7：自动分组

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

URI DELETE /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id} 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 workforce_task_id 是 String 团队标注任务ID。

响应参数 状态码： 204 表2 响应Body参数 参数 参数类型 描述 error_code String 操作失败的错误码。 error_msg String 操作失败的错误信息。 results Array of BatchResponse objects 批量删除标注团队成员的结果。 success Boolean 操作是否执行成功。可选值如下： true：执行成功 false：执行失败 表3 BatchResponse 参数 参数类型 描述 error_code String 操作失败的错误码。 error_msg String 操作失败的错误信息。 success Boolean 操作是否执行成功。可选值如下： true：执行成功 false：执行失败

URI DELETE /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 worker_id 是 String 标注团队成员ID。 workforce_id 是 String 标注团队ID。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 error_code String 操作失败的错误码。 error_msg String 操作失败的错误信息。 results Array of BatchResponse objects 批量删除样本的响应列表。 success Boolean 操作是否执行成功。可选值如下： true：执行成功 false：执行失败 表4 BatchResponse 参数 参数类型 描述 error_code String 操作失败的错误码。 error_msg String 操作失败的错误信息。 success Boolean 操作是否执行成功。可选值如下： true：执行成功 false：执行失败

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 delete_source 否 Boolean 是否删除源文件，对非文本类型数据集有效(文本类型数据集因为是导入的整个文本文件，故删除一条样本不会对源文本有影响)。可选值如下： false：不删除源文件（默认值） true：删除源文件(注意：此操作可能影响已使用这些文件的数据集版本或其他数据集，导致页面展示异常或者训练/推理异常) samples 否 Array of strings 样本ID列表。

URI DELETE /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 task_id 是 String 数据处理任务ID。 version_id 是 String 数据处理任务的版本ID。

响应示例 状态码：200 OK。 { "kind" : "Network", "apiVersion" : "v1", "metadata" : { "name" : "network-7a03-86c13962597848eeb29c5861153a391f", "creationTimestamp" : "2022-09-16T09:44:59Z", "deletionTimestamp" : "2022-09-16T10:06:27Z", "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" : { "peerConnectionStatus" : [ { "peerVpcId" : "03e4f4d7-fc62-409b-9c52-df885525e30b", "peerSubnetId" : "42aeebc3-f7c7-45aa-b884-e6e9ac2f841d", "defaultGateWay" : false, "phase" : "Active" } ] } } } 状态码：404 Not Found。 { "error_code" : "ModelArts.50025001", "error_msg" : "Network not exist." }

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

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

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

URI POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/delete 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 delete_policy 否 Integer 是否删除标签及包含标签的样本。可选值如下： 0：只删除标签 1：删除标签及包含标签的样本 2：删除标签和包含标签的样本及其源文件

响应参数 状态码： 200 表8 响应Body参数 参数 参数类型 描述 error_code String 操作失败的错误码。 error_msg String 操作失败的错误信息。 results Array of BatchResponse objects 删除标签响应体。 success Boolean 操作是否执行成功。可选值如下： true：执行成功 false：执行失败 表9 BatchResponse 参数 参数类型 描述 error_code String 操作失败的错误码。 error_msg String 操作失败的错误信息。 success Boolean 操作是否执行成功。可选值如下： true：执行成功 false：执行失败

URI DELETE /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name} 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID label_name 是 String 标签名称。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 delete_source 否 Boolean 是否删除样本源文件。可选值如下： true：删除样本源文件 false：不删除样本源文件（默认值） label_type 否 Integer 标签类型。可选值如下： 0：图像分类 1：物体检测 3: 图像分割 100：文本分类 101：命名实体 102：文本三元组关系标签 103：文本三元组实体标签 200：语音分类 201：语音内容 202：语音分割 600：视频标注

响应参数 状态码：204 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪编号 状态码：401 表5 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪编号 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码：403 表7 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪编号 表8 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码：500 表9 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪编号 表10 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

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

URI DELETE /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 Query参数 参数 是否必选 参数类型 描述 workspace_id 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

响应示例 状态码：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" : [ ], "created_at" : 1698745606957, "updated_at" : 1703162934072, "bounded_api_count" : 0 } }

响应参数 状态码：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 具体错误信息。

响应参数 状态码：200 表6 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪编号 表7 响应Body参数 参数 参数类型 描述 unauth_result Array of AppAuthResultInfo objects 取消授权结果。 表8 AppAuthResultInfo 参数 参数类型 描述 api_id String API的编号。 app_id String APP的编号，可通过查询APP列表获取。 auth_id String 授权编号，授权失败时为空。 reason String 授权或者取消授权失败原因，授权成功时为空。 success Boolean 授权或者取消授权是否成功。 状态码：401 表9 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪编号 表10 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码：403 表11 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪编号 表12 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应示例 状态码：200 OK { "unauth_result" : [ { "api_id" : "logic-api-fe84e858-49ec-41c6-80d7-a34fc22435c2", "app_id" : "logic-app-9b9acb40-6df6-4623-9f87-e0dae781d867", "success" : true } ] }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表4 请求Body参数 参数 是否必选 参数类型 描述 apps 是 Array of Apps objects app列表。 workspace_id 否 String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 表5 Apps 参数 是否必选 参数类型 描述 app_id 否 String APP的编号，可通过查询APP列表获取。