华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 items Array of ProcessorTaskItem objects 算法类别的列表。 total Integer 总数。 表4 ProcessorTaskItem 参数 参数类型 描述 label_en String 算法类别的英文名称。 label_zh String 算法类别名称。 template_id String 算法类别的ID。

响应示例 状态码： 200 OK { "total" : 4, "items" : [ { "template_id" : "sys_data_cleaning", "label_zh" : "label_zh to translate", "label_en" : "data cleaning" }, { "template_id" : "sys_data_validation", "label_zh" : "label_zh to translate", "label_en" : "data validation" }, { "template_id" : "sys_data_selection", "label_zh" : "label_zh to translate", "label_en" : "data selection" }, { "template_id" : "sys_data_augmentation", "label_zh" : "label_zh to translate", "label_en" : "data augmentation" } ] }

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

URI GET /v2/{project_id}/datasets/{dataset_id}/export-tasks 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 export_type 否 Integer 导出类型，不传则默认查询所有类型的导出任务。可选值如下： 0：已标注 1：未标注 2：全部 3：条件筛选 limit 否 Integer 指定每一页返回的最大条目数，取值范围[1,100]，默认为10。 offset 否 Integer 分页列表的起始页，默认为0。

响应示例 状态码： 200 OK { "total_count" : 2, "export_tasks" : [ { "task_id" : "rF9NNoB56k5rtYKg2Y7", "path" : "/test-obs/classify/input/", "export_type" : 3, "version_format" : "Default", "export_format" : 2, "export_params" : { "sample_state" : "", "export_dest" : "NEW_DATASET", "export_new_dataset_name" : "dataset-export-test", "export_new_dataset_work_path" : "/test-obs/classify/output/", "clear_hard_property" : true, "train_sample_ratio" : 1.0, "ratio_sample_usage" : false }, "status" : "SUC CES SED", "progress" : 100.0, "total_sample_count" : 20, "finished_sample_count" : 20, "create_time" : 1606103820120, "update_time" : 1606103824823 }, { "task_id" : "TZMuy7OKbClkGCAc3gb", "path" : "/test-obs/daoChu/", "export_type" : 3, "version_format" : "Default", "export_format" : 2, "export_params" : { "sample_state" : "", "export_dest" : "DIR", "clear_hard_property" : true, "clear_difficult" : false, "train_sample_ratio" : 1.0, "ratio_sample_usage" : false }, "status" : "SUCCESSED", "progress" : 100.0, "total_sample_count" : 20, "finished_sample_count" : 20, "create_time" : 1606103424662, "update_time" : 1606103497519 } ] }

