华为云用户手册

请求示例 对任务ID为{task_id}的任务做停止操作 /v2/{project_id}/tasks/{task_id}/action/{command} { "id" : "String", "status_code" : 200, "status_msg" : "success" } 对任务ID为{task_id}的任务做启动操作 /v2/{project_id}/tasks/{task_id}/action/{command} { "id" : "String", "status_code" : 200, "status_msg" : "success" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 video_source_name String 视频源名称，只支持中文、英文字母（a-z、A-Z）、数字、特殊字符（空格.-_() （）），不能以空格开头和结尾。 最小长度：1 最大长度：100 access_type String 接入类型（cloud、edge）。 status VideoSourceStatusInfoDto object 数据源状态。 type String 类型:obs、vcn、url、restful、camera。 latitude String 视频源的地理位置信息，纬度，-90.00000~90.00000。 longitude String 视频源的地理位置信息，经度，-180.00000~180.00000。 create_at Long 创建时间。 type_config String 视频源配置信息xml。 video_packages Array of VideoGroupInfoDto objects 视频源所在分组。 service_config_templates Array of VideoServiceConfigTemplateDto objects 算法模板体。 stream_path String 流地址。 image String 视频源截图的base64转码。 tag Array of strings 视频源标签，标签最多选择4个，标签内容只能由中文，英文字母(a~z, A~Z)、数字(0~9)、中划线(-)、下划线(_)组成。 最小长度：1 最大长度：10 scene_recommend Array of strings 智能算法推荐的标签。 video_source_quality Array of strings 视频源的视频流质量： Blurry：画面模糊； ColorDistortion：画面颜色失真； AbnormalLight：画面光线异常； ScreenSplash：画面花屏异常； ScreenJitter：画面抖动； ScreenMovement：画面移动； SceneUpheaval：画面剧变； ScreenFreeze：画面冻结； BlackScreen：黑屏； SnowNoise：雪花噪声； Occlude：遮挡; GrayScreen：灰屏； ScreenSmudge：画面污迹 表4 VideoSourceStatusInfoDto 参数 参数类型 描述 status String 视频源状态。 name String 状态中文名。 level String 状态等级（用于前端图片颜色匹配）。 表5 VideoGroupInfoDto 参数 参数类型 描述 video_group_id String 视频源所在分组id。 video_group_name String 视频源所在分组名称。 description String 视频源所在分组描述。 access_type String 接入方式（cloud、edge）。 create_at Long 创建时间。 modify_at Long 修改时间。 num_video_source Integer 视频源数量。 group_status GroupStatusDto object 视频源状态。 num_batch_task Integer 已配置批量作业数量。 表6 GroupStatusDto 参数 参数类型 描述 num_online Integer 在线视频源数量。 num_exception Integer 异常视频源数量。 num_offline Integer 离线视频源数量。 表7 VideoServiceConfigTemplateDto 参数 参数类型 描述 name String 算法服务名称。 roi String 公共roi。 serviceConfig String 算法服务公共配置。 createAt Long 创建时间。 modifyAt Long 修改时间。 numTask Integer 已运行算法数量。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息描述。 detail String 错误详情。 params Array of strings 错误参数列举。 reason String 错误原因。 advice String 建议。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息描述。 detail String 错误详情。 params Array of strings 错误参数列举。 reason String 错误原因。 advice String 建议。

URI GET /v2/{project_id}/source/sources/{video_source_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法参见获取项目ID和名称。 video_source_id 是 String 已创建成功的视频源id，只能由小写英文字母(a~z)、数字(0~9)、中划线(-)、下划线(_)组成, 长度范围为[4, 36]。

响应示例 状态码： 200 视频源分组信息 { "video_group_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx", "video_group_name" : "test000", "description" : "", "access_type" : "cloud", "create_at" : 1680773327730, "modify_at" : 1680773463291, "num_video_source" : 2, "group_status" : { "num_online" : 2, "num_exception" : 0, "num_offline" : 0 }, "num_batch_task" : 0 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 video_group_id String 视频源所在分组id video_group_name String 视频源所在分组名称 description String 视频源所在分组描述 access_type String 接入方式（cloud、edge） create_at Long 创建时间 modify_at Long 修改时间 num_video_source Integer 视频源数量 group_status GroupStatusDto object 视频源状态 num_batch_task Integer 已配置批量作业数量 表4 GroupStatusDto 参数 参数类型 描述 num_online Integer 在线视频源数量 num_exception Integer 异常视频源数量 num_offline Integer 离线视频源数量

URI GET /v2/{project_id}/video-group/{video_group_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法参见获取项目ID和名称。 video_group_id 是 String 视频源分组id，只能由小写英文字母(a~z)、数字(0~9)、中划线(-)、下划线(_)组成长度范围是[4,36]。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 service_id String 服务ID service_name String 服务名称 logo String 算法图标，Base64编码格式的字符串，非空时返回 function_version String 功能版本 release_flag Boolean 是否已发布，取值为“true”或者“false” description String 算法描述，非空时返回 created_at Long 创建时间 updated_at Long 更新时间 release_at Long 发布时间 api String API pool_id String 资源池ID alg_name String 算法名称 alg_id String 算法ID request_mode String 请求模式，取值为“sync”或者“async” package_name String 算法包名称 package_id String 算法包ID alg_version String 算法版本 alg_versions Array of strings 算法历史版本 diagram String 算法场景图，Base64编码格式的字符串，非空时返回 service_api_list Array of ServiceApiDto objects 服务API列表 deployment_constraints DeploymentConstraintsDto object 模型部署约束 company String 厂商名称 tags Array of strings 应用场景标签 deploy_type String 部署类型，取值为“cloud”或者“edge” alg_class String 算法类别，取值为“self”或者“partner” alg_status String 算法状态，取值为“service_running”、“service_deploying”、“service_failed”、“service_stopping”、“service_stopped”、“service_upgrading”、“service_finished”、“service_concerning”或者“not_deployed” error_msg String 服务异常信息，非空时返回 表4 ServiceApiDto 参数 参数类型 描述 request_type String 请求类型，get, post zh String 中文描述 en String 英文描述 request_url String 请求url 表5 DeploymentConstraintsDto 参数 参数类型 描述 request_mode String 请求模式，取值为“sync”或者“async” cpu_type String CPU类型，取值为“x86_64”或者“aarch64” accelerators Array of AcceleratorsDto objects 推理加速卡 input_types Array of strings 支持的输入类型，列表元素取值为“OBS”、“URL”、“Restful”、“VCN”、“EdgeCamera” output_types Array of strings 支持的输出类型，列表元素取值为“OBS”、“DIS”或者“Webhook” service_config String 服务启动参数 task_config String 作业配置参数 表6 AcceleratorsDto 参数 参数类型 描述 type String 加速卡类型 name String 加速卡名称 cuda_version String CUDA版本 driver_version_section String 昇腾驱动版本

响应示例 状态码： 200 边缘资源池详情响应体 { "id" : "xxx", "name" : "yundao2", "state" : "Running", "project_id" : "xxx", "workspace_id" : "0", "created_at" : 1683344661036, "updated_at" : 1683344661036, "nodes" : [ { "id" : "xxx", "name" : "测试边缘节点-2", "state" : "Running", "cpu" : 16, "arch" : "x86_64", "enable_gpu" : true, "enable_npu" : false, "memory" : 64263, "gpu_info" : [ { "name" : "gp0", "driver_version" : "418.67", "type" : "Tnt004", "capacity" : "15079Mi" } ], "npu_info" : [ ] } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 边缘池ID。 name String 边缘池名称。 description String 描述信息。 state String 边缘池状态。 project_id String 用户项目ID。 workspace_id String 工作空间ID。 created_at Long 创建时间。 updated_at Long 更新时间。 nodes Array of EdgeNodeInfoDto objects 边缘节点列表。 表4 EdgeNodeInfoDto 参数 参数类型 描述 id String 边缘节点ID。 name String 边缘池名称。 description String 描述信息。描述为空则不返回该字段。 state String 边缘池状态 cpu Integer CPU核心数量。 arch String 计算机架构。 enable_gpu Boolean 是否使用GPU。 enable_npu Boolean 是否使用NPU。 memory Integer 内存大小。 gpu_info Array of GpuInfo objects GPU信息。 npu_info Array of NpuInfo objects NPU信息。 表5 GpuInfo 参数 参数类型 描述 name String GPU卡名称。 driver_version String GPU卡驱动版本。 type String GPU卡类型。 capacity String GPU卡容量。 表6 NpuInfo 参数 参数类型 描述 name String NPU卡名称。 driver_version String NPU卡驱动版本。 type String NPU卡类型。 capacity String NPU卡容量。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息描述。 detail String 错误详情。 params Array of strings 错误参数列举。 reason String 错误原因。 advice String 建议。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息描述。 detail String 错误详情。 params Array of strings 错误参数列举。 reason String 错误原因。 advice String 建议。

URI GET /v2/{project_id}/source/sources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 scope 否 String 模糊查找参数，可选，根据名称查找。 scope_name 否 String 模糊查找参数字段名，可选，名称(取值source_name)或分组名称(取值group_name)。 status 否 Array of strings 视频源状态，可选，取值为1 2 9，分别代表在线、离线、异常。 type 否 Array of strings 类型：obs、vcn、url、restful、camera、ivm。 video_group_id 否 Array of strings 视频源分组，可选。若传入则需要符合正则表达式^[0-9a-zA-Z-_]{1,36}$。 sort_name 否 String 排序项。可选，值范围（create_at，num_task，num_template）。 order_by 否 String 排序顺序，可选，默认倒序。 is_paged 否 Boolean 是否分页。 page_size 否 Integer 分页每页显示的条目。 page_num 否 Integer 第几页。 access_type 否 Array of strings 接入方式。 platform_name 否 String 平台名称。 tag 否 String 标签。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 video_source_number Integer 视频源数量。 total_number Integer 视频源总数。 quota_number Integer 视频源限额。 video_source_list Array of ListVideoSourceInfoDto objects 视频源列表数据。 表5 ListVideoSourceInfoDto 参数 参数类型 描述 video_source_id String 已创建成功的视频源id。 video_source_name String 视频源名称，只支持中文、英文字母（a-z、A-Z）、数字、特殊字符（空格.-_() （）），不能以空格开头和结尾。 最小长度：1 最大长度：100 status VideoSourceStatusInfoDto object 视频源状态。 access_type String 接入类型（cloud、edge）。 type String 类型:obs、vcn、url、restful、camera。 latitude String 视频源的地理位置信息，纬度，-90.00000~90.00000。 longitude String 视频源的地理位置信息，经度，-180.00000~180.00000。 create_at Long 创建时间。 video_packages Array of VideoGroupInfoDto objects 视频源所在分组。 num_tasks Integer 视频源已运行算法作业数量。 num_service_config_templates Integer 视频源算法服务配置模板数量。 type_config String 视频源配置信息xml。 tag Array of strings 视频源标签，标签最多选择4个，标签内容只能由中文，英文字母(a~z, A~Z)、数字(0~9)、中划线(-)、下划线(_)组成。 最小长度：1 最大长度：10 stream_path String 流地址。 scene_recommend Array of strings 智能算法推荐的标签。 video_source_quality Array of strings 视频源的视频流质量： Blurry：画面模糊； ColorDistortion：画面颜色失真； AbnormalLight：画面光线异常； ScreenSplash：画面花屏异常； ScreenJitter：画面抖动； ScreenMovement：画面移动； SceneUpheaval：画面剧变； ScreenFreeze：画面冻结； BlackScreen：黑屏； SnowNoise：雪花噪声； Occlude：遮挡; GrayScreen：灰屏；ScreenSmudge：画面污迹 表6 VideoSourceStatusInfoDto 参数 参数类型 描述 status String 视频源状态 name String 状态中文名 level String 状态等级（用于前端图片颜色匹配） 表7 VideoGroupInfoDto 参数 参数类型 描述 video_group_id String 视频源所在分组id video_group_name String 视频源所在分组名称 description String 视频源所在分组描述 access_type String 接入方式（cloud、edge） create_at Long 创建时间 modify_at Long 修改时间 num_video_source Integer 视频源数量 group_status GroupStatusDto object 视频源状态 num_batch_task Integer 已配置批量作业数量 表8 GroupStatusDto 参数 参数类型 描述 num_online Integer 在线视频源数量 num_exception Integer 异常视频源数量 num_offline Integer 离线视频源数量 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息描述 detail String 错误详情 params Array of strings 错误参数列举 reason String 错误原因 advice String 建议 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息描述 detail String 错误详情 params Array of strings 错误参数列举 reason String 错误原因 advice String 建议

响应示例 状态码： 200 视频源分组列表响应体 { "video_group_number": 23, "total_number": 23, "quota_number": 200, "video_group_list": [ { "video_group_id": "a9334780-a53c-454e-a3c1-259c54678ec1", "video_group_name": "test000", "num_video_source": 2, "group_status": { "num_online": 2, "num_exception": 0, "num_offline": 0 }, "access_type": "cloud", "create_at": 1680773327730, "modify_at": 1680773463291, "num_batch_task": 0, "type": "restful" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 video_group_number Integer 分组数量 total_number Integer 视频源分组总数 quota_number Integer 视频源分组最大限额 video_group_list Array of VideoGroupListInfoDto objects 分组列表 表5 VideoGroupListInfoDto 参数 参数类型 描述 video_group_id String 视频源分组id video_group_name String 视频源分组名称 num_video_source Integer 视频源数量 group_status GroupStatusDto object 分组中视频源状态 access_type String 接入方式 create_at Long 创建时间 modify_at Long 最后一次修改时间 num_batch_task Integer 已配置批量作业数量 type String 分组中视频源类型 表6 GroupStatusDto 参数 参数类型 描述 num_online Integer 在线视频源数量 num_exception Integer 异常视频源数量 num_offline Integer 离线视频源数量

URI GET /v2/{project_id}/video-group/groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 sort_name 否 String 排序项。可选，可选值（create_at、modify_at、num_video_source、num_task）。 order_by 否 String 排序顺序，可选，默认倒序，可选值（desc、asc）。 is_paged 否 Boolean 是否分页。 page_size 否 Integer 分页每页显示的条目。 page_num 否 Integer 第几页。 name 否 String 模糊查找参数，可以按分组名称进行模糊查找。 status 否 String 状态level筛选，可选值（1、2、9）。 access_type 否 Array of strings 根据接入方式筛选（可多选），可选值（cloud、edge）。 has_task 否 Boolean 是否有批量作业。 type 否 Array of strings 视频源类型筛选（可多选）类型:obs、vcn、url、restful、camera。

响应示例 状态码： 200 我的算法服务列表响应体 { "count" : 3, "service_list" : [ { "alg_id" : "068ed4d8-077e-4ec9-aa19-bc******e925", "service_id" : "331bcb4a-5b3c-4e67-87cc-6c******d77b", "service_name" : "边缘入侵检测", "function_version" : "1.0", "created_at" : 1680008856502, "alg_status" : "service_running", "deploy_type" : "edge", "alg_class" : "self", "request_mode" : "async", "can_update" : true, "new_alg_id" : "3320b2b9-562b-4bee-bfee-0e******01c1" }, { "alg_id" : "5c73bd3f-6498-40e5-a40f-7b******1139", "service_id" : "04dc08b7-da07-46ee-83e7-c3******f668", "service_name" : "test-event-01", "function_version" : "1.0", "created_at" : 1680005185627, "alg_status" : "service_stopped", "deploy_type" : "cloud", "alg_class" : "self", "request_mode" : "async" }, { "alg_id" : "c01ec07f-874f-42f1-ba1d-15******d71b", "service_id" : "db1ec2d2-d023-4d20-ab6f-bc******4eeb", "service_name" : "TEST-CLOUD-ALG", "function_version" : "1.0", "created_at" : 1680008219078, "alg_status" : "service_failed", "deploy_type" : "cloud", "alg_class" : "self", "request_mode" : "async", "description" : "测试云上算法" } ], "total" : 3 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 数量 service_list Array of ServicesListInfoDto objects 服务列表 total Integer 总数数量 表5 ServicesListInfoDto 参数 参数类型 描述 alg_id String 算法ID service_id String 服务ID service_name String 服务名称 package_id String 算法服务包ID package_name String 算法服务包名称 company String 厂商名称 alg_version String 算法版本 function_version String 功能版本 tags Array of strings 应用场景标签 created_at Long 创建时间 alg_status String 算法状态，取值为“service_running”、“service_deploying”、“service_failed”、“service_stopping”、“service_stopped”、“service_upgrading”、“service_finished”、“service_concerning”或者“not_deployed” deploy_type String 部署类型，取值为“cloud”或者“edge” alg_class String 算法类别，取值为“self”或者“partner” request_mode String 请求模式，取值为“sync”或者“async” description String 算法描述，信息非空时返回 error_msg String 服务异常信息，信息非空时返回 can_update Boolean 是否可升级，值为true时返回 new_alg_id String 升级后的算法ID，可升级时返回

URI GET /v2/{project_id}/algorithm/services/user 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 name_like 否 String 服务名称，支持模糊匹配。 is_paged 否 Boolean 是否分页。 page_size 否 Integer 每页的最大条目数。 page_num 否 Integer 第几页 order_by 否 String 排序方式，可选“asc”或“desc”，代表递增排序及递减排序。 sort_name 否 String 排序字段，可选“created_at”或“function_version”。 alg_status 否 Array of strings 服务状态，支持多选。可选“service_running”、“service_deploying”、“service_failed”、“service_stopping”、“service_stopped”、“service_upgrading”、“service_finished”、“service_concerning”、“not_deployed”

响应示例 状态码： 200 查询作业列表响应体 { "count" : 2, "tasks" : [ { "id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "name" : "qqqq_task", "service_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx", "created_at" : "1686034773024", "state" : "PENDING", "video_source_name" : "url_test", "title" : "testwjh", "type" : "0", "algorithm_publish_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx" }, { "id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "name" : "task_test1", "service_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx", "created_at" : "1686027880205", "state" : "STOPPED", "video_source_name" : "test_g11", "title" : "alg_test", "type" : "0", "algorithm_publish_id" : "xxxxxxx-xxxxxxx-xxxxxxx-xxxxx-xxxxxx" } ], "page" : 1, "page_size" : 10 }

URI GET /v2/{project_id}/tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 source_data_type 否 String 任务类型，用作查询过滤。仅支持async_task与sync_task两种类型。 title 否 String 算法中文名,需要满足正则表达式^[a-zA-Z0-9\u4e00-\u9fa5-_,]{2,64}$。 camera_name 否 String 摄像头名称 task_state 否 String 任务状态，状态可选PENDING|RECOVERING|STARTING|UPGRADING|CREATE_FAILED|START_FAILED|RUNNING|STOPPING|STOPPED|ABNORMAL|SUCCEEDED|FAILED|DELETING|FREEZING|FROZEN|SCHEDULING|LACK_OF_RESOUR CES task_name 否 String 任务名称 page_size 否 Integer 每页显示的条目数量。 page 否 Integer 偏移量 sort_dir 否 String 展示服务任务时的排序规则 batch_id 否 String 批量配置ID，需要满足正则表达式^[a-z0-9-_]{4,36}$ video_group_id 否 String 视频分组ID（多个ID英文逗号分隔拼接）,长度要求[4,2048] company 否 String 厂商（多选时逗号分隔拼接） alg_id 否 String 算法ID，需要满足正则表达式^[0-9a-f]{8}-[0-9a-f]{4}-[4][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 当前页面的条目数 tasks Array of TaskInfo objects 查询到的任务列表信息 page Integer 当前页号 page_size Integer 分页尺寸 表5 TaskInfo 参数 参数类型 描述 id String 任务ID name String 任务的名称 service_id String 任务对应服务的ID created_at String 任务创建的时间 state String 任务当前的状态，分别为PENDING（等待中），RECOVERING（恢复中），STARTING（启动中），UPGRADING（升级中），CREATE_FAILED（创建失败），START_FAILED（启动失败），RUNNING（运行中），STOPPING（停止中），STOPPED（已停止），ABNORMAL（异常），SUCCEEDED（运行成功），FAILED（运行失败），DELETING（删除中），FREEZING（冻结中），FROZEN（已冻结） video_source_name String 视频源名称 title String 算法中文名称 type String 任务类型（0：云上任务 1：边缘任务） algorithm_publish_id String 算法id 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息描述 detail String 错误详情 params Array of strings 错误参数列举 reason String 错误原因 advice String 建议 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息描述 detail String 错误详情 params Array of strings 错误参数列举 reason String 错误原因 advice String 建议

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 边缘资源池总量。 edge_pools Array of EdgePoolListItemDto objects 边缘资源池列表响应体。 表5 EdgePoolListItemDto 参数 参数类型 描述 id String 边缘池ID。 name String 边缘池名称。 state String 边缘池状态。 project_id String 用户项目ID。 workspace_id String 工作空间ID。 created_at Long 创建时间。 updated_at Long 更新时间。 description String 描述信息。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息描述。 detail String 错误详情。 params Array of strings 错误参数列举。 reason String 错误原因。 advice String 建议。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息描述。 detail String 错误详情。 params Array of strings 错误参数列举。 reason String 错误原因。 advice String 建议。

响应示例 状态码： 200 获取边缘资源池列表响应体 { "count" : 2, "edge_pools" : [ { "id" : "xxx", "name" : "test1", "state" : "Running", "project_id" : "xxx", "workspace_id" : "0", "created_at" : 1685611513591, "updated_at" : 1685611513591 }, { "id" : "xxx", "name" : "test2", "state" : "Running", "project_id" : "xxx", "workspace_id" : "0", "created_at" : 1683344661036, "updated_at" : 1683344661036 } ] }

URI GET /v2/{project_id}/edge-pools 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 is_paged 否 Boolean 是否分页。 page_size 否 Integer 第几页。 page_num 否 Integer 页大小。 name_like 否 String 模糊查询名称，满足正则表达式^[a-z0-9-]{1,30}$。 order_by 否 String 排序方式，根据传入的sort_name的值进行正序或倒序地排序。asc为正序，desc为倒序。 枚举值： asc desc sort_name 否 String 排序字段。枚举值： created_at updated_at state 否 String 状态筛选，单选。枚举值： Running Abnormal

响应示例 状态码： 200 批量操作响应体 { "count" : 2, "batch_task_list" : [ { "id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "batch_task_name" : "qqqq", "video_group_name" : "2312,1889,927,914", "alg_name" : "testwjh", "type" : "0", "priority" : "low", "num_task" : 3, "created_at" : 1685667905165, "batch_task_status_info" : { "stopped" : 3 } }, { "id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "batch_task_name" : "qqq", "video_group_name" : "2312", "alg_name" : "testwjh", "type" : "0", "priority" : "low", "num_task" : 1, "created_at" : 1685667856283, "batch_task_status_info" : { "running" : 1 } } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 条目总数 batch_task_list Array of BatchTaskDto objects 批量作业列表 表5 BatchTaskDto 参数 参数类型 描述 id String 批量作业ID batch_task_name String 批量作业名称 video_source_name String 视频源名称 video_group_name String 分组名称 alg_name String 算法名称 company String 厂商名 type String 作业类型 num_task Integer 批量作业总数 created_at Long 创建时间 batch_task_status_info BatchTaskStatusInfoDto object 批量作业状态基本信息 表6 BatchTaskStatusInfoDto 参数 参数类型 描述 pending Integer 等待中作业数量 recovering Integer 恢复中作业数量 starting Integer 启动中作业数量 upgrading Integer 升级中作业数量 create_failed Integer 创建失败作业数量 start_failed Integer 启动失败作业数量 running Integer 运行中作业数量 stopping Integer 停止中作业数量 stopped Integer 已停止作业数量 abnormal Integer 异常作业数量 succeeded Integer 运行成功作业数量 failed Integer 运行失败作业数量 deleting Integer 删除中作业数量 freezing Integer 冻结中作业数量 frozen Integer 已冻结作业数量 stopped_no_service Integer 无服务的任务数量 scheduling Integer 调度中 lack_of_resources Integer 资源不足，创建失败 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息描述 detail String 错误详情 params Array of strings 错误参数列举 reason String 错误原因 advice String 建议 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息描述 detail String 错误详情 params Array of strings 错误参数列举 reason String 错误原因 advice String 建议

URI GET /v2/{project_id}/batch-tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 is_paged 否 Boolean 是否分页。 page_size 否 Integer 每页显示的条目数量。 page_num 否 Integer 页号。 order_by 否 String 升序或降序，枚举值：asc|desc。 sort_name 否 String 排序字段，枚举值：task_count|created_at。 video_group 否 String 视频源分组列表，多个以逗号分隔，需要满足正则：^[a-zA-Z0-9\u4e00-\u9fa5,-_]{1,1000}$。 task_state 否 String 任务状态，需要枚举值：pending|recovering|starting|upgrading|create_failed|start_failed|running|stopping|stopped|abnormal|succeeded|failed|deleting|freezing|frozen|stopped_no_service|scheduling|lack_of_resources type_like 否 String 模糊查询字段，枚举值： batch_task_name|publish_service_name name_like 否 String 模糊查询名称,需要与type_like搭配使用来实现是通过batch_task_name还是publish_service_name进行模糊查询。 manufacturer 否 String 根据厂商字段筛选，需要满足正则表达式 ^[a-zA-Z0-9\u4e00-\u9fa5,-_]{2,64}$。 title 否 String 算法中文名，需要满足正则表达式 ^[a-zA-Z0-9\u4e00-\u9fa5,-_]{2,64}$。

请求示例 部署算法，配置资源池ID、可承载的最大路数和服务启动参数 GET https://{endpoint}/v2/{project_id}/algorithm/068ed4d8-077e-4ec9-aa19-bc******e925/deploy { "pool_id" : "ed9f128bf7d04f5683f0ef******a255", "stream_count" : 1, "deploy_config" : { "sub_scene" : "common" } }

URI DELETE /v2/{project_id}/source/{video_source_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法参见获取项目ID和名称。 video_source_id 是 String 已创建成功的视频源id，只能由小写英文字母(a~z)、数字(0~9)组成、 中划线(-)、下划线(_)长度范围为[4, 36]。

URI DELETE /v2/{project_id}/video-group/{video_group_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID，获取方法参见获取项目ID和名称。 video_group_id 是 String 视频源分组id，只能由小写英文字母(a~z)、数字(0~9)、中划线(-)、下划线(_)长度范围为[4, 36]。

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息描述 detail String 错误详情 params Array of strings 错误参数列举 reason String 错误原因 advice String 建议 状态码： 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息描述 detail String 错误详情 params Array of strings 错误参数列举 reason String 错误原因 advice String 建议