任务输入/输出参数
task.input（任务输入参数）
- task.input参数说明
参数
是否必选
类型
说明
type
是
String
视频数据的输入类型：
- obs：表示从华为云OBS中读取视频数据。
- url：表示从指定的URL地址中读取视频数据。
- edgecamera：表示从指定的边缘摄像头读取数据。
- vis：从视频接入服务中读取视频数据。
- edgerestful：表示从客户自定义的流媒体服务器读取数据。
- vcn ：表示从华为云VCN中读取视频数据。
data
是
Array of data objects
数据输入内容：- type为obs时，请参见obs.data字段数据结构说明。
- type为url时，请参见url.data字段数据结构说明。
- type为edgecamera时，请参见edge.data字段数据结构说明。
- type为vis时，请参见vis.data字段数据结构说明。
- type为edgerestful时，请参见edgerestful.data字段数据结构说明。
- type为vcn时，请参见vcn.data字段数据结构说明。
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：表示发送原始图。
说明：此参数仅在人脸提取中支持。
