任务输入/输出参数
task.input（任务输入参数）
- task.input参数说明
参数
是否必选
类型
说明
type
是
String
视频数据的输入类型：
- obs：表示从华为云OBS中读取视频数据。
- url：表示从指定的URL地址中读取视频数据。
- edgecamera：表示从指定的边缘摄像头读取数据。
- vis：表示从视频接入服务中读取视频数据。
- edgerestful：表示从客户自定义的流媒体服务器读取视频数据。
- vcn ：表示从华为云VCN中读取视频数据。
data
是
List<Object>
数据输入内容，data的元素的输入内容信息不能重复。- type为obs时，bucket+path不能重复，详细数据结构请参见obs.data字段数据结构说明。
- type为url时，url不能重复，详细数据结构请参见url.data字段数据结构说明。
- type为edgecamera时，id不能重复，详细数据结构请参见edge.data字段数据结构说明。
- type为vis时，stream_name不能重复，详细数据结构请参见vis.data字段数据结构说明。
- type为edgerestful时，url不能重复，详细数据结构请参见edgerestful.data字段数据结构说明。
- type为vcn时，device_id不能重复，详细数据结构请参见vcn.data字段数据结构说明。
vcn
否
Object
vcn的相关信息，当且仅当type为vcn时，才需要填写。
- 当type是obs时，data字段数据结构说明
参数
是否必选
类型
说明
bucket
是
String
OBS桶名称。
path
是
String
OBS桶内的路径，例如“output/c1.mp4”。
index
否
Int
当前输入的序号，从0开始依次递增，不可重复。
- 当type是url时，data字段数据结构说明
参数
是否必选
类型
说明
url
是
String
视频数据的URL，目前支持OBS URL，且需要设置该URL对匿名用户可读权限。
index
否
Int
当前输入的序号，从0开始依次递增，不可重复。
- 当type是edgecamera时，data字段数据结构说明
参数
是否必选
类型
说明
id
是
String
边缘摄像头ID。
index
否
Int
当前输入的序号，从0开始依次递增，不可重复。
- 当type是vis时，data字段数据结构说明
参数
是否必选
类型
说明
stream_name
是
String
VIS视频流名称。
index
否
Int
当前输入的序号，从0开始依次递增，不可重复。
- 当type是edgerestful时，data字段数据结构说明
参数
是否必选
类型
说明
index
否
int
当前输入在所有输入中的序号，index范围是[0, size of data - 1]；不同的input不能有相同的index。
url
是
String
容器获取EDGERESTFUL流的rest请求，格式http(s)//:ip:port/xxx。
headers
否
Object
容器获取EDGERESTFUL流的rest请求携带的请求头，格式为key:value，键值均为用户设置，最多允许10组键值对。
certificate_check
是
bool
true：算法侧需要对https请求进行证书校验。 false：算法侧无需证书校验。
默认：false。
平台侧仅对其进行输入校验，不涉及业务逻辑。
rtsp_path_in_response
是
String
返回body体中edgerestful流地址的路径，符合正则表达式：^([-A-Za-z0-9+&?=~_][-A-Za-z0-9+&/?=~_]+[-A-Za-z0-9+&/?=~_]|[A-Za-z]+)$ s。例如：data/url。
- 当type是vcn时，data字段数据结构说明
参数
是否必选
类型
说明
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})$。
stream_type
否
int
[1, 2, 3]分别指代[主码流，辅码流1，辅码流2]。
index
否
int
当前输入在所有输入中的序号，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，用户可以通过查询作业详情接口获取到结果中的result.json内容等信息，和托管文件的桶和路径信息；另外，用户可以利用托管文件的桶、路径信息，调用OBS SDK下载托管文件。请参见hosting字段数据结构说明。
dis
否
Object
DIS通道配置，请参见dis字段数据结构说明。
webhook
否
Object
Webhook地址配置，云上和边缘作业支持该输出类型，至少选择一种输出类型。请参见webhook字段数据结构说明。
localpath
否
Object
LOCALPATH输出类型，请参见localpath字段数据结构说明。
仅边缘作业支持该输出类型。使用该输出类型，用户可以把作业的运行结果保存在边缘节点本地。
- obs字段数据结构说明
参数
是否必选
类型
说明
bucket
是
String
存储结果文件的OBS桶名。
path
是
String
结果文件的OBS桶内路径，例如“output/”。
data_category
否
List<String>
作业输出数据类别的列表，默认值为[]。当输出类型下有这个列表时，表示希望这个输出结果中存放data_category列表内的数据。
- hosting字段数据结构说明
参数
是否必选
类型
说明
data_category
否
List<Object>
作业输出数据类别的列表，默认值为[]。当输出类型下有这个列表时，表示希望这个输出类型下存放data_category列表内的数据，data_category内容见算法服务API参考的算法配置章节。
- dis字段数据结构说明
参数
是否必选
类型
说明
stream_id
否
String
DIS通道ID
stream_name
是
String
DIS通道名。
owner
否
Object
DIS通道的拥有者。详见•dis的owner字段数据结构说明。
data_category
否
List<String>
作业输出数据类别的列表，默认值为[]。有这个列表时，表示希望这个输出结果中存放data_category列表内的数据。
- dis的owner字段数据结构说明
参数
是否必选
类型
说明
project_id
是
String
项目ID。
domain_id
是
String
域ID。
domain_name
是
String
域用户名。
- webhook字段数据结构说明
参数
是否必选
类型
说明
url
是
String
URL地址，例如“https://apigw.huawei.com/api/event/callback”。
headers
是
Object
header参数设置（键值均为用户设置）。
data_category
否
List<String>
作业输出数据类别的列表，默认值为[]。有这个列表时，表示希望这个输出结果中存放data_category列表内的数据。
- localpath字段数据结构说明
参数
是否必选
类型
说明
mount_source_path
是
String
挂载源路径，存放作业运行结果的路径，必须为linux路径，最大长度为255，且与创建边缘运行池时的主机挂载路径一致。例如“/home”。
data_category
否
List<String>
作业输出数据类别的列表，默认值为[]。有这个列表时，表示希望这个输出结果中存放data_category列表内的数据。
