task.input(任务输入参数)
● task.input参数说明
参数 是否
必选
类型 说明
type 是 String 视频数据的输入类型:
● obs:表示从华为云OBS中读取视频数 据。
● url:表示从指定的URL地址中读取视 频数据。
● edgecamera:表示从指定的边缘摄像 头读取数据。
● vis:从视频接入服务中读取视频数 据。
● edgerestful:表示从客户自定义的流媒 体服务器读取数据。
● vcn :表示从华为云VCN中读取视频数 据。
API 参考 7 公共参数
参数 是否 必选
类型 说明
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”。
● 当type是url时,data字段数据结构说明
参数 是否必选 类型 说明
url 是 String 视频数据的URL,目前支持
OBS URL,且需要设置该URL 对匿名用户可读权限。
● 当type是edgecamera时,data字段数据结构说明
参数 是否必选 类型 说明
id 是 String 边缘摄像头id。
● 当type是vis时,data字段数据结构说明
API 参考 7 公共参数
参数 是否必选 类型 说明
stream_name 是 String 视频接入服务中的视频流名 称。
● 当type是edgerestful时,data字段数据结构说明
参数 是否必选 类型 说明
node_id 是 String 用于运行的边缘节点id, 下发边缘多任 务作业时该字段不填写。
url 是 String 容器获取EDGERESTFUL流的rest请 求。
格式:http(s):ip:port/xxx。
certificate_
check 是 Boolean true:算法侧需要对https请求进行证 书校验。
false:算法侧无需证书校验。
默认值:false。
平台侧仅对齐进行输入校验,不涉及 业务逻辑。
rtsp_path_i
n_response 是 String 返回body体中edgerestful流地址的路 径,不能以/开头。例如:data/url。
● 当type是vcn时,data字段数据结构说明
参数 是否必选 类型 说明
node_id 否 String 用于运行的边缘节点id,下发边缘多 任务作业时该字段不填写。
device_id 是 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})$。
● 当type是vcn时,vcn字段数据结构说明
参数 是否必选 类型 说明
ip 是 String vcn服务器的IP地址。
port 是 String vcn服务器的端口号。
username 是 String vcn服务器的账号名。
password 是 String vcn服务器与上述账号对应的密 码。
API 参考 7 公共参数
task.output(任务输出参数)
● task.output参数结构说明
参数 是否必选 类型 说明
obs 是 Object OBS输出路径,请参见obs字段数
据结构说明。
hosting 否 Object 使用HOSTING输出类型时,用户 作业的运行结果将托管到服务侧的
dis 否 Object DIS通道配置,请参见dis字段数据
结构说明。
webhook 否 Object Webhook地址配置,请参见
webhook字段数据结构说明。
仅边缘作业支持该输出类型。
localpath 否 Object LOCALPATH输出类型,请参见
localpath字段数据结构说明。
bucket 是 String 存储结果文件的OBS桶名。
path 是 String 结果文件的OBS桶内路径,例
如“output/”。
● hosting字段数据结构说明
参数 是否必选 类型 说明
obs 否 Object 结果文件result.json的OBS信 息,请参见hosting.obs字段数
据结构说明。
result.json文件生成且未过期 时,会有这个OBS数组。
API 参考 7 公共参数
参数 是否必选 类型 说明 result_json_ov
erdue_at 否 String 托管文件result.json的过期日 期,文件默认保存48小时。
result.json文件生成且未过期 时,会有这个字段。
check_obs_aft
er_end_state 否 Boolean True表示校验obs。
● hosting.obs字段数据结构说明
参数 是否必选 类型 说明
bucket 是 String result.json文件所在的OBS桶 名。
path 是 String result.json文件的OBS桶内路 径,例如“output/”。
● dis字段数据结构说明
参数 是否必选 类型 说明
stream_nam
e 是 String DIS通道名。
data_categor
y 否 String 作业输出数据类别的列表,默认
值为[]。有这个列表时,表示希 望这个输出结果中存放
dataCategory列表内的数据。
取值范围为
[FaceImage,OriginImage]。
● FaceImage:表示发送人脸 图。
● OriginImage:表示发送原始 图。
说明
此参数仅在人脸提取中支持。
● webhook字段数据结构说明
参数 是否必选 类型 说明
url 是 String URL地址,例如“https://
apigw.huawei.com/api/mqs/
message/sit”。
headers 是 Object header参数设置(键值均为用户 设置)。
API 参考 7 公共参数
参数 是否必选 类型 说明
data_category 否 String 作业输出数据类别的列表,默认 值为[]。有这个列表时,表示希 望这个输出结果中存放
dataCategory列表内的数据。
取值范围为
[FaceImage,OriginImage]。
● FaceImage:表示发送人脸 图。
● OriginImage:表示发送原始 图。
说明
此参数仅在人脸提取中支持。
● localpath字段数据结构说明
参数 是否必选 类型 说明
mount_source
_path 是 String 挂载源路径,存放作业运行结果
的路径,必须为linux路径,且 最大长度为255,例如“/
home”。
data_category 否 String 作业输出数据类别的列表,默认 值为[]。有这个列表时,表示希 望这个输出结果中存放
data_category列表内的数据。
取值范围为
[FaceImage,OriginImage]。
● FaceImage:表示发送人脸 图。
● OriginImage:表示发送原始 图。
说明
此参数仅在人脸提取中支持。
API 参考 7 公共参数