文档首页 > > API参考> 公共参数> 任务输入/输出参数

任务输入/输出参数

分享
更新时间:2020/09/07 GMT+08:00

task.input(任务输入参数)

  • task.input参数说明

    参数

    是否必选

    类型

    说明

    type

    String

    视频数据的输入类型:

    • obs:表示从华为云OBS中读取视频数据。
    • url:表示从指定的URL地址中读取视频数据。
    • edgecamera:表示从指定的边缘摄像头读取数据。
    • vis:从视频接入服务中读取视频数据。
    • edgerestful:表示从客户自定义的流媒体服务器读取数据。
    • vcn :表示从华为云VCN中读取视频数据。

    data

    Array of data objects

    数据输入内容:

    vcn

    Object

    vcn的相关信息。当且仅当type为vcn时,才需要填写,请参见type是vcn时,vcn字段数据结构说明

  • 当type是obs时,data字段数据结构说明

    参数

    是否必选

    类型

    说明

    bucket

    String

    OBS桶名称。

    path

    String

    OBS桶内的路径,例如“output/c1.mp4”

    index

    Integer

    当前输入的序号,从0开始依次递增,不可重复。

  • 当type是url时,data字段数据结构说明

    参数

    是否必选

    类型

    说明

    url

    String

    视频数据的URL。目前支持HTTP、HTTPS、RTSP、 RTMP、FTP、 FILE协议。

    index

    Integer

    当前输入的序号,从0开始依次递增,不可重复。

  • 当type是edgecamera时,data字段数据结构说明

    参数

    是否必选

    类型

    说明

    id

    String

    边缘摄像头ID。

    index

    Integer

    当前输入的序号,从0开始依次递增,不可重复。

  • 当type是vis时,data字段数据结构说明

    参数

    是否必选

    类型

    说明

    streamName

    String

    视频接入服务中的视频流名称。

    index

    Integer

    当前输入的序号,从0开始依次递增,不可重复。

  • 当type是edgerestful时,data字段数据结构说明

    参数

    是否必选

    类型

    说明

    nodeId

    String

    用于运行的边缘节点id, 下发边缘多任务作业时该字段不填写。

    index

    Integer

    当前输入在所有输入中的序号,index范围是[0, size of data - 1];不同的input不能有相同的index。

    url

    String

    容器获取EDGERESTFUL流的rest请求。

    格式:http(s):ip:port/xxx。

    certificateCheck

    Boolean

    true:算法侧需要对https请求进行证书校验。

    false:算法侧无需证书校验。

    默认值:false。

    平台侧仅对齐进行输入校验,不涉及业务逻辑。

    rtspPathInResponse

    String

    返回body体中edgerestful流地址的路径,不能以/开头。例如:data/url。

  • 当type是vcn时,data字段数据结构说明

    参数

    是否必选

    类型

    说明

    nodeId

    String

    用于运行的边缘节点id,下发边缘多任务作业或者下发云上作业时该字段不填写。

    deviceId

    String

    设备id号,符合正则表达式:^([0-9]{20}[#]{1}[a-zA-Z0-9]{32})|([0-9]{20}[#]{1}[0-9]{1,10}[#]{1}[a-zA-Z0-9]{32})$

    streamType

    String

    VCN返回的RTSP视频流类型。

    • 1表示主码流
    • 2表示辅码流1
    • 3表示辅码流2

    默认值:1。

    index

    Integer

    当前输入在所有输入中的序号。index范围是[0, size of data - 1]。不同的input不能有相同的index。

  • 当type是vcn时,vcn字段数据结构说明

    参数

    是否必选

    类型

    说明

    ip

    String

    vcn服务器的IP地址。

    port

    String

    vcn服务器的端口号。

    username

    String

    vcn服务器的账号名。

    password

    String

    vcn服务器与上述账号对应的密码。

task.output(任务输出参数)

  • task.output参数结构说明

    参数

    是否必选

    类型

    说明

    obs

    Object

    OBS输出路径,请参见obs字段数据结构说明

    hosting

    Object

    使用HOSTING输出类型时,用户作业的运行结果将托管到服务侧的OBS,请参见hosting字段数据结构说明

    说明:
    • 用户可以通过查询单个作业API,获取结果文件(result.json)中的内容、结果文件的桶和路径等信息。
    • 用户可以利用结果文件的桶、路径信息,调用OBS SDK下载结果文件,文件默认保存48小时。

    dis

    Object

    DIS通道配置,请参见dis字段数据结构说明

    webhook

    Object

    Webhook地址配置,请参见webhook字段数据结构说明

    仅边缘作业支持该输出类型。

    localpath

    Object

    LOCALPATH输出类型,请参见localpath字段数据结构说明

    仅边缘作业支持该输出类型。使用该输出类型,用户可以把作业的运行结果保存在边缘节点本地。

  • obs字段数据结构说明

    参数

    是否必选

    类型

    说明

    bucket

    String

    存储结果文件的OBS桶名。

    path

    String

    结果文件的OBS桶内路径,例如“output/”

  • hosting字段数据结构说明

    参数

    是否必选

    类型

    说明

    obs

    Object

    结果文件result.json的OBS信息,请参见hosting.obs字段数据结构说明

    result.json文件生成且未过期时,会有这个OBS数组。

    resultJsonOverdueAt

    String

    托管文件result.json的过期日期,文件默认保存48小时。

    result.json文件生成且未过期时,会有这个字段。

  • hosting.obs字段数据结构说明

    参数

    是否必选

    类型

    说明

    bucket

    String

    result.json文件所在的OBS桶名。

    path

    String

    result.json文件的OBS桶内路径,例如“output/”

  • dis字段数据结构说明

    参数

    是否必选

    类型

    说明

    streamName

    String

    DIS通道名。

    dataCategory

    String

    作业输出数据类别的列表,默认值为[]。有这个列表时,表示希望这个输出结果中存放dataCategory列表内的数据。

    取值范围为[FaceImage,OriginImage]。

    • FaceImage:表示发送人脸图。
    • OriginImage:表示发送原始图。
    说明:

    此参数仅在人脸提取中支持。

  • webhook字段数据结构说明

    参数

    是否必选

    类型

    说明

    url

    String

    URL地址,例如“https://apigw.huawei.com/api/mqs/message/sit”

    headers

    Object

    header参数设置(键值均为用户设置)。

    dataCategory

    String

    作业输出数据类别的列表,默认值为[]。有这个列表时,表示希望这个输出结果中存放dataCategory列表内的数据。

    取值范围为[FaceImage,OriginImage]。

    • FaceImage:表示发送人脸图。
    • OriginImage:表示发送原始图。
    说明:

    此参数仅在人脸提取中支持。

  • localpath字段数据结构说明

    参数

    是否必选

    类型

    说明

    mountSourcePath

    String

    挂载源路径,存放作业运行结果的路径,必须为linux路径,且最大长度为255,例如“/home”

    dataCategory

    String

    作业输出数据类别的列表,默认值为[]。有这个列表时,表示希望这个输出结果中存放dataCategory列表内的数据。

    取值范围为[FaceImage,OriginImage]。

    • FaceImage:表示发送人脸图。
    • OriginImage:表示发送原始图。
    说明:

    此参数仅在人脸提取中支持。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问