URI GET /v2/{project_id}/datasets/{resource_id}/export-tasks/{task_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 resource_id 是 String 资源ID，当前支持传数据集ID。 task_id 是 String 导出任务ID。

响应示例 状态码： 200 OK { "task_id" : "TZMuy7OKbClkGCAc3gb", "path" : "/test-obs/daoChu/", "export_type" : 3, "version_format" : "Default", "export_format" : 2, "export_params" : { "sample_state" : "", "export_dest" : "DIR", "clear_hard_property" : true, "train_sample_ratio" : 1.0, "ratio_sample_usage" : false }, "status" : "RUNNING", "progress" : 0.0, "create_time" : 1606103424662, "update_time" : 1606103494124 }

响应示例 状态码： 200 OK { "label_stats" : [ { "name" : "Bees", "type" : 1, "property" : { "@modelarts:color" : "#3399ff" }, "count" : 8, "sample_count" : 5 } ], "sample_stats" : { "un_annotation" : 309, "all" : 317, "total" : 317, "deleted" : 0, "manual_annotation" : 8, "auto_annotation" : 0, "lefted" : 317 }, "key_sample_stats" : { "total" : 317, "non_key_sample" : 315, "key_sample" : 2 }, "metadata_stats" : { }, "data_spliting_enable" : false }

URI GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/stats 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 email 否 String 标注团队成员邮箱。 locale 否 String 语言。可选值如下： zh-cn：中文 en-us：英文（默认值） 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 { "metrics" : { "un_annotation" : { "1606233612612" : 16, "1606320012681" : 16 }, "failed_user" : { }, "total" : { "1606233612612" : 16, "1606320012681" : 16 }, "queuing" : { }, "success" : { }, "unfinished" : { }, "manual_annotation" : { "1606233612612" : 0, "1606320012681" : 0 }, "failed" : { }, "failed_system" : { } } }

URI GET /v2/{project_id}/datasets/{dataset_id}/metrics 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 end_time 是 Long 监控信息的截止时间。 start_time 是 Long 监控信息的起始时间。 workforce_task_id 否 String 团队标注任务ID。

响应示例 状态码： 200 OK { "total_count" : 1, "auth" : [ { "user_id" : "****d80fb058844ae8b82aa66d9fe****", "user_name" : "iam-user01", "type" : "agency", "content" : "modelarts_agency", "create_time" : 15657747821288 } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total_count Number 授权信息总数。 auth Array of AuthorizationResponse objects 授权信息列表。 表4 AuthorizationResponse 参数 参数类型 描述 user_id String 用户ID，获取方法请参见获取用户ID和名称。 当user_id为all时，表示对所有 IAM 子用户进行授权，如果已有部分用户已授权，则更新授权。 仅当授权类型为委托时，需要该字段。 type String 授权类型。推荐使用委托方式。 可选值： agency：委托 credential：访问密钥（AK/SK） content String 授权内容。 当授权类型是委托，该字段为委托名称。 当授权类型是访问密钥，该字段为访问密钥ID（AK）。 secret_key String 秘密访问密钥（SK）。仅当授权类型为访问密钥时，需要该字段。 user_name String 用户名，当user_id为all-users时，显示为所有用户。 create_time Long 创建时间戳。

URI GET /v2/{project_id}/authorizations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 sort_by 否 String 指定排序字段。枚举值如下： user_name：IAM用户名称 create_time：创建时间 order 否 String 排序方式。枚举值如下： asc：递增排序 desc：递减排序 limit 否 Integer 指定每一页返回的最大条目数，默认为1000。 取值范围[1，1000]。 offset 否 Integer 分页列表的起始页，默认为0。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 apis Array of AuthTypeApiBasicInfo objects API认证信息列表。 count Integer 查询数据个数。 total_count Integer 数据总量。 表5 AuthTypeApiBasicInfo 参数 参数类型 描述 api_id String API编号。 api_method String 请求方式包含GET、POST、PUT、DELETE、HEAD、PATCH、OPTIONS、ANY，固定返回ANY。 api_name String API名称。 api_remark String API描述。字符长度不超过255。 auth_type String API的认证方式。枚举值如下： NONE：无认证 APP：APP认证 IAM：IAM认证 predict_url String 预测地址。 service_id String 服务编号。 service_name String 服务名称。 support_app_code Boolean 是否支持APP CODE。

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 api AuthTypeApiBasicInfo object API认证详情。 表5 AuthTypeApiBasicInfo 参数 参数类型 描述 api_id String API编号。 api_method String 请求方式包含GET、POST、PUT、DELETE、HEAD、PATCH、OPTIONS、ANY，固定返回ANY。 api_name String API名称。 api_remark String API描述。字符长度不超过255。 auth_type String API的认证方式。枚举值如下： NONE：无认证 APP：APP认证 IAM：IAM认证 predict_url String 预测地址。 service_id String 服务编号。 service_name String 服务名称。 support_app_code Boolean 是否支持APP CODE。 状态码： 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 具体错误信息。

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

响应示例 状态码： 200 OK { "api" : { "api_id" : "7e0d272df0e94297b7d4046bada3f158", "api_name" : "infer_ae20fc9fb37c48c28ebc3f3a638c9f48", "api_method" : "ANY", "predict_url" : "https://b86b2d069324491fbd66940e4533b45c.apig.xxxxxx.com/v1/infers/ae20fc9f-b37c-48c2-8ebc-3f3a638c9f48", "support_app_code" : true, "service_id" : "ae20fc9f-b37c-48c2-8ebc-3f3a638c9f48", "service_name" : "service-3c02", "auth_type" : "APP", "api_remark" : "test" } }

请求示例 创建导出（导出到OBS）任务 { "path" : "/test-obs/daoChu/", "export_type" : 3, "export_params" : { "sample_state" : "", "export_dest" : "DIR" } } 创建导出（导出新数据集）任务 { "path" : "/test-obs/classify/input/", "export_type" : 3, "export_params" : { "sample_state" : "", "export_dest" : "NEW_DATASET", "export_new_dataset_name" : "dataset-export-test", "export_new_dataset_work_path" : "/test-obs/classify/output/" } }

响应示例 状态码： 200 OK { "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=4D34AYDTK93HUY79NSD7&Expires=1606300437&x-obs-security-token=gQpjbi1ub3J0aC03jELficNKUP87aSTIhvsHQAvImcyVbXlYTrU2XJIc28F7kiXanJ3TyJV39iXl0yi5mzQ...", "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 } ] }

URI GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples/{sample_id} 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 sample_id 是 String 样本ID。 workforce_task_id 是 String 标注任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 locale 否 String 语言。可选值如下： zh-cn：中文 en-us：英文（默认值） 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__：待确认 worker_id 否 String 标注成员ID。

响应示例 状态码： 200 OK { "sample_id" : "012f99f3cf405860130b6ed2350c2228", "sample_type" : 0, "labels" : [ { "name" : "car", "type" : 0, "property" : { } } ], "source" : "https://test-obs.obs.xxx.com:443/image/aifood/%E5%86%B0%E6%BF%80%E5%87%8C/36502.jpg?AccessKeyId=RciyO7RHmhNTfOZVryUH&Expires=1606297079&Signature=Ju4FYpEu973ii%2FAdUVLTfpLCTbg%3D", "metadata" : { "@modelarts:import_origin" : 0 }, "sample_time" : 1589190552106, "sample_status" : "MANUAL_ANNOTATION", "labelers" : [ { "email" : "xxx@xxx.com", "worker_id" : "5d8d4033b428fed5ac158942c33940a2", "role" : 0 } ] }

URI GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/{sample_id} 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 sample_id 是 String 样本ID。 表2 Query参数 参数 是否必选 参数类型 描述 locale 否 String 语言。可选值如下： zh-cn：中文 en-us：英文（默认值） 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__：待确认 worker_id 否 String 标注成员ID。

响应示例 状态码： 200 OK { "task_id" : "AcYfsdfhGyrWL5TtahH", "name" : "V002", "data_source" : { "type" : "DATASET", "source" : "X6c3N3eztX7cr3Arvqu" }, "inputs" : [ { "type" : "DATASET", "source" : "X6c3N3eztX7cr3Arvqu" } ], "template" : { "id" : "sys_data_analyse", "name" : "data analyse template name", "operator_params" : [ { "id" : "sys_data_analyse", "params" : { "op_list" : [ ], "task_type" : "image_classification", "manifest_path" : "s3://lch-test-obs/classify/output/dataset-3026-X6c3N3eztX7cr3Arvqu/annotation/V002/V002.manifest", "file_path" : "s3://lch-test-obs/classify/output/dataset-3026-X6c3N3eztX7cr3Arvqu/annotation/evaluation/V002", "is_normed" : false } } ] }, "status" : 2, "duration_seconds" : 22, "create_time" : 1606373999627, "result" : "xxx", "version_id" : "XwTuRqI9En7xuZskW70", "is_current" : true }

响应示例 状态码： 200 OK { "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" : true, "analysis_status" : 3, "train_evaluate_sample_ratio" : "0.9999", "remove_sample_usage" : false, "export_images" : false, "description" : "", "label_stats" : [ { "name" : "Rabbits", "type" : 0, "property" : { "@modelarts:color" : "#3399ff" }, "count" : 5, "sample_count" : 5 }, { "name" : "Bees", "type" : 0, "property" : { "@modelarts:color" : "#3399ff" }, "count" : 5, "sample_count" : 5 } ], "label_type" : "single", "task_type" : 0, "extract_serial_number" : false }

响应示例 状态码： 200 OK { "sample_id" : "0059c1b9458a2da9443af684b5099b4e", "sample_type" : 0, "labels" : [ { "name" : "Bees", "type" : 0, "id" : "1", "property" : { "@modelarts:hard_coefficient" : "0.0", "@modelarts:hard" : "false" }, "score" : 0.66 } ], "source" : "https://test-obs.obs.xxx.com:443/data/3_1597649054631.jpg?AccessKeyId=RciyO7RHmhNTfOZVryUH&Expires=1606299474&Signature=anOLGOHPSrj3WXUHVc70tAxWlf4%3D", "metadata" : { "@modelarts:hard_coefficient" : 0.0, "@modelarts:hard" : false, "@modelarts:import_origin" : 0, "@modelarts:hard_reasons" : [ ] }, "sample_time" : 1600490651933, "sample_status" : "UN_ANNOTATION" }

URI GET /v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples/{sample_id} 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 sample_id 是 String 样本ID。

URI GET /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。 表2 Query参数 参数 是否必选 参数类型 描述 label_stats 否 Boolean 是否返回标签统计信息。可选值如下： true：返回标签统计信息 false：不返回标签统计信息（默认值） sample_stats 否 Boolean 是否返回样本统计信息。可选值如下： true：返回样本统计信息 false：不返回样本统计信息（默认值） workforce_stats 否 Boolean 是否返回人员统计信息。可选值如下： true：返回人员统计信息 false：不返回人员统计信息（默认值）

响应示例 状态码： 200 OK { "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", "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, "worker_stats" : [ { "email" : "xxx@xxx.com", "worker_id" : "afdda13895bc66322ffbf36ae833bcf0", "role" : 0, "task_id" : "iYZx7gScPUozOXner9k", "workforce_task_name" : "task-e63f", "dataset_id" : "WxCREuCkBSAlQr9xrde", "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 }, "create_time" : 1606184400278, "update_time" : 1606184795050, "email_status" : 3, "last_notify_time" : 0 } ] }