调用该接口用于创建本地录像上传任务。
单次本地录像上传任务最多支持上传200个文件,即TimeSlot列表最大取值为200。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateLocalFileUploadJob |
系统规定参数。取值:CreateLocalFileUploadJob。 |
TimeSlot.N.EndTime | Integer | 是 | 1631019775 |
上传本地录像的结束时间,格式为10位时间戳,单位为秒。 说明 单次本地录像上传任务的最大时间范围为1小时。
|
TimeSlot.N.StartTime | Integer | 是 | 1631019675 |
上传本地录像的开始时间,格式为10位时间戳,单位为秒。 说明 单次本地录像上传任务的最大时间范围为1小时。
|
IotInstanceId | String | 否 | iot-cn-n6w1y59**** |
实例ID。 您可在物联网平台控制台的实例概览页面,查看当前实例的ID。若有ID值,必须传入该ID值,否则调用会失败。 说明 如果公共实例没有ID值,请参见如何获取实例ID。
|
TimeSlot.N.IotId | String | 否 | d7XmBoJhAr88C6PelXDF00**** |
视频设备的设备ID。物联网平台为该设备颁发的ID,设备的唯一标识符。可调用物联网平台QueryDeviceDetail查询。 注意 如果传入该参数,则无需传入ProductKey和DeviceName。IotId作为设备唯一标识符,和ProductKey与DeviceName的组合是一一对应的关系。如果您同时传入IotId和ProductKey与DeviceName的组合,则以IotId为准。
|
TimeSlot.N.ProductKey | String | 否 | a1BwAGV**** |
视频设备所属产品的ProductKey。 您可以在物联网平台控制台产品页查看或调用QueryProductList查看当前账号下所有产品的信息。 注意 如果传入该参数,需同时传入DeviceName。
|
TimeSlot.N.DeviceName | String | 否 | camera1 |
视频设备的设备名称。 您可以在物联网平台控制台的设备页查看DeviceName。 注意 如果传入该参数,需同时传入ProductKey。
|
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | 200 |
接口返回码:
|
Data | Struct |
查询结果。 |
|
JobId | String | 1ec1a2****d0435fbc0****34f6f139d |
本地录像上传任务ID。 说明 请您妥善保存JobId。录像上传任务完成后,需使用JobId查询本地录像上传任务结果:QueryLocalFileUploadJob。您也可以根据需要, 使用JobId停止本地录像上传任务:DeleteLocalFileUploadJob。
|
ErrorMessage | String | InvalidParameter |
调用失败时,返回的出错信息。 |
RequestId | String | 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1 |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
是否调用成功:
|
示例
请求示例
http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=CreateLocalFileUploadJob
&TimeSlot.1.EndTime=1631019775
&TimeSlot.1.StartTime=1631019675
&<公共请求参数>
正常返回示例
XML
格式
<CreateLocalFileUploadJobResponse>
<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>
<Data>
<JobId>1ec1a2****d0435fbc0****34f6f139d</JobId>
</Data>
<Code>200</Code>
<Success>true</Success>
</CreateLocalFileUploadJobResponse>
JSON
格式
{
"RequestId": "06DC77A0-4622-42DB-9EE0-25FIOHS82JK1",
"Data": {
"JobId": "1ec1a2****d0435fbc0****34f6f139d"
},
"Code": "200",
"Success": true
}
错误码
访问错误中心查看更多错误码。