# 创建云上工服工帽检测作业-CreateSafetySuiteDetectCloudTasks #### 功能介绍 该接口用于创建云上工服工帽检测作业。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/vias/doc?api=CreateSafetySuitTasksCloud)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### URI POST /v2/{project_id}/services/c-safetysuitedetection-cloud/tasks 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 用户项目ID。获取方法参见[获取项目ID和名称](https://support.huaweicloud.com/api-vias/vias_03_0283.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母和数字组成，且长度为\[1-64\]个字符。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，获取方法参见[认证鉴权](https://support.huaweicloud.com/api-vias/vias_03_0009.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 是 | String | **参数解释：** 作业名称。 **约束限制：** 不涉及。 **取值范围：** 只能由中文、字母（a～z A～Z）、数字（0～9）、中划线（-）、下划线（_）组成。长度限制为\[1，100\]个字符。 **默认取值：** 不涉及。 | | description | 否 | String | **参数解释：** 作业描述信息。 **约束限制：** 不涉及。 **取值范围：** 长度限制为\[0，500\]个字符。 **默认取值：** 不涉及。 | | schedule | 否 | [TaskSchedule] object | **参数解释：** 定时任务参数，定时周期仅支持周模式。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | input | 是 | [TaskInput] object | **参数解释：** 作业的输入配置。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | output | 是 | [TaskOutput] object | **参数解释：** 作业的输出配置，至少需要配置一项输出方式。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | config | 否 | [SafetySuitServiceConfig] object | **参数解释：** 作业配置参数。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | service_version | 是 | String | **参数解释：** 服务版本号。 **约束限制：** 不涉及。 **取值范围：** 输入需要满足正则：\^\[a-z0-9.\]{3,32}$。 **默认取值：** 不涉及。 | | is_saved_as_template | 否 | Boolean | **参数解释：** 是否把作业配置保存成模板。 **约束限制：** 不涉及。 **取值范围：** - true：把作业配置保存成模板。 - false：不把作业配置保存成模板。 **默认取值：** 不涉及。 | | resource_order_id | 否 | String | **参数解释：** 资源订单id，与关联算法挂钩。非商用白名单的算法就不用填，商用算法就为必填项。 **约束限制：** 非商用白名单的算法就不用填，商用算法就为必填项。 **取值范围：** 输入需要满足正则：\^\[a-z0-9-_\]{4,36}$。 **默认取值：** 不涉及。 | 表4TaskSchedule | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释：** 计划任务的类型。 **约束限制：** 使用计划任务时必填。 **取值范围：** 可选类型为weekly（每周执行），monthly（每月执行）。 **默认取值：** 不涉及。 | | timezone | 是 | String | **参数解释：** 用户所处的时区，精确到分钟。 **约束限制：** 使用计划任务时必填。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | days_of_week | 否 | Array of integers | **参数解释：** 作业会在一周的哪几天执行，1\~7分别指代星期一至星期日。 **约束限制：** 当且仅当计划任务类型为weekly时，该字段需填且必填。 **取值范围：** 最小值：**1** 最大值：**7** 数组长度：**1 - 7** **默认取值：** 不涉及。 | | days_of_month | 否 | Array of integers | **参数解释：** 作业会在一个月的哪几天执行，1\~31分别指代一个月中的1日至31日。 **约束限制：** 当且仅当计划任务类型为monthly时，该字段需填且必填。 **取值范围：** 最小值：**1** 最大值：**31** **默认取值：** 不涉及。 | | periods | 否 | Array\\> | **参数解释：** 时间段模式配置，指定周计划或者月计划中具体每天作业的执行时间段，至少需指定一个时间段。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表5TaskInput | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释：** 作业的输入类型，创建时必填，编辑时video_source 模式不支持切换为其他IVA模式的type。创建时可选类型有obs（对象存储服务存储的文件仅云上作业支持）， url（指定的文件地址或取流地址 仅云上作业支持）， edgecamera（绑定在IEF的边缘摄像头仅边缘作业支持），restful（从自定义的流媒体服务器通过Restful接口获取流地址。云上，边缘均作业支持）， vcn（VCN设备仅边缘作业支持），video_source（视频源类型），建议使用video_source类型，其他类型为了兼容老业务，后续将废弃。 **约束限制：** 不涉及。 **取值范围：** 枚举值： - video_source - obs(不建议使用，后续废弃) - url(不建议使用，后续废弃) - edgecamera(不建议使用，后续废弃) - restful(不建议使用，后续废弃) - vcn(不建议使用，后续废弃) **默认取值：** 不涉及。 | | data | 是 | Array of [TaskInputData] objects | **参数解释：** 作业的输入详情，必填。针对不同的输入类型有不同的配置。创建时允许填写多路输入，但更新时只允许填写一路输入。 **约束限制：** - 当输入类型为：obs，需要配置 bucket，path ， index 。例如： "bucket": "aicam", "path": "3rdpartylicenses.txt", "index": 0 - 当输入类型为：url，需要配置 url， index 。例如： "url": "https://xxx-xxx.com", "index": 0 - 当输入类型为：restful，需要配置 certificate_check， rtsp_path_in_response， url， index， headers 。例如："certificate_check": true, "url": "https://hsaij-dasahbi.com", "rtsp_path_in_response": "data/url", "index": 0, "headers": { "AAA": "AAA" } - 当输入类型为：vcn，需要配置 device_id， stream_type， index。例如："device_id": "21356478954612546874#gdhjkiushdgdksjhslmhscjsckjhdbnk", "stream_type": 1, "index": 0 - 当输入类型为：EdgeCamera，需要配置 id， index 例如："id": "007cdafc-6000-47ce-b0e3-870b4a0db65e","index": 0 **取值范围：** 数组长度：\[1, 50\]。 **默认取值：** 不涉及。 | | vcn | 否 | [TaskInputVcn] object | **参数解释：** VCN服务器信息。 **约束限制：** 仅输入类型为vcn时必填。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表6TaskInputData | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | video_source_id | 否 | String | **参数解释：** 视频源id。 **约束限制：** 当输入类型为video_source时必填。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | stream_name | 否 | String | **参数解释：** 视频流名称。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | bucket | 否 | String | **参数解释：** OBS桶名。 **约束限制：** 当输入为obs类型时必填。 **取值范围：** 长度限制为\[0, 63\]个字符。 **默认取值：** 不涉及。 | | path | 否 | String | **参数解释：** OBS的路径。 **约束限制：** 当输入为obs类型时必填。 **取值范围：** 长度限制为\[0, 1023\]个字符。 **默认取值：** 不涉及。 | | url | 否 | String | **参数解释：** url输入源的地址或者获取视频流地址的restful请求地址。 **约束限制：** 当输入为url类型或者edgerestful类型时必填。 **取值范围：** 长度限制为\[0, 1000\]个字符。 **默认取值：** 不涉及。 | | headers | 否 | Object | **参数解释：** 获取视频流地址的restful请求携带的请求头。整体呈json格式，以键值对的形式表示请求头和取值。 **约束限制：** 当输入为edgerestful类型时可选。 **取值范围：** 组数取值范围为\[0, 10\]。 **默认取值：** 不涉及。 | | certificate_check | 否 | Boolean | **参数解释：** 是否需要对https请求进行证书校验。 **约束限制：** 当输入为edgerestful类型时必填。 **取值范围：** - true：对https请求进行证书校验。 - false：不对https请求进行证书校验。 **默认取值：** 不涉及。 | | rtsp_path_in_response | 否 | String | **参数解释：** restful请求返回的body中，视频流地址的路径。 **约束限制：** 当输入为edgerestful类型时必填。 **取值范围：** 长度限制为\[0, 1024\]个字符。 **默认取值：** 不涉及。 | | device_id | 否 | String | **参数解释：** VCN设备ID。 **约束限制：** 当输入为vcn类型时必填。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | stream_type | 否 | Integer | **参数解释：** 准备进行分析的码流。取值范围为1\~3，其中1代表主码流，2代表子码流1，3代表子码流2。 **约束限制：** 当输入为vcn类型时选填。 **取值范围：** \[1, 3\]。 **默认取值：** 不涉及。 | | id | 否 | String | **参数解释：** IEF挂载的边缘设备的ID。 **约束限制：** 当输入为edgecamera类型时必填。 **取值范围：** 长度范围为\[0, 63\]。 **默认取值：** 不涉及。 | 表7TaskInputVcn | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ip | 是 | String | **参数解释：** VCN服务器的IP地址。 **约束限制：** 仅输入类型为vcn时必填。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | port | 是 | Integer | **参数解释：** VCN服务器的端口号。 **约束限制：** 仅输入类型为vcn时必填。 **取值范围：** \[0, 65535\]。 **默认取值：** 不涉及。 | | username | 是 | String | **参数解释：** VCN服务器的账号名。 **约束限制：** 仅输入类型为vcn时需填且必填。 **取值范围：** 需要满足正则表达式\^.{1,100}$。 **默认取值：** 不涉及。 | | password | 是 | String | **参数解释：** VCN服务器的与账号对应的密码。 **约束限制：** 仅输入类型为vcn时必填。 **取值范围：** 需要满足正则表达式\^.{1,1000}$。 **默认取值：** 不涉及。 | 表8TaskOutput | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | obs | 否 | [TaskOutputObs] object | **参数解释：** 输出为obs类型时的配置信息。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | dis | 否 | [TaskOutputDis] object | **参数解释：** 输出为dis类型时的配置信息。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及 | | webhook | 否 | [TaskOutputWebhook] object | **参数解释：** 输出为webhook类型时的配置信息。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | event_center | 否 | Boolean | **参数解释：** 是否把告警发送至事件中心，云上作业该字段有效。 **约束限制：** 不涉及。 **取值范围：** - true：把告警发送至事件中心。 - false：不把告警发送至事件中心。 **默认取值：** false | 表9TaskOutputObs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | bucket | 是 | String | **参数解释：** OBS桶名。 **约束限制：** 选用obs类型输出时必填。 **取值范围：** 校验规则：\^\[a-z0-9\](?!.*\[-.\]\[-.\].*)(\[a-z0-9-.\]{1,61})\[a-z0-9\]$ 长度限制为\[0, 63\]个字符。 **默认取值：** 不涉及。 | | path | 是 | String | **参数解释：** OBS的路径。 **约束限制：** 选用obs类型输出时必填。 **取值范围：** 校验规则：\^(?!\[/.\\s\])(?!.//.)(\[\^:\*?"\<\>\|\]{0,1023})(?\