文档首页> 视频分析服务 VAS> API参考> 视频分析服务API> 创建作业
更新时间：2023-06-01 GMT+08:00
查看PDF
分享

创建作业

功能介绍

该接口用于创建所选视频分析服务的作业。

URI

POST /v2/{project_id}/services/{service_name}/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

用户项目ID。获取方法请参见获取项目ID/帐号名/AK/SK。

service_name

是

String

服务名称。

例如：video-moderation（视频审核服务）

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

作业的名称，必填。仅能包含汉字、字母、数字、中划线和下划线，长度介于1~100之间。

description

否

String

作业的描述，选填。长度不超过500。

最小长度：0

最大长度：500

service_version

是

String

作业对应服务的版本号，必填。由两个介于0~999的整数和一个点号分隔符组成。

edge_pool_id

否

String

作业运行指定的边缘运行池ID，仅边缘场景需填且必填。

resource_order_id

否

String

作业指定的算法能力包包周期订单ID，仅部分服务需填且必填。

timing

否

TaskTiming object

计划任务的配置项，选填。计划任务不支持obs输入，对于url输入则仅支持rtmp和rtsp两种形式。

input

是

TaskInput object

作业的输入配置，必填。

output

是

TaskOutput object

作业的输出配置，至少需要配置一项输出方式。

service_config

否

TaskServiceConfig object

作业运行时指定的算法配置参数，部分服务需填且必填。

响应参数

状态码： 201

表3 响应Body参数

参数

参数类型

描述

[数组元素]

Array of CreateResponseBody objects

创建的服务作业ID的集合。
表4 CreateResponseBody

参数

参数类型

描述

id

String

创建的服务作业ID。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

服务内部错误码。

error_msg

String

错误信息。

状态码： 404

表6 响应Body参数

参数

参数类型

描述

error_code

String

服务内部错误码。

error_msg

String

错误信息。

请求示例

  • 创建一个OBS为输入，OBS为输出的视频审核服务作业。
    POST /v2/b722xxxxxxxxxxxxxxxxxxxxxxeb4674/services/video-moderation/tasks

{
  "name": "task-test",
  "description": "description",
  "service_version":"1.2",
  "input": {
    "type": "obs",
    "data": [
      {
        "bucket": "obs-iva",
        "path": "input/demo.mp4"
      }
    ]
  },
  "output": {
    "obs": {
      "bucket": "obs-iva",
      "path": "output/"
    },
    "hosting": {}
  },
  "service_config": {
    "common": {
      "frame_interval": 5,
      "upload": "false",
      "use_ocr": "true",
      "use_sis": "true"
    }
  }
}
  • 创建一个EdgeCamera为输入，DIS为输出的普通边缘服务作业。
    POST /v2/b722xxxxxxxxxxxxxxxxxxxxxxeb4674/services/face-detect/tasks

{
  "name" : "task-test",
  "description" : "hello world",
  "service_version" : "1.0",
  "edge_pool_id" : "549cxxxxxxxxxxxxxxxxxxxxxx77a2a5",
  "input" : {
    "type" : "edgecamera",
    "data" : [ {
      "id" : "dd8xxxxx-xxxx-xxxx-xxxx-xxxxxx2f5bcb"
    } ]
  },
  "output" : {
    "dis" : {
      "stream_name" : "dis-test"
    }
  },
  "service_config" : {
    "common" : {
      "image_compression_ratio" : 90,
      "render_result_sw" : 0,
      "video_sampling_interval" : 1
    }
  }
}
  • 创建一个EdgeCamera为输入，DIS为输出的，每天北京时间早8点到晚8点执行的计划边缘服务作业。
    POST /v2/b722xxxxxxxxxxxxxxxxxxxxxxeb4674/services/face-detect/tasks

{
  "name" : "task-test",
  "description" : "hello world",
  "service_version" : "1.0",
  "edge_pool_id" : "549cxxxxxxxxxxxxxxxxxxxxxx77a2a5",
  "input" : {
    "type" : "edgecamera",
    "data" : [ {
      "id" : "dd8xxxxx-xxxx-xxxx-xxxx-xxxxxx2f5bcb"
    } ]
  },
  "output" : {
    "dis" : {
      "stream_name" : "dis-test"
    }
  },
  "timing" : {
    "type" : "daily",
    "timezone" : "+08:00",
    "periods" : [ {
      "begin_at" : "08:00:00",
      "end_at" : "20:00:00"
    } ]
  },
  "service_config" : {
    "common" : {
      "image_compression_ratio" : 90,
      "render_result_sw" : 0,
      "video_sampling_interval" : 1
    }
  }
}

响应示例

状态码： 201

创建服务作业成功。

[ {
  "id" : "53e4xxxxxxxxxxxxxxxxxxxxxxb55b3e"
} ]

状态码： 400

请求不合法。

{
  "error_code" : "IVA.0004",
  "error_msg" : "The request param is invalid. The field [input] is required and cannot be empty."
}

状态码： 404

指定的服务不存在。

{
  "error_code" : "IVA.0005",
  "error_msg" : "The requested resource is NOT found. Service face-detect/1.0 not found."
}

状态码

状态码

描述

201

创建服务作业成功。

400

请求不合法。

404

指定的服务不存在。

错误码

请参见错误码。

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误，具体返回错误码请参考错误码。

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。
父主题： 视频分析服务API
分享：

    相关文档

    相关产品