diff options
Diffstat (limited to 'data/zh_cn/linkvisual/2018-01-20')
| -rw-r--r-- | data/zh_cn/linkvisual/2018-01-20/api-docs.php | 18353 |
1 files changed, 18353 insertions, 0 deletions
diff --git a/data/zh_cn/linkvisual/2018-01-20/api-docs.php b/data/zh_cn/linkvisual/2018-01-20/api-docs.php new file mode 100644 index 0000000..f76311d --- /dev/null +++ b/data/zh_cn/linkvisual/2018-01-20/api-docs.php @@ -0,0 +1,18353 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Linkvisual', + 'version' => '2018-01-20', + ], + 'directories' => [ + [ + 'id' => 65321, + 'title' => '事件', + 'type' => 'directory', + 'children' => [ + 'AddEventRecordPlanDevice', + 'CreateEventRecordPlan', + 'DeleteEventRecordPlan', + 'DeleteEventRecordPlanDevice', + 'QueryDeviceEventPicture', + ], + ], + [ + 'id' => 65327, + 'title' => '时间模板', + 'type' => 'directory', + 'children' => [ + 'CreateTimeTemplate', + 'DeleteTimeTemplate', + 'UpdateTimeTemplate', + 'QueryTimeTemplateDetail', + ], + ], + [ + 'id' => 65339, + 'title' => '设备', + 'type' => 'directory', + 'children' => [ + 'AddFaceDeviceGroup', + 'AddFaceDeviceToDeviceGroup', + 'DeleteFaceDeviceGroup', + 'SetDevicePictureLifeCycle', + 'StopLiveStreaming', + 'QueryDeviceEvent', + 'QueryDevicePictureFile', + 'QueryDevicePictureLifeCycle', + 'QueryDeviceVodUrlByTime', + 'QueryFaceAllDeviceGroup', + 'QueryFaceDeviceGroupsByDevice', + 'QueryLiveStreaming', + 'QueryVoiceIntercom', + 'RemoveFaceDeviceFromDeviceGroup', + ], + ], + [ + 'id' => 65364, + 'title' => '用户', + 'type' => 'directory', + 'children' => [ + 'AddFaceUserGroup', + 'AddFaceUserToUserGroup', + 'DeleteFaceUserGroup', + 'UpdateFaceUserGroupAndDeviceGroupRelation', + 'UpdateFaceUser', + 'QueryFaceAllUserGroupAndDeviceGroupRelation', + 'QueryFaceUserGroupAndDeviceGroupRelation', + 'QueryFaceUserIdByCustomUserId', + 'QueryFaceAllUserGroup', + 'QueryFaceAllUserIdsByGroupId', + 'QueryFaceCustomUserIdByUserId', + 'QueryFaceUser', + 'QueryFaceUserGroup', + 'RemoveFaceUserFromUserGroup', + ], + ], + [ + 'id' => 65379, + 'title' => '人脸', + 'type' => 'directory', + 'children' => [ + 'AddFaceUser', + 'AddFaceUserGroupAndDeviceGroupRelation', + 'AddFaceUserPicture', + 'DeleteFaceUser', + 'DeleteFaceUserGroupAndDeviceGroupRelation', + 'DeleteFaceUserPicture', + 'CheckFaceUserDoExistOnDevice', + 'ClearFaceDeviceDB', + ], + ], + [ + 'id' => 65389, + 'title' => '图片搜索', + 'type' => 'directory', + 'children' => [ + 'CreatePictureSearchApp', + 'CreatePictureSearchJob', + 'UpdatePictureSearchApp', + 'QueryPictureSearchAiboxes', + 'QueryPictureSearchApps', + 'QueryPictureSearchDevices', + 'QueryPictureSearchJob', + 'QueryPictureSearchJobResult', + 'GetPictureSearchJobStatus', + 'QueryPictureFiles', + 'BindPictureSearchAppWithDevices', + 'UnbindPictureSearchAppWithDevices', + 'PictureSearchPicture', + 'TriggerCapturePicture', + ], + ], + [ + 'id' => 65418, + 'title' => '录像', + 'type' => 'directory', + 'children' => [ + 'CreateRecordPlan', + 'AddRecordPlanDevice', + 'DeleteRecordPlan', + 'DeleteRecordPlanDevice', + 'SetDeviceRecordLifeCycle', + 'StopTriggeredRecord', + 'UpdateEventRecordPlan', + 'UpdateRecordPlan', + 'QueryRecord', + 'QueryRecordByRecordId', + 'QueryRecordPlanDetail', + 'QueryRecordPlanDeviceByDevice', + 'QueryRecordPlanDeviceByPlan', + 'QueryRecordPlans', + 'QueryRecordUrl', + 'QueryTimeTemplate', + 'QueryDeviceEventRecord', + 'QueryDeviceVodUrl', + 'QueryMonthRecord', + 'QueryDeviceRecordLifeCycle', + 'QueryEventRecordPlanDetail', + 'QueryEventRecordPlanDeviceByDevice', + 'QueryEventRecordPlanDeviceByPlan', + 'QueryEventRecordPlans', + 'TriggerRecord', + ], + ], + [ + 'id' => 177204, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'QueryDevicePictureByList', + 'TransferDeviceInstance', + 'QueryRecordDownloadUrl', + 'CreateLocalFileUploadJob', + 'DeleteLocalFileUploadJob', + 'QueryLocalFileUploadJob', + 'QueryFaceUserBatch', + 'QueryFaceUserByName', + 'DeleteRecord', + 'QueryRecordUrlByTime', + 'QueryCarProcessEvents', + 'DeletePicture', + 'UpdateInstanceInternetProtocol', + 'CreateRecordDownloadByTimeJob', + 'QueryRecordDownloadJobById', + 'QueryRecordDownloadJobList', + 'CreateLocalRecordDownloadByTimeJob', + 'BatchQueryVisionDeviceInfo', + 'CreateRtmpDevice', + 'DeleteRtmpDevice', + 'DeleteRtmpKey', + 'QueryRtmpKey', + 'QueryVisionDeviceInfo', + 'UpdateRtmpKey', + 'CreateGbDevice', + 'DeleteGbDevice', + 'EnableGbSubDevice', + 'QueryGbSubDeviceList', + 'RefreshGbSubDeviceList', + 'UpdateGbDevice', + 'CreateStreamPushJob', + 'CreateStreamSnapshotJob', + 'DeleteStreamPushJob', + 'DeleteStreamSnapshotJob', + 'QueryStreamPushJob', + 'QueryStreamPushJobList', + 'QueryStreamSnapshotJob', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AddEventRecordPlanDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型：'."\n" + .'- **0**（默认）：主码流。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能告警事件录像计划ID。可调用[QueryEventRecordPlans](~~107907~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'request forbidden', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"request forbidden\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddEventRecordPlanDeviceResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</AddEventRecordPlanDeviceResponse>","errorExample":""}]', + 'title' => '新增事件联动计划关联摄像头', + 'summary' => '调用该接口为IPC设备添加智能告警事件录像计划。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateEventRecordPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '录像计划名称。'."\n" + ."\n" + .'名称长度小于48个字符，可以包含英文字母、数字和特殊字符：短划线（-）、下划线（_）、at（@）、英文句号（.）、英文冒号（:）。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'plan1', + ], + ], + [ + 'name' => 'EventTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '智能告警事件类型：'."\n" + ."\n" + .'- 设置为全部智能告警事件：0。'."\n" + .'- 设置为多个智能告警事件：输入智能告警事件对应的序号，并用英文逗号（,）分隔，例如：`10001,10002`。'."\n" + .'>设置多个智能告警事件时，单次最多支持设置10个。'."\n" + ."\n" + .'请在物联网平台控制台，**产品详情**页面的**功能定义**页签，查看全部智能告警事件类型。详细信息，请参考[查看智能告警事件类型](~~207701~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PreRecordDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '预录时长，单位为秒，默认值为0，最大值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'default' => '0', + ], + ], + [ + 'name' => 'RecordDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '录像时长，单位为秒，包括预录时长，取值范围10~60。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '时间模板ID。可调用[QueryTimeTemplate](~~107890~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'fc82774fa749485bad7d719f9670****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '录像计划ID。', + 'type' => 'string', + 'example' => 'fc82774fa749485bad7d719f9670****', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'product is not active.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'a195f615-8c64-4cc6-af57-2f42c6cca15c', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"fc82774fa749485bad7d719f9670****\\",\\n \\"ErrorMessage\\": \\"product is not active.\\",\\n \\"RequestId\\": \\"a195f615-8c64-4cc6-af57-2f42c6cca15c\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateEventRecordPlanResponse> \\n<RequestId>a195f615-8c64-4cc6-af57-2f42c6cca15c</RequestId>\\n<Data>fc82774fa749485bad7d719f9670****</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</CreateEventRecordPlanResponse> ","errorExample":""}]', + 'title' => '创建事件联动录像计划', + 'summary' => '调用该接口创建智能告警事件录像计划。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteEventRecordPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能告警事件录像计划ID。可调用[QueryEventRecordPlans](~~107907~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '2e34a1989aa54debac22358aca7f****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。'."\n", + 'type' => 'string', + 'example' => '438A20F2-AFF2-4CAC-89F9-3378EAA133BD', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"438A20F2-AFF2-4CAC-89F9-3378EAA133BD\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteEventRecordPlanResponse>\\n<RequestId>438A20F2-AFF2-4CAC-89F9-3378EAA133BD</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n<DeleteEventRecordPlanResponse>","errorExample":""}]', + 'title' => '删除事件联动录像计划', + 'summary' => '调用该接口删除智能事件录像计划。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteEventRecordPlanDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。'."\n" + ."\n" + .'可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型：'."\n" + .'- **0**（默认）：主码流。'."\n" + .'- **1**：辅码流。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteEventRecordPlanDeviceResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</DeleteEventRecordPlanDeviceResponse>","errorExample":""}]', + 'title' => '删除事件联动录像计划摄像头', + 'summary' => '调用该接口删除智能告警事件录像计划关联的IPC设备。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryDeviceEventPicture' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能告警事件ID。通过[QueryDeviceEvent](~~107916~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'ae6b74f1dc7d402****32c21018****f1608036****71', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '图片地址。', + 'type' => 'string', + 'example' => 'oss://***/***.jpg', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'product is not active', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Data\\": \\"oss://***/***.jpg\\",\\n \\"ErrorMessage\\": \\"product is not active\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<QueryDeviceEventPictureResponse>\\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>\\n oss://***/***.jpg\\n </Data>\\n</QueryDeviceEventPictureResponse>","errorExample":""}]', + 'title' => '获取事件截图', + 'summary' => '调用该接口，获取触发智能告警事件时，IPC设备拍摄上传的图片。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateTimeTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'TimeSections', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '时间范围列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DayOfWeek' => [ + 'description' => '每周的周几，取值范围0~6，表示周日~周六。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Begin' => [ + 'description' => '每天开始的时间，取值范围为0~86399，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20000', + ], + 'End' => [ + 'description' => '每天结束的时间，取值范围为1~86399，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60000', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '时间模板名称。'."\n" + ."\n" + .'名称长度小于48个字符，可以包含英文字母、数字和特殊字符：短划线（-）、下划线（_）、at（@）、英文句号（.）、英文冒号（:）。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'example', + ], + ], + [ + 'name' => 'AllDay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否7天*24小时录像：'."\n" + .'- 1：是。'."\n" + .'- 0：否，需要配置TimeSections.N.DayOfWeek、TimeSections.N.Begin和TimeSections.N.End参数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '时间模板ID。', + 'type' => 'string', + 'example' => '38c94f874f2e4ce3b4b6da36****5213', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"38c94f874f2e4ce3b4b6da36****5213\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateTimeTemplateResponse>\\n<RequestId>AD8BAA6B-1197-48DC-A42B-F5986ADF9BFE</RequestId>\\n<Data>38c94f874f2e4ce3b4b6da3****65213</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</CreateTimeTemplateResponse>","errorExample":""}]', + 'title' => 'CreateTimeTemplate', + 'summary' => '调用该接口创建时间模板。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。'."\n" + ."\n" + .'**时间模板配置示例**'."\n" + ."\n" + .' 示例一：每周内某一段连续时间。例如每周六08:00到周日17:00录像。'."\n" + ."\n" + .' ```'."\n" + .' http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=CreateTimeTemplate'."\n" + .' &Name=example'."\n" + .' &AllDay=0'."\n" + .' &TimeSections=[{"DayOfWeek":6, "Begin":28800, "End":86399}, {"DayOfWeek":0,"Begin":0, "End":61200}]'."\n" + .' &<公共请求参数>'."\n" + .' ```'."\n" + ."\n" + .'示例二：每周7*24小时录像。'."\n" + ."\n" + .' ```'."\n" + .' http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=CreateTimeTemplate'."\n" + .' &Name=example'."\n" + .' &AllDay=1'."\n" + .' &<公共请求参数>'."\n" + .' ```'."\n" + ."\n" + .'示例三：每周某天内分时段。例如每周一的08:00到11:00和13:00到18:00录像。'."\n" + ."\n" + .' ```'."\n" + .' http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=CreateTimeTemplate'."\n" + .' &Name=example'."\n" + .' &AllDay=0'."\n" + .' &TimeSections=[{"DayOfWeek":1, "Begin":28800, "End":39600}, {"DayOfWeek":1, "Begin":46800, "End":64800}]'."\n" + .' &<公共请求参数>'."\n" + .' ```', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteTimeTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '时间模板ID。可调用[QueryTimeTemplate](~~107890~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '36f06322442e4e3f85a5ae8862c9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'RAM system auth error.', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"RAM system auth error.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteTimeTemplateResponse>\\r\\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\r\\n <code>200</code>\\r\\n <Success>true</Success>\\r\\n</DeleteTimeTemplateResponse>","errorExample":""}]', + 'title' => '删除时间模板', + 'summary' => '调用该接口删除时间模板。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateTimeTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TimeSections', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '时间区间列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DayOfWeek' => [ + 'description' => '每周的周几，取值范围0~6，表示周日~周六。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Begin' => [ + 'description' => '每天开始的时间，取值范围0~86399，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20000', + ], + 'End' => [ + 'description' => '每天结束的时间，取值范围1~86399，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60000', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '时间模板ID。可调用[QueryTimeTemplate](~~107890~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'fc82774fa749485bad7d719f9670****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '时间模板名称。'."\n" + ."\n" + .'名称长度小于48个字符，可以包含英文字母、数字和特殊字符：短划线（-）、下划线（_）、at（@）、英文句号（.）、英文冒号（:）。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'AllDay', + 'in' => 'query', + 'schema' => [ + 'description' => '是否7天*24小时录像：'."\n" + ."\n" + .'- 1：是。'."\n" + .'- 0：否，详细配置请查看TimeSections.N.DayOfWeek、TimeSections.N.Begin和TimeSections.N.End参数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。'."\n", + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateTimeTemplateResponse>\\r\\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\r\\n <Code>200</Code>\\r\\n <Success>true</Success>\\r\\n</UpdateTimeTemplateResponse>","errorExample":""}]', + 'title' => 'UpdateTimeTemplate', + 'summary' => '调用该接口更新时间模板。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryTimeTemplateDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '时间模板ID。可调用[QueryTimeTemplate](~~107890~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '36f06322442e4e3f85a5ae8862c9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'template owner error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功时，返回时间模板信息。', + 'type' => 'object', + 'properties' => [ + 'AllDay' => [ + 'description' => '是否7天*24小时录像：'."\n" + ."\n" + .'- **1**：是。'."\n" + .'- **0**：否，详细配置请查看**TimeSectionList**参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Default' => [ + 'description' => '是否是默认模板：'."\n" + ."\n" + .'- **1**：默认模板。'."\n" + .'- **0**：自定义模板。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'description' => '时间模板名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'TemplateId' => [ + 'description' => '时间模板ID。', + 'type' => 'string', + 'example' => '36f06322442e4e3f85a5ae8862c9****', + ], + 'TimeSectionList' => [ + 'description' => '时间模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'End' => [ + 'description' => '每天结束的时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60000', + ], + 'DayOfWeek' => [ + 'description' => '时间。取值0~6，表示周日~周六。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Begin' => [ + 'description' => '每天开始的时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"template owner error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"AllDay\\": 0,\\n \\"Default\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"TemplateId\\": \\"36f06322442e4e3f85a5ae8862c9****\\",\\n \\"TimeSectionList\\": [\\n {\\n \\"End\\": 60000,\\n \\"DayOfWeek\\": 0,\\n \\"Begin\\": 20000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryTimeTemplateDetailResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>\\n <AllDay>0</AllDay>\\n <Default>0</Default>\\n <TemplateId>36f06322442e4e3f85a5ae8862c9****</TemplateId>\\n <Name>test</Name>\\n <TimeSectionList>\\n <DayOfWeek>0</DayOfWeek>\\n <Begin>20000</Begin>\\n <End>60000</End>\\n </TimeSectionList>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryTimeTemplateDetailResponse>","errorExample":""}]', + 'title' => '查询时间模板详情', + 'summary' => '调用该接口查询指定时间模板的详情信息。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddFaceDeviceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离ID，用于同一个阿里云账号下不同业务应用之间的数据隔离，支持英文大小写字母、数字。'."\n" + ."\n" + .'例如，您在A地区和B地区，均有人脸识别业务，那么可设置不同的业务隔离ID，区分A、B地区的人脸识别业务。'."\n" + ."\n" + .'><notice>'."\n" + .'请妥善保存业务隔离ID值，以便后续调用此业务隔离区其它接口时使用。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHZ', + ], + ], + [ + 'name' => 'DeviceGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '设备组名称，请自定义参数值，长度不超过128个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestDeviceGroup', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'group already exist', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：表示调用成功。'."\n" + .'- **false**：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'DeviceGroupId' => [ + 'description' => '系统为该设备组生成的唯一ID。'."\n" + ."\n" + .'> 在人脸底库服务的其它接口调用中，会使用**DeviceGroupId**，请妥善保存。', + 'type' => 'string', + 'example' => 'jvkv****', + ], + 'ModifiedTime' => [ + 'description' => '添加设备组的时间。', + 'type' => 'string', + 'example' => '2020-11-20 18:59:01', + ], + 'DeviceGroupName' => [ + 'description' => '设备组名称。', + 'type' => 'string', + 'example' => 'TestDeviceGroup', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"group already exist\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DeviceGroupId\\": \\"jvkv****\\",\\n \\"ModifiedTime\\": \\"2020-11-20 18:59:01\\",\\n \\"DeviceGroupName\\": \\"TestDeviceGroup\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddFaceDeviceGroupResponse>\\n <RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n <Data>\\n <ModifiedTime>2020-11-20 18:59:01</ModifiedTime>\\n <DeviceGroupName>TestDeviceGroup</DeviceGroupName>\\n <DeviceGroupId>kvjy****</DeviceGroupId>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AddFaceDeviceGroupResponse>","errorExample":""}]', + 'title' => '添加设备分组', + 'summary' => '调用该接口创建人脸底库设备组。', + 'description' => '## 使用说明'."\n" + ."\n" + .'- 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + ."\n" + .' > RAM用户共享阿里云账号配额。'."\n" + ."\n" + .'- 调用该接口后，系统会返回设备组的ID（**DeviceGroupId**），建议保存该值到本地，以便后续调用其它接口时使用。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddFaceDeviceToDeviceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例化Id', + 'type' => 'string', + 'required' => false, + 'example' => 'TestInstanceId', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '产品Key', + 'type' => 'string', + 'required' => true, + 'example' => 'a1Tp7KYZHHK', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '设备名称'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'TestDevice', + ], + ], + [ + 'name' => 'DeviceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备组Id(调用AddFaceDeviceGroup接口时获得)', + 'type' => 'string', + 'required' => true, + 'example' => 'kvjyhurc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '将设备加入设备分组', + 'summary' => '将设备加入设备分组。', + 'requestParamsDescription' => '1. IsolationId解释：用于租户下不同应用之间的数据隔离。如某用户在浙江、陕西都有业务，则可以为浙江和西安的业务分别创建两个隔离Id;'."\n" + .'2. IotInstanceId解释：物联网平台的实例Id。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteFaceDeviceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'DeviceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备组Id', + 'type' => 'string', + 'required' => true, + 'example' => 'qaf2tihq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '删除设备分组', + 'summary' => '删除设备分组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetDevicePictureLifeCycle' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + ."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + ."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'C47T6xwp6ms4bNlkHR****c300', + ], + ], + [ + 'name' => 'Day', + 'in' => 'query', + 'schema' => [ + 'description' => '图片在云端的存储周期，单位为天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '449ECE75-A36A-4ACE-B253-147C78C440C5', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"449ECE75-A36A-4ACE-B253-147C78C440C5\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetDevicePictureLifeCycleResponse>\\n<RequestId>449ECE75-A36A-4ACE-B253-147C78C440C5</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</SetDevicePictureLifeCycleResponse>","errorExample":""}]', + 'title' => '设置设备云存储图片生命周期', + 'summary' => '调用该接口设置IPC设备的云存储图片生命周期。', + 'description' => '> 设置云存储图片生命周期前，默认图片在云端永久存储。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopLiveStreaming' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型：'."\n" + .'- **0**（默认）：主码流。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopLiveStreamingResponse>\\r\\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\r\\n <Code>200</Code>\\r\\n <Success>true</Success>\\r\\n</StopLiveStreamingResponse>","errorExample":""}]', + 'title' => 'StopLiveStreaming', + 'summary' => '调用该接口停止IPC设备推流。', + 'description' => '## 使用说明'."\n" + ."\n" + .'- 调用该接口前，您需要在IPC设备端实现标识符为**StopPushStreaming**的停止直播物模型服务。若未在IPC设备端实现该服务，或IPC设备收到该服务调用后未正常响应，则IPC设备不会停止推流。物模型的详细信息，请参见[什么是物模型](~~73727~~)。'."\n" + .'- 当IPC设备端无人观看时，无需额外调用该接口，物联网平台会自动触发停止设备推流。'."\n" + .'- 触发录像事件的过程中，调用该接口会造成录像文件间断，请您谨慎使用。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryDeviceEvent' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => [ + 'description' => '智能告警事件类型：'."\n" + .'- 设置为全部智能告警事件：0。'."\n" + .'- 设置为单个智能告警事件：输入智能告警事件对应的序号，例如：10001。'."\n" + ."\n" + .'请在物联网平台控制台，**产品详情**页面的**功能定义**页签，查看全部智能告警事件类型。详细信息，请参考[查看智能告警事件类型](~~207701~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询范围起始时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1539507310000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询范围结束时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1539607310000', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。页数从1开始排序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。最小值为1，最大值为50，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'<props="china">您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。</props>'."\n" + ."\n" + .'<props="intl">无需传入此参数。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'request forbidden', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Page' => [ + 'description' => '当前页面号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'List' => [ + 'description' => '返回的智能告警事件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventId' => [ + 'description' => '智能告警事件ID。', + 'type' => 'string', + 'example' => 'ae6b74f1dc7d****85d32c210185967f_16080****9471', + ], + 'EventTime' => [ + 'description' => '智能告警事件发生时间。', + 'type' => 'string', + 'example' => '2020-12-15 20:40:49', + ], + 'EventType' => [ + 'description' => '智能告警事件类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EventPicId' => [ + 'description' => '智能告警事件对应的图片ID。', + 'type' => 'string', + 'example' => 'aEtMSm9****ORTFxcGpTbDZ****6eTk0', + ], + 'EventDesc' => [ + 'description' => '智能告警事件描述。', + 'type' => 'string', + 'example' => '移动侦测', + ], + 'EventData' => [ + 'description' => '智能告警事件附加信息。', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"request forbidden\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 1,\\n \\"Total\\": 2,\\n \\"Page\\": 1,\\n \\"List\\": [\\n {\\n \\"EventId\\": \\"ae6b74f1dc7d****85d32c210185967f_16080****9471\\",\\n \\"EventTime\\": \\"2020-12-15 20:40:49\\",\\n \\"EventType\\": 1,\\n \\"EventPicId\\": \\"aEtMSm9****ORTFxcGpTbDZ****6eTk0\\",\\n \\"EventDesc\\": \\"移动侦测\\",\\n \\"EventData\\": \\"{}\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryDeviceEventResponse> \\n<RequestId>1FCB5660-020D-40A5-9313-F4F4F493A41F</RequestId>\\n<Data>\\n <PageSize>10</PageSize>\\n <PageCount>1</PageCount>\\n <Total>2</Total>\\n <Page>1</Page>\\n <List>\\n <EventDesc>移动侦测</EventDesc>\\n <EventType>1</EventType>\\n <EventTime>2020-12-15 20:40:49</EventTime>\\n <EventId>ae6b74f1dc7d40218****85967f_1608****471</EventId>\\n <EventPicId>aEtMSm9****ORTFxcGpTbDZ****6eTk0</EventPicId>\\n <EventData>{}</EventData>\\n </List>\\n <List>\\n <EventDesc>移动侦测</EventDesc>\\n <EventType>1</EventType>\\n <EventTime>2020-12-15 20:40:29</EventTime>\\n <EventId>5650d1cdc****8504520e037b2c_16****9466</EventId>\\n <EventPicId>adsvtMSm9****ORTFkjfdmskDZ****6eTk0</EventPicId>\\n <EventData>{}</EventData>\\n </List>\\n <Code>200</Code>\\n <Success>true</Success>\\n</Data>\\n</QueryDeviceEventResponse> ","errorExample":""}]', + 'title' => '查询设备事件列表', + 'summary' => '调用该接口查询IPC设备的智能告警事件列表。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryDevicePictureFile' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'CaptureId', + 'in' => 'query', + 'schema' => [ + 'description' => '抓图事件发生时，生成的图片ID：'."\n" + .'- 主动触发抓图时，图片ID请参见[TriggerCapturePicture](~~107914~~)。'."\n" + .'- 智能告警事件触发抓图时，图片ID请参见[QueryDeviceEvent](~~107916~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'fdc576d03c094faea9fa10fbf48c****', + ], + ], + [ + 'name' => 'ThumbWidth', + 'in' => 'query', + 'schema' => [ + 'description' => '指定目标缩放图的宽度，单位为px，取值范围为1~4096。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + 'default' => '0', + ], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => '图片URL的失效时间，单位为分钟，取值范围为1~43200。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + 'default' => '0', + ], + ], + [ + 'name' => 'PictureType', + 'in' => 'query', + 'schema' => [ + 'description' => '图片类型：'."\n" + ."\n" + .'- **0**：缩略图'."\n" + .'- **1**：原图 '."\n" + .'- **2**（默认）：全部'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '2', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'request forbidden', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'PicId' => [ + 'description' => '图片ID。', + 'type' => 'string', + 'example' => 'R****bVhsNCjMjIy', + ], + 'PicUrl' => [ + 'description' => '图片URL。', + 'type' => 'string', + 'example' => 'https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***3D', + ], + 'PicCreateTime' => [ + 'description' => '图片创建时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1632453652222', + ], + 'ThumbUrl' => [ + 'description' => '缩略图URL。', + 'type' => 'string', + 'example' => 'https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***2Cq_90', + ], + 'IotId' => [ + 'description' => 'IPC设备的设备ID。', + 'type' => 'string', + 'example' => '1CJ0***kQi1000000', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"request forbidden\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PicId\\": \\"R****bVhsNCjMjIy\\",\\n \\"PicUrl\\": \\"https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***3D\\",\\n \\"PicCreateTime\\": 1632453652222,\\n \\"ThumbUrl\\": \\"https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***2Cq_90\\",\\n \\"IotId\\": \\"1CJ0***kQi1000000\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryDevicePictureFileResponse>\\n<RequestId>B6E3F040-F2FD-5B6C-89B2-C3B58D22A5A0</RequestId>\\n<Data>\\n <IotId>1CJ0***kQi1000000</IotId>\\n <ThumbUrl>https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***2Cq_90</ThumbUrl>\\n <PicUrl>https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***3D</PicUrl>\\n <PicCreateTime>1632453652222</PicCreateTime>\\n <PicId>R****bVhsNCjMjIy</PicId>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryDevicePictureFileResponse>","errorExample":""}]', + 'title' => '查询设备图片信息', + 'summary' => '调用该接口查询IPC设备获取的图片信息。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryDevicePictureLifeCycle' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。'."\n" + ."\n" + .'可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0E2244FD-0AC9-4AB4-A8F0-729D78BE1D77', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'Day' => [ + 'description' => '图片在云端的存储天数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'IotId' => [ + 'description' => '设备ID。', + 'type' => 'string', + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0E2244FD-0AC9-4AB4-A8F0-729D78BE1D77\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Day\\": 7,\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryDevicePictureLifeCycleResponse>\\n<RequestId>0E2244FD-0AC9-4AB4-A8F0-729D78BE1D77</RequestId>\\n<Data>\\n <IotId>C47T6xwp6ms4bNlkHRWCg4****</IotId>\\n <Day>7</Day>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryDevicePictureLifeCycleResponse>","errorExample":""}]', + 'title' => '获取设备云存储图片生命周期', + 'summary' => '调用该接口查询IPC设备的云存储图片生命周期。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryDeviceVodUrlByTime' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Scheme', + 'in' => 'query', + 'schema' => [ + 'description' => '协议类型：'."\n" + .'- **rtmp**：RTMP协议。'."\n" + .'- **flv**：HTTP-FLV协议。'."\n" + .'- **hls**：HLS协议。'."\n" + .' > HLS协议使用限制详细内容，请参见[云端开发](~~208584~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp', + 'default' => 'rtmp', + ], + ], + [ + 'name' => 'SeekTime', + 'in' => 'query', + 'schema' => [ + 'description' => '相对于录像开始时间**BeginTime**的偏移量，单位为秒，默认值为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483648', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'EnableStun', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + [ + 'name' => 'ShouldEncrypt', + 'in' => 'query', + 'schema' => [ + 'description' => '是否加密：'."\n" + .'- **true**：加密。'."\n" + .'- **false**（默认）：不加密。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => '录像开始时间，格式为10位时间戳，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2147483648', + 'minimum' => '0', + 'example' => '1508200012', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + [ + 'name' => 'UrlValidDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'URL有效期，取值范围为10~14400，单位为秒。默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'PlayUnLimited', + 'in' => 'query', + 'schema' => [ + 'description' => '播放地址是否可以无限次使用：'."\n" + ."\n" + .'- **true**：10秒内可无限次使用。'."\n" + .'- **false**（默认）：仅可使用一次。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '录像结束时间，格式为10位时间戳，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2147483648', + 'minimum' => '0', + 'example' => '1582420940', + ], + ], + [ + 'name' => 'EncryptType', + 'in' => 'query', + 'schema' => [ + 'description' => '加密类型。目前仅支持I帧加密，取值为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483648', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。'."\n", + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'DecryptKey' => [ + 'description' => '解密密钥。'."\n" + .'设置**ShouldEncrypt**参数为**true**时，生成解密密钥。', + 'type' => 'string', + 'example' => '{"iv": "MDEy****OTo7PD0+Pw==","key": "eA2r****fHjOmnyBfQ=="}', + ], + 'StunInfo' => [ + 'type' => 'string', + ], + 'VodUrl' => [ + 'description' => '本地录像播放地址。', + 'type' => 'string', + 'example' => 'https://iotx-vision-vod-vpc-hz-pre.aliyun-inc.com/vod/device/localrecord/flv/play/1****668.flv?token=e9****a9e14482c56be52&session=470e****3d015', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"VodUrl\\": \\"https://iotx-vision-vod-vpc-hz-pre.aliyun-inc.com/vod/device/localrecord/flv/play/1****668.flv?token=e9****a9e14482c56be52&session=470e****3d015\\",\\n \\"DecryptKey\\": \\"{\\\\\\"iv\\\\\\": \\\\\\"MDEy****OTo7PD0+Pw==\\\\\\",\\\\\\"key\\\\\\": \\\\\\"eA2r****fHjOmnyBfQ==\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryDeviceVodUrlByTimeResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<DecryptKey>\\n <iv>MDEy****OTo7PD0+Pw==</iv>\\n <key>eA2r****fHjOmnyBfQ==</key>\\n</DecryptKey>\\n<Data>\\n <VodUrl>https://iotx-vision-vod-vpc-hz-pre.aliyun-inc.com/vod/device/localrecord/flv/play/1****668.flv?token=e9****a9e14482c56be52&session=470e****3d015</VodUrl>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryDeviceVodUrlByTimeResponse>","errorExample":""}]', + 'title' => '按时间查询设备直播URL', + 'summary' => '调用该接口，获取本地NVR设备或IPC设备存储卡中，指定录像时间范围的录像文件播放地址。', + 'description' => '## 使用限制'."\n" + ."\n" + .'仅支持IPC设备直连物联网平台场景。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFaceAllDeviceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例Id'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestIotInstanceId', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页号', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '接口返回信息', + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => '分页号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '设备组总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'DeviceGroupList' => [ + 'description' => '设备组列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceGroupId' => [ + 'description' => '设备组Id', + 'type' => 'string', + 'example' => 'wy250q0m', + ], + 'ModifiedTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-05-12 17:19:29', + ], + 'DeviceGroupName' => [ + 'description' => '设备组名称', + 'type' => 'string', + 'example' => 'TestDeviceGroupName', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 100,\\n \\"DeviceGroupList\\": [\\n {\\n \\"DeviceGroupId\\": \\"wy250q0m\\",\\n \\"ModifiedTime\\": \\"2020-05-12 17:19:29\\",\\n \\"DeviceGroupName\\": \\"TestDeviceGroupName\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <PageSize>20</PageSize>\\n <Total>100</Total>\\n <DeviceGroupList>\\n <ModifiedTime>2020-05-12 17:19:29</ModifiedTime>\\n <DeviceGroupName>TestDeviceGroupName</DeviceGroupName>\\n <DeviceGroupId>wy250q0m</DeviceGroupId>\\n </DeviceGroupList>\\n <PageNo>1</PageNo>\\n</Data>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '查询所有设备分组', + 'summary' => '查询所有设备分组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFaceDeviceGroupsByDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIotInstanceId', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '产品Key', + 'type' => 'string', + 'required' => true, + 'example' => 'TestProductKey', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '设备名', + 'type' => 'string', + 'required' => true, + 'example' => 'TestDeviceName', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页号', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误码描述', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '接口调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '接口返回值', + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => '分页号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '设备组总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'DeviceGroupList' => [ + 'description' => '设备组列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceGroupId' => [ + 'description' => '设备组Id', + 'type' => 'string', + 'example' => 'TestDeviceGroupId', + ], + 'ModifiedTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-05-12 17:12:37', + ], + 'DeviceGroupName' => [ + 'description' => '设备组名称', + 'type' => 'string', + 'example' => 'TestDeviceGroupName', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 5,\\n \\"DeviceGroupList\\": [\\n {\\n \\"DeviceGroupId\\": \\"TestDeviceGroupId\\",\\n \\"ModifiedTime\\": \\"2020-05-12 17:12:37\\",\\n \\"DeviceGroupName\\": \\"TestDeviceGroupName\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <PageSize>20</PageSize>\\n <Total>5</Total>\\n <DeviceGroupList>\\n <ModifiedTime>2020-05-12 17:12:37</ModifiedTime>\\n <DeviceGroupName>TestDeviceGroupName</DeviceGroupName>\\n <DeviceGroupId>TestDeviceGroupId</DeviceGroupId>\\n </DeviceGroupList>\\n <PageNo>1</PageNo>\\n</Data>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '查询设备所在的设备分组', + 'summary' => '查询设备所在的设备分组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryLiveStreaming' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Scheme', + 'in' => 'query', + 'schema' => [ + 'description' => '播放协议类型：'."\n" + ."\n" + .'- **rtmp**（默认）：RTMP协议。'."\n" + .'- **hls**：HLS协议。'."\n" + .'- **flv**：HTTP-FLV协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp', + 'default' => 'rtmp', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'EnableStun', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型：'."\n" + .'- **0**（默认）：主码流。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'CacheDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '视频缓存数据时长，取值范围为0~10000，单位为毫秒，默认值为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10000', + 'minimum' => '0', + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + [ + 'name' => 'ShouldEncrypt', + 'in' => 'query', + 'schema' => [ + 'description' => '是否加密：'."\n" + ."\n" + .'- **true**：加密。'."\n" + .'- **false**（默认）：不加密。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'UrlValidDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'URL有效期，取值范围为10~14400，单位为秒。默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'PlayUnLimited', + 'in' => 'query', + 'schema' => [ + 'description' => '播放地址在有效期内是否允许无限次使用：'."\n" + .'- **true**：允许。'."\n" + .'- **false**（默认）：不允许。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'EncryptType', + 'in' => 'query', + 'schema' => [ + 'description' => '加密类型：'."\n" + .'- **1**（默认）：关键帧加密。'."\n" + .'- **0**：不加密。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'ForceIFrame', + 'in' => 'query', + 'schema' => [ + 'description' => '是否给设备下发强制I帧指令：'."\n" + ."\n" + .'- **true**：下发。'."\n" + .'- **false**（默认）：不下发。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'stream push failed', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '播放地址信息。', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => '直播播放地址。'."\n" + .'>播放地址有效期为10秒。', + 'type' => 'string', + 'example' => 'rtmp://47.100.***.***:8000/live?token=dc1****120ce394ef94974/Eb****6RBe8l4_0', + ], + 'RelayDecryptKey' => [ + 'type' => 'string', + ], + 'StunInfo' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"stream push failed\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Path\\": \\"rtmp://47.100.***.***:8000/live?token=dc1****120ce394ef94974/Eb****6RBe8l4_0\\",\\n \\"RelayDecryptKey\\": \\"\\",\\n \\"StunInfo\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryLiveStreamingResponse>\\n<RequestId>01155F78-1A0B-57BE-8349-591341CA7DFC</RequestId>\\n<Data>\\n <Path>rtmp://47.100.***.***:8000/live?token=dc1****120ce394ef94974/Eb****6RBe8l4_0</Path>\\n <DecryptKey>\\n <iv>MDEy****OTo7PD0+Pw==</iv>\\n <key>eA2r****fHjOmnyBfQ==</key>\\n </DecryptKey>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryLiveStreamingResponse>","errorExample":""}]', + 'title' => 'QueryLiveStreaming', + 'summary' => '调用该接口获取IPC设备的直播开播地址。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryVoiceIntercom' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Scheme', + 'in' => 'query', + 'schema' => [ + 'description' => '语音对讲的连接协议类型。可取值：'."\n" + ."\n" + .'- **ws**：表示WebSocket连接协议。Web端实现语音对讲能力时，调用本接口获取的Web语音通话地址。<props="china"><ph>Web端与设备端实现语音对讲能力的详细说明，请参见[Web语音对讲集成说明](~~2545966~~)。</ph></props>'."\n" + .'- **rtmp**（默认）：Android和iOS应用端播放器实现语音对讲时，调用本接口获取的对应语音通话地址。Android和iOS应用端与设备端实现语音对讲能力的详细说明，请参见[Android语音对讲](~~260925~~)和[iOS语音对讲](~~253953~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp', + 'default' => 'rtmp', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该**ID**值，否则调用会失败。'."\n" + .'- 若无**实例概览**页面或**ID**值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y*****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的**ProductKey**。'."\n" + .'您可以在物联网平台控制台**产品**页面或调用接口[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页面查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用接口[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> **IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果传入该参数，则无需传入**ProductKey**和**DeviceName**。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。'."\n", + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '语音对讲地址信息。', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '语音对讲地址。', + 'type' => 'string', + 'example' => 'rtmp://***.***.***.***:8000/talk?token=********', + ], + 'CryptoKey' => [ + 'description' => '解密参数。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '解密密钥。', + 'type' => 'string', + 'example' => 'bPvz6tnfonP1E+********v2Q==', + ], + 'Iv' => [ + 'description' => '解密向量。', + 'type' => 'string', + 'example' => 'MDEyMzQ1Njc4********0+Pw==', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Url\\": \\"rtmp://***.***.***.***:8000/talk?token=********\\",\\n \\"CryptoKey\\": {\\n \\"Key\\": \\"bPvz6tnfonP1E+********v2Q==\\",\\n \\"Iv\\": \\"MDEyMzQ1Njc4********0+Pw==\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryVoiceIntercomResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>\\n <Url>rtmp://***.***.***.***:8000/talk?token=********</Url>\\n <CryptoKey>\\n <Iv>MDEyMzQ1Njc4****0+Pw==</Iv>\\n <Key>bPvz6tnfonP1E+****2Q==</Key>\\n </CryptoKey>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryVoiceIntercomResponse>","errorExample":""}]', + 'title' => '请求语音对讲地址', + 'summary' => '调用该接口获取IPC设备的语音对讲地址。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveFaceDeviceFromDeviceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例Id', + 'type' => 'string', + 'required' => false, + 'example' => 'TestIotInstanceId', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '物联网平台产品Key', + 'type' => 'string', + 'required' => true, + 'example' => 'TestProductKey', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '设备名称', + 'type' => 'string', + 'required' => true, + 'example' => 'TestDeviceName', + ], + ], + [ + 'name' => 'DeviceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备组Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestDeviceGroupId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '将设备移出设备分组', + 'summary' => '将设备移出设备分组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddFaceUserGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离ID，用于同一个阿里云账号下不同业务应用之间的数据隔离，支持英文大小写字母、数字。'."\n" + ."\n" + .'例如，您在A地区和B地区，均有人脸识别业务，那么可设置不同的业务隔离ID，区分A、B地区的人脸识别业务。'."\n" + ."\n" + .'><notice>'."\n" + .'请妥善保存业务隔离ID值，以便后续调用此业务隔离区其它接口时使用。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHZ', + ], + ], + [ + 'name' => 'UserGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组名称，请自定义参数值，长度不超过128个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestUserGroup', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'group already exist', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：表示调用成功。'."\n" + .'- **false**：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'UserGroupName' => [ + 'description' => '用户组名称。', + 'type' => 'string', + 'example' => 'TestUserGroup', + ], + 'ModifiedTime' => [ + 'description' => '添加用户组的时间。', + 'type' => 'string', + 'example' => '2020-11-20 18:59:01', + ], + 'UserGroupId' => [ + 'description' => '系统为该用户组生成的ID。'."\n" + ."\n" + .'> 在人脸底库服务的其它接口调用中，会使用**UserGroupId**，请妥善保存。', + 'type' => 'string', + 'example' => 'kvjy****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"group already exist\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"UserGroupName\\": \\"TestUserGroup\\",\\n \\"ModifiedTime\\": \\"2020-11-20 18:59:01\\",\\n \\"UserGroupId\\": \\"kvjy****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddFaceUserGroupResponse>\\n <RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n <Data>\\n <ModifiedTime>2020-11-20 18:59:01</ModifiedTime>\\n <UserGroupName>TestUserGroup</UserGroupName>\\n <UserGroupId>kvjy****</UserGroupId>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AddFaceUserGroupResponse>","errorExample":""}]', + 'title' => '添加用户组', + 'summary' => '调用该接口创建用户组。', + 'description' => '## 使用说明'."\n" + ."\n" + .'- 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + ."\n" + .' > RAM用户共享阿里云账号配额。'."\n" + ."\n" + .'- 调用该接口后，系统会返回用户组的ID（**UserGroupId**），建议保存该值到本地，以便后续调用其它接口时使用。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddFaceUserToUserGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离ID，用于同一个阿里云账号下不同业务应用之间的数据隔离。'."\n" + ."\n" + .'><notice>'."\n" + .'用户和用户组，必须在同一个隔离ID下。请与调用[AddFaceUser](~~288338~~)接口添加用户，和调用[AddFaceUserGroup](~~288341~~)接口创建用户组时设置的**IsolationId**保持一致。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHZ', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。请传入在调用[AddFaceUser](~~288338~~)接口添加用户后，获取并保存到本地的用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => '3mtjaqebeq4d****', + ], + ], + [ + 'name' => 'UserGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组ID。请传入在调用[AddFaceUserGroup](~~288341~~)接口创建用户组后，获取并保存到本地的用户组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'kvjy****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'face user not exist', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：表示调用成功。'."\n" + .'- **false**：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"face user not exist\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddFaceUserToUserGroupResponse>\\r\\n <RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\r\\n <Code>200</Code>\\r\\n <Success>true</Success>\\r\\n</AddFaceUserToUserGroupResponse>","errorExample":""}]', + 'title' => '将用户添加到用户组', + 'summary' => '调用该接口将用户添加到用户组。', + 'description' => '## 限制条件'."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + .' > RAM用户共享阿里云账号配额。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteFaceUserGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离ID，用于隔离同一个阿里云账号下不同业务应用之间的数据。请与调用[AddFaceUserGroup](~~288341~~)接口添加用户时设置的**IsolationId**保持一致。', + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHZ', + ], + ], + [ + 'name' => 'UserGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组ID。请传入在调用[AddFaceUserGroup](~~288341~~)接口添加用户组后，获取并保存到本地的用户组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'kvjy****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'face group not exist', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：表示调用成功。'."\n" + .'- **false**：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"face group not exist\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteFaceUserGroupResponse>\\r\\n\\t<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DeleteFaceUserGroupResponse>","errorExample":""}]', + 'title' => 'DeleteFaceUserGroup', + 'summary' => '调用该接口删除指定的用户组。', + 'description' => '## 限制条件'."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + .' > RAM用户共享阿里云账号配额。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateFaceUserGroupAndDeviceGroupRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离ID，用于隔离同一个阿里云账号下不同业务应用之间的数据。请与调用[AddFaceUserGroupAndDeviceGroupRelation](~~288342~~)接口，添加用户组与设备组之间的人脸同步关系时设置的**IsolationId**保持一致。', + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHZ', + ], + ], + [ + 'name' => 'ControlId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组与设备组同步关系控制ID。请传入调用[AddFaceUserGroupAndDeviceGroupRelation](~~288342~~)接口，添加用户组与设备组之间的人脸同步关系时，获取并保存到本地的**ControlId**值。', + 'type' => 'string', + 'required' => true, + 'example' => 'qcb2yea4ha4d****', + ], + ], + [ + 'name' => 'Relation', + 'in' => 'query', + 'schema' => [ + 'description' => '人脸同步关系。当前仅支持设置为**SYNC_INFO_PICTURE**，表示同步用户照片和用户信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'SYNC_INFO_PICTURE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'access control not exist', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：表示调用成功。'."\n" + .'- **false**：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'ControlId' => [ + 'description' => '用户组与设备组同步关系控制ID。', + 'type' => 'string', + 'example' => 'qcb2yea4ha4d****', + ], + 'ModifiedTime' => [ + 'description' => '最后一次更新用户组与设备组之间的人脸同步关系时间。', + 'type' => 'string', + 'example' => '2020-04-25 19:29:30', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"access control not exist\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ControlId\\": \\"qcb2yea4ha4d****\\",\\n \\"ModifiedTime\\": \\"2020-04-25 19:29:30\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateFaceUserGroupAndDeviceGroupRelationResponse>\\r\\n\\t<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\r\\n\\t<Data>\\r\\n\\t\\t<ModifiedTime>2020-04-25 19:29:30</ModifiedTime>\\r\\n\\t\\t<ControlId>qcb2yea4ha4d****</ControlId>\\r\\n\\t</Data>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</UpdateFaceUserGroupAndDeviceGroupRelationResponse>","errorExample":""}]', + 'title' => '更新设备组、用户组人脸同步关系', + 'summary' => '调用该接口，更新用户组与设备组之间的人脸同步关系。', + 'description' => '## 限制条件'."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + .' > RAM用户共享阿里云账号配额。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateFaceUser' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离ID。'."\n" + .'<br>用于租户下不同应用之间的数据隔离。如某用户在浙江、陕西都有业务，则可以为浙江和西安的业务分别创建两个隔离ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolati****', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'tibce3fsgqel****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'ZhangSan', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '用户信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{"age":28, "sex":"male"}', + ], + ], + [ + 'name' => 'FacePicUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '图片URL下载地址，目前支持JPG、JPEG格式图片。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://test.com/test.jpg', + ], + ], + [ + 'name' => 'CustomUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '该参数为调用者业务系统中，用户的唯一ID，如身份证号、学号等。', + 'type' => 'string', + 'required' => false, + 'example' => '52242819650301xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '错误描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateFaceUserResponse>\\n <RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n <ErrorMessage>success</ErrorMessage>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdateFaceUserResponse>","errorExample":""}]', + 'title' => '更新用户信息', + 'summary' => '更新用户信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFaceAllUserGroupAndDeviceGroupRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'Isolati***', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页号。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '错误描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '接口调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '接口返回值。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Page' => [ + 'description' => '分页号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'List' => [ + 'description' => '用户组、设备组人脸同步关系列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceGroupId' => [ + 'description' => '设备组ID。', + 'type' => 'string', + 'example' => 'TestDeviceGro****', + ], + 'ControlId' => [ + 'description' => '用户组、设备组同步关系控制ID。', + 'type' => 'string', + 'example' => 'ni1iyxqry0j0****', + ], + 'ModifiedTime' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '2020-05-12 17:12:37', + ], + 'ControlType' => [ + 'description' => '人脸同步关系（同步用户照片和用户信息）。', + 'type' => 'string', + 'example' => 'SYNC_INFO_PICTURE', + ], + 'UserGroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => 'TestUserGro****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 20,\\n \\"Total\\": 10,\\n \\"Page\\": 1,\\n \\"List\\": [\\n {\\n \\"DeviceGroupId\\": \\"TestDeviceGro****\\",\\n \\"ControlId\\": \\"ni1iyxqry0j0****\\",\\n \\"ModifiedTime\\": \\"2020-05-12 17:12:37\\",\\n \\"ControlType\\": \\"SYNC_INFO_PICTURE\\",\\n \\"UserGroupId\\": \\"TestUserGro****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryFaceAllUserGroupAndDeviceGroupRelationResponse>\\n\\t<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n\\t<Data>\\n\\t\\t<PageSize>20</PageSize>\\n\\t\\t<Total>10</Total>\\n\\t\\t<Page>1</Page>\\n\\t\\t<List>\\n\\t\\t\\t<ControlType>SYNC_INFO_PICTURE</ControlType>\\n\\t\\t\\t<ModifiedTime>2020-05-12 17:12:37</ModifiedTime>\\n\\t\\t\\t<DeviceGroupId>TestDeviceGro****</DeviceGroupId>\\n\\t\\t\\t<ControlId>ni1iyxqry0j0****</ControlId>\\n\\t\\t\\t<UserGroupId>TestUserGro****</UserGroupId>\\n\\t\\t</List>\\n\\t</Data>\\n\\t<ErrorMessage>success</ErrorMessage>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</QueryFaceAllUserGroupAndDeviceGroupRelationResponse>","errorExample":""}]', + 'title' => '查询已添加人脸同步关系的用户组和设备组', + 'summary' => '查询已添加人脸同步关系的用户组和设备组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFaceUserGroupAndDeviceGroupRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'ControlId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组、设备组人脸同步关系控制Id', + 'type' => 'string', + 'required' => true, + 'example' => 'ni1iyxqry0j03plv', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '接口调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '接口调用返回值', + 'type' => 'object', + 'properties' => [ + 'DeviceGroupId' => [ + 'description' => '设备组Id', + 'type' => 'string', + 'example' => 'TestDeviceGroupId', + ], + 'ControlId' => [ + 'description' => '用户组、设备组人脸同步关系控制Id', + 'type' => 'string', + 'example' => 'ni1iyxqry0j03plv', + ], + 'ModifiedTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-05-12 17:12:37', + ], + 'ControlType' => [ + 'description' => '人脸同步关系', + 'type' => 'string', + 'example' => 'SYNC_INFO_PICTURE', + ], + 'UserGroupId' => [ + 'description' => '用户组Id', + 'type' => 'string', + 'example' => 'TestUserGroupId', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DeviceGroupId\\": \\"TestDeviceGroupId\\",\\n \\"ControlId\\": \\"ni1iyxqry0j03plv\\",\\n \\"ModifiedTime\\": \\"2020-05-12 17:12:37\\",\\n \\"ControlType\\": \\"SYNC_INFO_PICTURE\\",\\n \\"UserGroupId\\": \\"TestUserGroupId\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <ModifiedTime>2020-05-12 17:12:37</ModifiedTime>\\n <DeviceGroupId>TestDeviceGroupId</DeviceGroupId>\\n <UserGroupId>TestUserGroupId</UserGroupId>\\n <ControlType>SYNC_INFO_PICTURE</ControlType>\\n <ControlId>ni1iyxqry0j03plv</ControlId>\\n</Data>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '查询用户组、设备组人脸同步关系', + 'summary' => '查询用户组、设备组人脸同步关系。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFaceUserIdByCustomUserId' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'CustomUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '调用者系统中的用户Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestCustomUserId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '接口调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '接口返回值', + 'type' => 'object', + 'properties' => [ + 'Params' => [ + 'description' => '用户参数', + 'type' => 'string', + 'example' => '{"age":28, "sex":"male"}', + ], + 'CustomUserId' => [ + 'description' => '调用者系统中的用户Id', + 'type' => 'string', + 'example' => 'TestCustomUserId', + ], + 'Name' => [ + 'description' => '用户名', + 'type' => 'string', + 'example' => 'TestName', + ], + 'UserId' => [ + 'description' => '用户Id', + 'type' => 'string', + 'example' => 'TestUserId', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Params\\": \\"{\\\\\\"age\\\\\\":28, \\\\\\"sex\\\\\\":\\\\\\"male\\\\\\"}\\",\\n \\"CustomUserId\\": \\"TestCustomUserId\\",\\n \\"Name\\": \\"TestName\\",\\n \\"UserId\\": \\"TestUserId\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <UserId>TestUserId</UserId>\\n <Params>{\\"age\\":28, \\"sex\\":\\"male\\"}</Params>\\n <CustomUserId>TestCustomUserId</CustomUserId>\\n <Name>TestName</Name>\\n</Data>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '查询人脸底库同步服务中的用户ID', + 'summary' => '根据调用者系统中的用户Id查询人脸底库同步服务中的用户Id。', + ], + 'QueryFaceAllUserGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页号', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '接口返回值', + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => '分页号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '用户组总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'UserGroupList' => [ + 'description' => '用户组信息列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserGroupName' => [ + 'description' => '用户组名称', + 'type' => 'string', + 'example' => 'TestUserGroupName', + ], + 'ModifiedTime' => [ + 'description' => '最近修改时间', + 'type' => 'string', + 'example' => '2020-05-12 17:12:37', + ], + 'UserGroupId' => [ + 'description' => '用户组Id', + 'type' => 'string', + 'example' => 'dmjpxfdk', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 100,\\n \\"UserGroupList\\": [\\n {\\n \\"UserGroupName\\": \\"TestUserGroupName\\",\\n \\"ModifiedTime\\": \\"2020-05-12 17:12:37\\",\\n \\"UserGroupId\\": \\"dmjpxfdk\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <PageSize>20</PageSize>\\n <UserGroupList>\\n <ModifiedTime>2020-05-12 17:12:37</ModifiedTime>\\n <UserGroupName>TestUserGroupName</UserGroupName>\\n <UserGroupId>dmjpxfdk</UserGroupId>\\n </UserGroupList>\\n <Total>100</Total>\\n <PageNo>1</PageNo>\\n</Data>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '查询所有用户分组', + 'summary' => '查询所有用户分组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFaceAllUserIdsByGroupId' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'UserGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestUserGroupId', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页号', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '接口返回值', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '用户总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Page' => [ + 'description' => '分页号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'List' => [ + 'description' => '用户信息列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Params' => [ + 'description' => '用户参数', + 'type' => 'string', + 'example' => '{"age":28, "sex":"male"}', + ], + 'CustomUserId' => [ + 'description' => '调用者服务中的用户Id', + 'type' => 'string', + 'example' => 'TestCustomUserId', + ], + 'Name' => [ + 'description' => '用户名', + 'type' => 'string', + 'example' => 'TestName', + ], + 'UserId' => [ + 'description' => '用户Id', + 'type' => 'string', + 'example' => 'TestUserId', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 20,\\n \\"Total\\": 100,\\n \\"Page\\": 1,\\n \\"List\\": [\\n {\\n \\"Params\\": \\"{\\\\\\"age\\\\\\":28, \\\\\\"sex\\\\\\":\\\\\\"male\\\\\\"}\\",\\n \\"CustomUserId\\": \\"TestCustomUserId\\",\\n \\"Name\\": \\"TestName\\",\\n \\"UserId\\": \\"TestUserId\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <PageSize>20</PageSize>\\n <Total>100</Total>\\n <Page>1</Page>\\n <List>\\n <Params>{\\"age\\":28, \\"sex\\":\\"male\\"}</Params>\\n <CustomUserId>TestCustomUserId</CustomUserId>\\n <UserId>TestUserId</UserId>\\n <Name>TestName</Name>\\n </List>\\n</Data>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '查询用户组下的所有用户', + 'summary' => '查询用户组下的所有用户。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFaceCustomUserIdByUserId' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestUserId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '调用者系统中的用户Id', + 'type' => 'string', + 'example' => 'TestCustomUserId', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"TestCustomUserId\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>TestCustomUserId</Data>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '查询调用者服务中的用户 ID', + 'summary' => '根据人脸底库同步服务用户 ID 查询调用者服务中的用户 ID。', + ], + 'QueryFaceUser' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestUserId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '接口调用是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '接口返回值', + 'type' => 'object', + 'properties' => [ + 'Params' => [ + 'description' => '用户参数', + 'type' => 'string', + 'example' => '{"age":28, "sex":"male"}', + ], + 'CustomUserId' => [ + 'description' => '调用者系统中的用户Id', + 'type' => 'string', + 'example' => 'TestCustomUserId', + ], + 'Name' => [ + 'description' => '用户名', + 'type' => 'string', + 'example' => 'TestName', + ], + 'UserId' => [ + 'description' => '用户Id', + 'type' => 'string', + 'example' => 'TestUserId', + ], + 'FacePicList' => [ + 'description' => '人脸照片信息列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceUrl' => [ + 'description' => '照片Url', + 'type' => 'string', + 'example' => 'https://test.com/xxx.jpg', + ], + 'FaceMd5' => [ + 'description' => '照片MD5值', + 'type' => 'string', + 'example' => 'TestFaceMd5', + ], + 'FeatureDTOList' => [ + 'description' => '人脸特征值列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AlgorithmName' => [ + 'description' => '算法名', + 'type' => 'string', + 'example' => 'TestAlgorithmName', + ], + 'AlgorithmVersion' => [ + 'description' => '算法版本', + 'type' => 'string', + 'example' => 'TestAlgorithmVersion', + ], + 'AlgorithmProvider' => [ + 'description' => '算法提供者', + 'type' => 'string', + 'example' => 'TestAlgorithmProvider', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'FaceMd5' => [ + 'description' => '人脸MD5'."\n", + 'type' => 'string', + 'example' => 'TestFaceMd5', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Params\\": \\"{\\\\\\"age\\\\\\":28, \\\\\\"sex\\\\\\":\\\\\\"male\\\\\\"}\\",\\n \\"CustomUserId\\": \\"TestCustomUserId\\",\\n \\"Name\\": \\"TestName\\",\\n \\"UserId\\": \\"TestUserId\\",\\n \\"FacePicList\\": [\\n {\\n \\"FaceUrl\\": \\"https://test.com/xxx.jpg\\",\\n \\"FaceMd5\\": \\"TestFaceMd5\\",\\n \\"FeatureDTOList\\": [\\n {\\n \\"AlgorithmName\\": \\"TestAlgorithmName\\",\\n \\"AlgorithmVersion\\": \\"TestAlgorithmVersion\\",\\n \\"AlgorithmProvider\\": \\"TestAlgorithmProvider\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"ErrorCode\\": \\"200\\",\\n \\"FaceMd5\\": \\"TestFaceMd5\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <UserId>TestUserId</UserId>\\n <Params>{\\"age\\":28, \\"sex\\":\\"male\\"}</Params>\\n <CustomUserId>TestCustomUserId</CustomUserId>\\n <FacePicList>\\n <FaceMd5>TestFaceMd5</FaceMd5>\\n <FaceUrl>https://test.com/xxx.jpg</FaceUrl>\\n </FacePicList>\\n <FacePicList>\\n <FeatureDTOList>\\n <AlgorithmVersion>TestAlgorithmVersion</AlgorithmVersion>\\n <ErrorCode>200</ErrorCode>\\n <AlgorithmProvider>TestAlgorithmProvider</AlgorithmProvider>\\n <ErrorMessage>success</ErrorMessage>\\n <FaceMd5>TestFaceMd5</FaceMd5>\\n <AlgorithmName>TestAlgorithmName</AlgorithmName>\\n </FeatureDTOList>\\n </FacePicList>\\n <Name>TestName</Name>\\n</Data>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '查询用户详细信息', + 'summary' => '查询用户详细信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFaceUserGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestUserId', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '分页号', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '接口返回值', + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'description' => '分页号', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '用户组总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'UserGroupList' => [ + 'description' => '用户组列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserGroupName' => [ + 'description' => '用户组名称', + 'type' => 'string', + 'example' => 'TestUserGroupName', + ], + 'ModifiedTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-05-12 17:12:37', + ], + 'UserGroupId' => [ + 'description' => '用户组Id', + 'type' => 'string', + 'example' => 'TestUserGroupId', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 5,\\n \\"UserGroupList\\": [\\n {\\n \\"UserGroupName\\": \\"TestUserGroupName\\",\\n \\"ModifiedTime\\": \\"2020-05-12 17:12:37\\",\\n \\"UserGroupId\\": \\"TestUserGroupId\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <PageSize>20</PageSize>\\n <UserGroupList>\\n <ModifiedTime>2020-05-12 17:12:37</ModifiedTime>\\n <UserGroupName>TestUserGroupName</UserGroupName>\\n <UserGroupId>TestUserGroupId</UserGroupId>\\n </UserGroupList>\\n <Total>5</Total>\\n <PageNo>1</PageNo>\\n</Data>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '查询用户所在的用户组', + 'summary' => '查询用户所在的用户组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RemoveFaceUserFromUserGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestUserId', + ], + ], + [ + 'name' => 'UserGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestUserGroupId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '将用户从用户分组中移除', + 'summary' => '将用户从用户分组中移除。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddFaceUser' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离ID，用于同一个阿里云账号下不同业务应用之间的数据隔离，支持英文大小写字母、数字。'."\n" + ."\n" + .'例如，您在A地区和B地区，均有人脸识别业务，那么可设置不同的业务隔离ID，区分A、B地区的人脸识别业务。'."\n" + ."\n" + .'><notice>'."\n" + .'请妥善保存业务隔离ID值，以便后续调用此业务隔离区其它接口时使用。'."\n" + .'></notice>'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHZ', + ], + ], + [ + 'name' => 'FacePicUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '用户的人脸图片URL下载地址，目前仅支持JPEG和JPG格式的图片，且图片URL不能包含中文。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://example.com/test.jpeg', + ], + ], + [ + 'name' => 'CustomUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户身份识别ID，支持英文大写字母和数字。'."\n" + ."\n" + .'建议您设置为该用户的身份证号、学号等。', + 'type' => 'string', + 'required' => true, + 'example' => '1234567890', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名。支持中文、英文字母大小写、数字、下划线（_）和短划线（-），长度不超过64个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'Tony', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '用户参数，请自定义。', + 'type' => 'string', + 'required' => false, + 'example' => '{"key1":"value1", "key2":"value2"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'face user already exist', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：表示调用成功。'."\n" + .'- **false**：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'Params' => [ + 'description' => '自定义的用户参数。', + 'type' => 'string', + 'example' => '{"key1":"value1", "key2":"value2"}', + ], + 'CustomUserId' => [ + 'description' => '用户身份识别ID。', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Name' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'Tony', + ], + 'UserId' => [ + 'description' => '系统为本次添加的用户生成的ID。'."\n" + ."\n" + .'> 在人脸底库服务的其它接口调用中，会使用**UserId**，请妥善保存。'."\n", + 'type' => 'string', + 'example' => '3mtjaqebeq4d****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"face user already exist\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Params\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"CustomUserId\\": \\"1234567890\\",\\n \\"Name\\": \\"Tony\\",\\n \\"UserId\\": \\"3mtjaqebeq4d****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddFaceUserResponse>\\n <RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n <Data>\\n <UserId>3mtjaqebeq4d****</UserId>\\n <CustomUserId>1234567890</CustomUserId>\\n <Name>Tony</Name>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AddFaceUserResponse>","errorExample":""}]', + 'title' => '向人脸管理服务添加一个用户', + 'summary' => '调用该接口向人脸底库添加一个用户。', + 'description' => '## 使用说明'."\n" + ."\n" + .'- 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + ."\n" + .' > RAM用户共享阿里云账号配额。'."\n" + ."\n" + .'- 请提前为用户的人脸图片，配置URL下载地址。'."\n" + ."\n" + .' > 当前仅支持JPEG和JPG格式的图片，且图片URL中不能包含中文。'."\n" + ."\n" + .'- 调用该接口后，系统会返回用户ID（**UserId**），建议保存该值到本地，以便后续调用其它接口时使用。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddFaceUserGroupAndDeviceGroupRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'TestIsolationId', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例Id', + 'type' => 'string', + 'required' => false, + 'example' => 'TestInstanceId', + ], + ], + [ + 'name' => 'UserGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组Id', + 'type' => 'string', + 'required' => true, + 'example' => 'avjyxurd', + ], + ], + [ + 'name' => 'DeviceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备组Id', + 'type' => 'string', + 'required' => true, + 'example' => 'kvjyhurc', + ], + ], + [ + 'name' => 'Relation', + 'in' => 'query', + 'schema' => [ + 'description' => '人脸同步关系', + 'type' => 'string', + 'required' => true, + 'example' => 'SYNC_INFO_PICTURE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '错误描述', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '人脸同步关系信息', + 'type' => 'object', + 'properties' => [ + 'ControlId' => [ + 'description' => '关联控制Id', + 'type' => 'string', + 'example' => 'qcb2yea4ha4dxmly', + ], + 'ModifiedTime' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2020-11-20 18:59:01', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ControlId\\": \\"qcb2yea4ha4dxmly\\",\\n \\"ModifiedTime\\": \\"2020-11-20 18:59:01\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <ModifiedTime>2020-11-20 18:59:01</ModifiedTime>\\n <ControlId>qcb2yea4ha4dxmly</ControlId>\\n</Data>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '用户组、设备组添加人脸同步关系', + 'summary' => '用户组、设备组添加人脸同步关系。', + 'requestParamsDescription' => '1. IsolationId解释：用于租户下不同应用之间的数据隔离。如某用户在浙江、陕西都有业务，则可以为浙江和西安的业务分别创建两个隔离Id'."\n" + .'2. IotInstanceId解释：物联网平台实例Id'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddFaceUserPicture' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离ID，用于隔离同一个阿里云账号下不同业务应用之间的数据。请与调用[AddFaceUser](~~288338~~)接口添加用户时设置的**IsolationId**保持一致。', + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHZ', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。请传入在调用[AddFaceUser](~~288338~~)接口添加用户后，获取并保存到本地的**UserId**值。', + 'type' => 'string', + 'required' => true, + 'example' => '3mtjaqebeq4d****', + ], + ], + [ + 'name' => 'FacePicUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '用户的人脸图片URL下载地址，当前仅支持JPEG和JPG格式的图片，且图片URL中不能包含中文。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://example.com/test.jpeg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '调用成功时，返回的用户人脸图片唯一标识符。'."\n" + ."\n" + .'> 在人脸底库服务的其它接口调用中，会使用人脸图片唯一标识符，请妥善保存。', + 'type' => 'object', + 'example' => '1bb580ef7****', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'face user not exist', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '4de2c367-c1db-417c-aa15-8c585e595d92', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：表示调用成功。'."\n" + .'- **false**：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ErrorMessage\\": \\"face user not exist\\",\\n \\"RequestId\\": \\"4de2c367-c1db-417c-aa15-8c585e595d92\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddFaceUserPictureResponse>\\r\\n\\t<RequestId>4de2c367-c1db-417c-aa15-8c585e595d92</RequestId>\\r\\n\\t<Data>1bb580ef7****</Data>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</AddFaceUserPictureResponse>","errorExample":""}]', + 'title' => 'AddFaceUserPicture', + 'summary' => '调用该接口，为人脸底库中的用户增加一张人脸图片。', + 'description' => '## 使用说明'."\n" + ."\n" + .'- 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + ."\n" + .' > RAM用户共享阿里云账号配额。'."\n" + ."\n" + .'- 请提前为用户的人脸图片，配置URL下载地址。'."\n" + ."\n" + .' > 当前仅支持JPEG和JPG格式的图片，且图片URL中不能包含中文。'."\n" + ."\n" + .'- 调用该接口后，系统会返回用户人脸图片的唯一标识符（**Data**），建议保存该值到本地，以便后续调用其它接口时使用。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteFaceUser' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHzXiHu', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '人脸服务内部用户唯一Id', + 'type' => 'string', + 'required' => true, + 'example' => '3mtjaqebeq4dulcy', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '错误码描述信息', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '向人脸管理服务删除一个用户', + 'summary' => '向人脸管理服务删除一个用户。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteFaceUserGroupAndDeviceGroupRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离ID，用于隔离同一个阿里云账号下不同业务应用之间的数据。请与调用[AddFaceUserGroupAndDeviceGroupRelation](~~288342~~)接口，添加用户组与设备组之间的人脸同步关系时设置的**IsolationId**保持一致。', + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHZ', + ], + ], + [ + 'name' => 'ControlId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组与设备组同步关系控制ID。请传入调用[AddFaceUserGroupAndDeviceGroupRelation](~~288342~~)接口，添加用户组与设备组之间的人脸同步关系时，获取并保存到本地的**ControlId**参数值。', + 'type' => 'string', + 'required' => true, + 'example' => 'qcb2yea4ha4d****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'access control not exist', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：表示调用成功。'."\n" + .'- **false**：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"access control not exist\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteFaceUserGroupAndDeviceGroupRelationResponse>\\n\\t<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</DeleteFaceUserGroupAndDeviceGroupRelationResponse>","errorExample":""}]', + 'title' => '删除用户组和设备组的人脸同步关系', + 'summary' => '调用该接口，删除用户组与设备组之间的人脸同步关系。', + 'description' => '## 限制条件'."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + .' > RAM用户共享阿里云账号配额。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteFaceUserPicture' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离ID，用于隔离同一个阿里云账号下不同业务应用之间的数据。请与调用[AddFaceUser](~~288338~~)接口添加用户时设置的**IsolationId**保持一致。', + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHZ', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户ID。请传入在调用[AddFaceUser](~~288338~~)接口添加用户后，获取并保存到本地的**UserId**值。', + 'type' => 'string', + 'required' => true, + 'example' => '3mtjaqebeq4d****', + ], + ], + [ + 'name' => 'FacePicMd5', + 'in' => 'query', + 'schema' => [ + 'description' => '用户人脸图片的唯一标识符。请传入在调用[AddFaceUserPicutre](~~312040~~)接口为用户添加人脸图片后，获取并保存到本地的**Data**值。', + 'type' => 'string', + 'required' => true, + 'example' => '1bb580ef7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '4de2c367-c1db-417c-aa15-8c585e595d92', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'face user not exist', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：表示调用成功。'."\n" + .'- **false**：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"4de2c367-c1db-417c-aa15-8c585e595d92\\",\\n \\"ErrorMessage\\": \\"face user not exist\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteFaceUserPictureResponse>\\r\\n\\t<RequestId>4de2c367-c1db-417c-aa15-8c585e595d92</RequestId>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</DeleteFaceUserPictureResponse>","errorExample":""}]', + 'title' => 'DeleteFaceUserPicture', + 'summary' => '调用该接口，从人脸底库的用户中删除指定的人脸图片。', + 'description' => '## 限制条件'."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + .' > RAM用户共享阿里云账号配额。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CheckFaceUserDoExistOnDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => true, + 'example' => 'a103lZ86ovStDMnU', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '隔离Id', + 'type' => 'string', + 'required' => false, + 'example' => 'TestIotInstanceId', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '用户Id', + 'type' => 'string', + 'required' => true, + 'example' => 'tibce3fsgqelezk8', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '物联网平台产品Key', + 'type' => 'string', + 'required' => true, + 'example' => 'a1654Sr4Y3f', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '设备名称', + 'type' => 'string', + 'required' => true, + 'example' => 'TestDeviceName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '错误信息', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求Id', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '检查返回信息', + 'type' => 'object', + 'properties' => [ + 'DoExist' => [ + 'description' => '指定用户是否人脸同步成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DoExist\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <DoExist>true</DoExist>\\n</Data>\\n<ErrorMessage>success</ErrorMessage>\\n<Code>200</Code>\\n<Success>true</Success>","errorExample":""}]', + 'title' => '检查指定用户是否在设备上同步人脸成功', + 'summary' => '检查指定用户是否在设备上同步人脸成功。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ClearFaceDeviceDB' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHZ', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot_instc_pu****_c*-v64********', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'V系列边缘一体机对应的设备所属产品唯一标识。在边缘计算控制台V系列边缘一体机的**主机详情**页面**基本信息**页签，找到**视频网关**信息，获取**ProductKey**值。', + 'type' => 'string', + 'required' => true, + 'example' => 'a1Wmy******', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'V系列边缘一体机对应的设备名称。在边缘计算控制台V系列边缘一体机的**主机详情**页面**基本信息**页签，找到**视频网关**信息，获取**DeviceName**值。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestDevice_1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '调用成功时，返回空值，表示该V系列边缘一体机指定隔离ID下的人脸底库已清空。', + 'type' => 'object', + 'example' => '""', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'device not found', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：表示调用成功。'."\n" + .'- **false**：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"\\",\\n \\"ErrorMessage\\": \\"device not found\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ClearFaceDeviceDBResponse>\\r\\n\\t<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\r\\n\\t<Data/>\\r\\n\\t<Code>200</Code>\\r\\n\\t<Success>true</Success>\\r\\n</ClearFaceDeviceDBResponse>","errorExample":""}]', + 'title' => '清空设备人脸库', + 'summary' => '调用该接口，清空V系列边缘一体机的指定业务隔离ID下所有人脸底库。', + 'description' => '## 限制条件'."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + .' > RAM用户共享阿里云账号配额。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreatePictureSearchApp' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例的名称。 '."\n" + ."\n" + .'支持中文汉字、英文大小写字母、数字、下划线（_）和短划线（-），长度不超过64个字符，一个汉字算2个字符。', + 'type' => 'string', + 'required' => true, + 'example' => '以图搜图', + ], + ], + [ + 'name' => 'Desc', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例的描述信息。'."\n" + ."\n" + .'支持中文汉字、英文大小写字母、数字、下划线（_）和短划线（-），长度不超过1024个字符，一个汉字算2个字符。', + 'type' => 'string', + 'required' => true, + 'example' => '以图搜图Demo', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot_instc_pu****_c*-v64********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '以图搜图应用实例ID。', + 'type' => 'string', + 'example' => '5a502d3fbab8410e8fd4be9037c7****', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Name is mandatory for this action.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '3A754C90-1286-4C2C-A3BA-8BF5BAD4BF76', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"5a502d3fbab8410e8fd4be9037c7****\\",\\n \\"ErrorMessage\\": \\"Name is mandatory for this action.\\",\\n \\"RequestId\\": \\"3A754C90-1286-4C2C-A3BA-8BF5BAD4BF76\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreatePictureSearchAppResponse>\\n<RequestId>3A754C90-1286-4C2C-A3BA-8BF5BAD4BF76</RequestId>\\n<Data>5a502d3fbab8410e8fd4be9037c7****</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</CreatePictureSearchAppResponse>","errorExample":""}]', + 'title' => 'CreatePictureSearchApp', + 'summary' => '调用该接口创建以图搜图应用实例。', + 'description' => '## 限制条件'."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + .' > RAM用户共享阿里云账号配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreatePictureSearchJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'AppInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例ID。可调用[QueryPictureSearchApps](~~206608~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '3e429560124b44b685095df81a27****', + ], + ], + [ + 'name' => 'SearchPicUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '待检索图片的地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://xxx.xxx/1.jpg', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检索范围起始时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '9999999999999', + 'minimum' => '0', + 'example' => '1614227915000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检索范围结束时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '9999999999999', + 'minimum' => '0', + 'example' => '1614327915000', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => '人脸检索阈值。取值范围为0~1。'."\n" + ."\n" + .'为保证检索结果的准确性，推荐设置该参数在0.3~0.6之间。', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '0.5', + ], + ], + [ + 'name' => 'BodyThreshold', + 'in' => 'query', + 'schema' => [ + 'description' => '人体检索阈值。取值范围为0~1。'."\n" + ."\n" + .'为保证检索结果的准确性，推荐设置该参数大于等于0.8。若不设置，则取值为Threshold参数的值。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '0.9', + 'default' => '0.8', + ], + ], + [ + 'name' => 'PictureSearchType', + 'in' => 'query', + 'schema' => [ + 'description' => '检索类型：'."\n" + ."\n" + .'- 1：人脸'."\n" + .'- 0：人体'."\n" + ."\n" + .'默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '0', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '以图搜图任务ID。', + 'type' => 'string', + 'example' => '71632df011294a85910c566e7181****', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'The request has failed due to a temporary failure of the server.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。'."\n", + 'type' => 'string', + 'example' => 'FAEBE068-07DE-4B88-AC2A-51FC2B556211', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"71632df011294a85910c566e7181****\\",\\n \\"ErrorMessage\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"RequestId\\": \\"FAEBE068-07DE-4B88-AC2A-51FC2B556211\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreatePictureSearchJobResponse>\\n<RequestId>DB14A78C-6F64-40D0-8C03-46E8D57A8FC8</RequestId>\\n<Data>71632df011294a85910c566e7181****</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</CreatePictureSearchJobResponse>","errorExample":""}]', + 'title' => '创建图片搜索作业', + 'summary' => '调用该接口创建一体化以图搜图任务。', + 'description' => '一体化以图搜图，指在搜图时，同时检索人脸和人体特征。'."\n" + .'> 该功能需要在V系列边缘一体机上部署人脸和人体检测算法。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdatePictureSearchApp' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'AppInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例ID。可调用[QueryPictureSearchApps](206608)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '3e429560124b44b685095df81a27****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例的名称。 '."\n" + ."\n" + .'支持中文汉字、英文大小写、数字、下划线（_）和短划线（-），不超过64个字符（一个中文汉字算2个字符）。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '新以图搜图', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例的描述信息。'."\n" + ."\n" + .'支持中文汉字、英文大小写、数字、下划线（_）和短划线（-），不超过1024个字符（一个中文汉字算2个字符）。', + 'type' => 'string', + 'required' => true, + 'example' => '以图搜图Demo2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Description is mandatory for this action.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'CC6B9D69-627C-4C9D-AEAA-0BC08AB6DBED', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Description is mandatory for this action.\\",\\n \\"RequestId\\": \\"CC6B9D69-627C-4C9D-AEAA-0BC08AB6DBED\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdatePictureSearchAppResponse>\\n<RequestId>CC6B9D69-627C-4C9D-AEAA-0BC08AB6DBED</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</UpdatePictureSearchAppResponse>","errorExample":""}]', + 'title' => '升级图片搜索应用', + 'summary' => '调用该接口修改以图搜图应用实例的信息。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryPictureSearchAiboxes' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例ID。可调用[QueryPictureSearchApps](~~206608~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'example' => '5a502d3fbab8410e8fd4be9037c7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果中，每页显示的记录数量。最大取值30，最小取值1，默认取值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。最小取值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看您的实例ID。'."\n" + ."\n" + .'> 如果公共实例没有ID，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot_instc_pu****_c*-v64********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Specified parameter CurrentPage is not valid.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'DF7DC571-FE48-4C25-8BE0-B13C3038C85B', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：表示调用成功。'."\n" + .'- **false**：表示调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '返回结果中每页显示的记录数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageData' => [ + 'description' => 'V系列边缘一体机列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NickName' => [ + 'description' => 'V系列边缘一体机对应的设备别名。', + 'type' => 'string', + 'example' => 'box015', + ], + 'IotId' => [ + 'description' => 'V系列边缘一体机对应的设备ID。', + 'type' => 'string', + 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Specified parameter CurrentPage is not valid.\\",\\n \\"RequestId\\": \\"DF7DC571-FE48-4C25-8BE0-B13C3038C85B\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"PageCount\\": 1,\\n \\"PageData\\": [\\n {\\n \\"NickName\\": \\"box015\\",\\n \\"IotId\\": \\"VrJwPGjC1sJlqPjZA3cxg4****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryPictureSearchAiboxesResponse>\\r\\n <RequestId>DF7DC571-FE48-4C25-8BE0-B13C3038C85B</RequestId>\\r\\n <Data>\\r\\n <PageSize>10</PageSize>\\r\\n <PageCount>1</PageCount>\\r\\n <CurrentPage>1</CurrentPage>\\r\\n <Total>1</Total>\\r\\n <PageData>\\r\\n <IotId>VrJwPGjC1sJlqPjZA3cxg4****</IotId>\\r\\n <NickName>camera1</NickName>\\r\\n </PageData>\\r\\n </Data>\\r\\n <Code>200</Code>\\r\\n <Success>true</Success>\\r\\n</QueryPictureSearchAiboxesResponse>","errorExample":""}]', + 'title' => '查询图片搜索', + 'summary' => '调用该接口，查询以图搜图应用实例绑定的V系列边缘一体机列表。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryPictureSearchApps' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果中，每页显示的记录数量。最大取值50，最小取值1，默认取值为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。最小取值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot_instc_pu****_c*-v64********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Specified parameter CurrentPage is not valid.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '2C794BB1-0494-4E4E-AACF-174F04CD1F10', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => ' 当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '返回结果中，每页显示的记录数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '已创建的以图搜图应用实例总数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageData' => [ + 'description' => '以图搜图应用实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppInstanceId' => [ + 'description' => '以图搜图应用实例ID。', + 'type' => 'string', + 'example' => '3e429560124b44b685095df81a27****', + ], + 'ModifiedTime' => [ + 'description' => '修改以图搜图应用实例的13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614328081000', + ], + 'Description' => [ + 'description' => '以图搜图应用实例的描述信息。', + 'type' => 'string', + 'example' => '以图搜图Demo2', + ], + 'Version' => [ + 'description' => '以图搜图应用实例模板的版本号。', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'CreateTime' => [ + 'description' => '创建以图搜图应用实例的13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614327915000', + ], + 'AppTemplateId' => [ + 'description' => '以图搜图应用实例模板ID。', + 'type' => 'string', + 'example' => '7b50e7acb2574a789226099300cc****', + ], + 'Name' => [ + 'description' => '以图搜图应用实例的名称。', + 'type' => 'string', + 'example' => '新以图搜图', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Specified parameter CurrentPage is not valid.\\",\\n \\"RequestId\\": \\"2C794BB1-0494-4E4E-AACF-174F04CD1F10\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 2,\\n \\"PageCount\\": 1,\\n \\"PageData\\": [\\n {\\n \\"AppInstanceId\\": \\"3e429560124b44b685095df81a27****\\",\\n \\"ModifiedTime\\": 1614328081000,\\n \\"Description\\": \\"以图搜图Demo2\\",\\n \\"Version\\": \\"1.0.0\\",\\n \\"CreateTime\\": 1614327915000,\\n \\"AppTemplateId\\": \\"7b50e7acb2574a789226099300cc****\\",\\n \\"Name\\": \\"新以图搜图\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryPictureSearchAppsResponse>\\n<RequestId>2C794BB1-0494-4E4E-AACF-174F04CD1F10</RequestId>\\n<Data>\\n <PageCount>1</PageCount>\\n <PageSize>20</PageSize>\\n <PageData>\\n <AppTemplateId>7b50e7acb2574a789226099300cc****</AppTemplateId>\\n <AppInstanceId>5a502d3fbab8410e8fd4be9037c7****</AppInstanceId>\\n <Description>1</Description>\\n <ModifiedTime>1614325136000</ModifiedTime>\\n <Version>1.0.0</Version>\\n <CreateTime>1614325136000</CreateTime>\\n <Name>11</Name>\\n </PageData>\\n <PageData>\\n <AppTemplateId>7b50e7acb2574a789226099300cc****</AppTemplateId>\\n <AppInstanceId>3e429560124b44b685095df81a27****</AppInstanceId>\\n <Description>以图搜图Demo2</Description>\\n <ModifiedTime>1614328081000</ModifiedTime>\\n <Version>1.0.0</Version>\\n <CreateTime>1614327915000</CreateTime>\\n <Name>新以图搜图</Name>\\n </PageData>\\n <CurrentPage>1</CurrentPage>\\n <Total>2</Total>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryPictureSearchAppsResponse>","errorExample":""}]', + 'title' => 'QueryPictureSearchApps', + 'summary' => '调用该接口，查询已创建的以图搜图应用实例列表。', + 'description' => '## 限制条件'."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + .' > RAM用户共享阿里云账号配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数文档](~~288312~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryPictureSearchDevices' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例ID。可调用[QueryPictureSearchApps](~~206608~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '5a502d3fbab8410e8fd4be9037c7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。最小值为1，最大值为50，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '20', + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。页数从1开始排序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Specified parameter CurrentPage is not valid.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'DF7DC571-FE48-4C25-8BE0-B13C3038C85B', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => ' 当前页面号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '返回结果中每页显示的记录数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageData' => [ + 'description' => '应用列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NickName' => [ + 'description' => '设备别名。'."\n" + ."\n" + .'> 仅IPC设备会返回此参数。'."\n", + 'type' => 'string', + 'example' => 'camera1', + ], + 'IotId' => [ + 'description' => '设备ID。'."\n", + 'type' => 'string', + 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Specified parameter CurrentPage is not valid.\\",\\n \\"RequestId\\": \\"DF7DC571-FE48-4C25-8BE0-B13C3038C85B\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"PageCount\\": 1,\\n \\"PageData\\": [\\n {\\n \\"NickName\\": \\"camera1\\",\\n \\"IotId\\": \\"VrJwPGjC1sJlqPjZA3cxg4****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryPictureSearchDevicesResponse>\\n<RequestId>DF7DC571-FE48-4C25-8BE0-B13C3038C85B</RequestId>\\n<Data>\\n <PageCount>1</PageCount>\\n <PageSize>1</PageSize>\\n <PageData>\\n <IotId>VrJwPGjC1sJlqPjZA3cxg4****</IotId>\\n <NickName>camera1</NickName>\\n </PageData>\\n <CurrentPage>1</CurrentPage>\\n <Total>1</Total>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryPictureSearchDevicesResponse>","errorExample":""}]', + 'title' => '查询图片搜索设备', + 'summary' => '调用该接口，查询以图搜图应用实例绑定的设备列表。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryPictureSearchJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例ID。可调用[QueryPictureSearchApps](~~206608~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'fdc576d03c094faea9fa10fbf48c****', + ], + ], + [ + 'name' => 'JobStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '任务状态：'."\n" + .'- 0：初始化'."\n" + .'- 1：无数据'."\n" + .'- 2：运行中'."\n" + .'- 3：运行成功'."\n" + .'- 4：运行失败'."\n" + ."\n" + .'若不设置此参数，表示选择所有状态。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '0', + 'example' => '3', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。最小值为1，最大值为50，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。页数从1开始排序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Specified access key is not found.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '8FAF4001-2A53-46DF-B83E-306B8070E131', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前页面号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageData' => [ + 'description' => '应用列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '检索范围结束时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614850763692', + ], + 'StartTime' => [ + 'description' => '检索范围起始时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614814763692', + ], + 'JobStatus' => [ + 'description' => '任务状态：'."\n" + .'- 0：初始化'."\n" + .'- 1：无数据'."\n" + .'- 2：运行中'."\n" + .'- 3：运行成功'."\n" + .'- 4：运行失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'SearchPicUrl' => [ + 'description' => '检索的图片地址。', + 'type' => 'string', + 'example' => 'http://xxx.xxx.com/1.jpg', + ], + 'CreateTime' => [ + 'description' => '创建以图搜图任务的时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614850763000', + ], + 'JobId' => [ + 'description' => '以图搜图任务ID。', + 'type' => 'string', + 'example' => 'b3786935a71442efae014c7b2212****', + ], + 'Threshold' => [ + 'description' => '检索相似度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Specified access key is not found.\\",\\n \\"RequestId\\": \\"8FAF4001-2A53-46DF-B83E-306B8070E131\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 2,\\n \\"PageCount\\": 1,\\n \\"PageData\\": [\\n {\\n \\"EndTime\\": 1614850763692,\\n \\"StartTime\\": 1614814763692,\\n \\"JobStatus\\": 3,\\n \\"SearchPicUrl\\": \\"http://xxx.xxx.com/1.jpg\\",\\n \\"CreateTime\\": 1614850763000,\\n \\"JobId\\": \\"b3786935a71442efae014c7b2212****\\",\\n \\"Threshold\\": 0.5\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryPictureSearchJobResponse>\\n<RequestId>8FAF4001-2A53-46DF-B83E-306B8070E131</RequestId>\\n<Data>\\n <PageSize>10</PageSize>\\n <PageCount>1</PageCount>\\n <CurrentPage>1</CurrentPage>\\n <Total>1</Total>\\n <PageData>\\n <JobStatus>3</JobStatus>\\n <EndTime>1614850763692</EndTime>\\n <CreateTime>1614850763000</CreateTime>\\n <StartTime>1614814763692</StartTime>\\n <SearchPicUrl>http://xxx.xxx.com/1.jpg</SearchPicUrl>\\n <JobId>b3786935a71442efae014c7b2212****</JobId>\\n <Threshold>0.5</Threshold>\\n </PageData>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryPictureSearchJobResponse>","errorExample":""}]', + 'title' => '查询图片搜索作业', + 'summary' => '调用该接口，查询一体化以图搜图任务列表。', + 'description' => '一体化以图搜图，表示搜图时，同时检索人脸和人体。'."\n" + .'> 该功能需要在V系列边缘一体机上部署人脸和人体检测算法。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryPictureSearchJobResult' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例ID。可调用[QueryPictureSearchApps](~~206608~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'fdc576d03c094faea9fa10fbf48c****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '一体化以图搜图任务ID。可调用[QueryPictureSearchJob](~~206778~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'b7e501d0d2524a4caeb50df3282a****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。最小值为1，最大值为50，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '20', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。页数从1开始排序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'AppInstanceId is mandatory for this action.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'a06c4750-7cce-11eb-8010-557d50136505', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前页面号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageData' => [ + 'description' => '查询结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PicUrl' => [ + 'description' => '待检索图片的地址。', + 'type' => 'string', + 'example' => 'https://xxx.xxx.xxx.com/xxx', + ], + 'EventTime' => [ + 'description' => '创建事件的时间，格式为毫秒级的13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614333155075', + ], + 'GatewayIotId' => [ + 'description' => 'V系列边缘一体机的IotId。', + 'type' => 'string', + 'example' => 'pZJUqijOyfpFOOGNPF7S00****', + ], + 'VectorId' => [ + 'description' => '图片特征ID。', + 'type' => 'string', + 'example' => 'vectorId86d9a5c32b9947278e526c2eef8a****', + ], + 'DeviceNickName' => [ + 'description' => '设备别名。'."\n" + ."\n" + .'> 若设备未设置设备别名，则不返回此参数。'."\n", + 'type' => 'string', + 'example' => 'camera1', + ], + 'Threshold' => [ + 'description' => '人脸相似度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'IotId' => [ + 'description' => '查询的设备的IotId。', + 'type' => 'string', + 'example' => '5RUngwC1RknD4lPiHgH300****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"AppInstanceId is mandatory for this action.\\",\\n \\"RequestId\\": \\"a06c4750-7cce-11eb-8010-557d50136505\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"PageCount\\": 1,\\n \\"PageData\\": [\\n {\\n \\"PicUrl\\": \\"https://xxx.xxx.xxx.com/xxx\\",\\n \\"EventTime\\": 1614333155075,\\n \\"GatewayIotId\\": \\"pZJUqijOyfpFOOGNPF7S00****\\",\\n \\"VectorId\\": \\"vectorId86d9a5c32b9947278e526c2eef8a****\\",\\n \\"DeviceNickName\\": \\"camera1\\",\\n \\"Threshold\\": 0.5,\\n \\"IotId\\": \\"5RUngwC1RknD4lPiHgH300****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryPictureSearchJobResultResponse>\\n<RequestId>a06c4750-7cce-11eb-8010-557d50136505</RequestId>\\n<Data>\\n <PageSize>10</PageSize>\\n <PageCount>1</PageCount>\\n <CurrentPage>1</CurrentPage>\\n <Total>1</Total>\\n <PageData>\\n <IotId>5RUngwC1RknD4lPiHgH300****</IotId>\\n <EventTime>1614333155075</EventTime>\\n <DeviceNickName>camera1</DeviceNickName>\\n <GatewayIotId>pZJUqijOyfpFOOGNPF7S00****</GatewayIotId>\\n <PicUrl>https://xxx.xxx.xxx.com/xxx</PicUrl>\\n <Threshold>0.5</Threshold>\\n <VectorId>vectorId86d9a5c32b9947278e526c2eef8a****</VectorId>\\n </PageData>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryPictureSearchJobResultResponse>","errorExample":""}]', + 'title' => '查询图片搜索作业结果', + 'summary' => '调用该接口，查询一体化以图搜图任务的图片检索结果。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetPictureSearchJobStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AppInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例ID。可调用[QueryPictureSearchApps](~~206608~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '892f97c9518548469d319d955d98****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图任务ID。可调用[QueryPictureSearchJob](~~206778~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'b3786935a71442efae014c7b2212****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Specified access key is not found.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '2c7def10-7cce-11eb-8e79-959f4f722f76', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '检索范围结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614850763692', + ], + 'StartTime' => [ + 'description' => '检索范围起始时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614814763692', + ], + 'JobStatus' => [ + 'description' => '任务状态：'."\n" + .'- 0：初始化'."\n" + .'- 1：无数据'."\n" + .'- 2：运行中'."\n" + .'- 3：运行成功'."\n" + .'- 4：运行失败', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'SearchPicUrl' => [ + 'description' => '检索图片的地址。', + 'type' => 'string', + 'example' => 'http://XXX.XXX.com/1.jpg', + ], + 'CreateTime' => [ + 'description' => '创建以图搜图任务的时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614850763000', + ], + 'JobId' => [ + 'description' => '以图搜图任务ID。', + 'type' => 'string', + 'example' => 'b3786935a71442efae014c7b2212****', + ], + 'Threshold' => [ + 'description' => '检索相似度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Specified access key is not found.\\",\\n \\"RequestId\\": \\"2c7def10-7cce-11eb-8e79-959f4f722f76\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"EndTime\\": 1614850763692,\\n \\"StartTime\\": 1614814763692,\\n \\"JobStatus\\": 3,\\n \\"SearchPicUrl\\": \\"http://XXX.XXX.com/1.jpg\\",\\n \\"CreateTime\\": 1614850763000,\\n \\"JobId\\": \\"b3786935a71442efae014c7b2212****\\",\\n \\"Threshold\\": 0.5\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetPictureSearchJobStatusResponse>\\n<RequestId>2c7def10-7cce-11eb-8e79-959f4f722f76</RequestId>\\n<Data>\\n <JobStatus>3</JobStatus>\\n <EndTime>1614850763692</EndTime>\\n <CreateTime>1614850763000</CreateTime>\\n <StartTime>1614814763692</StartTime>\\n <SearchPicUrl>http://XXX.XXX.com/1.jpg</SearchPicUrl>\\n <JobId>b3786935a71442efae014c7b2212****</JobId>\\n <Threshold>0.5</Threshold>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</GetPictureSearchJobStatusResponse>\\n","errorExample":""}]', + 'title' => '获取图片搜索任务状态', + 'summary' => '调用该接口获取一体化以图搜图任务的状态。', + 'description' => '一体化以图搜图，表示搜图时，同时检索人脸和人体特征。'."\n" + ."\n" + .'> 该功能需要在V系列边缘一体机上部署人脸和人体检测算法。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryPictureFiles' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检索范围起始时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615357669000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检索范围结束时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1615444063000', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。页数从1开始排序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。默认值为10，最大值为50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PictureType', + 'in' => 'query', + 'schema' => [ + 'description' => '图片类型：'."\n" + ."\n" + .'- **0**：缩略图。 '."\n" + .'- **1**：原图。'."\n" + .'- **2**（默认）：全部。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'PictureSource', + 'in' => 'query', + 'schema' => [ + 'description' => '图片来源：'."\n" + ."\n" + .'- **0**（默认）：全部事件。'."\n" + .'- **1**：告警事件抓图。'."\n" + .'- **2**：主动抓图。'."\n" + .'- **3**：其他。'."\n" + .'- **4**：云端截图。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'product is not active.', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'Page' => [ + 'description' => '当前页面号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'List' => [ + 'description' => '返回的图片列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PicId' => [ + 'description' => '图片ID。', + 'type' => 'string', + 'example' => 'pZJUqijOyfpFOOGNP******', + ], + 'PicUrl' => [ + 'description' => '图片URL。'."\n" + ."\n" + .'> URL有效期为1小时。', + 'type' => 'string', + 'example' => 'http://***_normal.jpg', + ], + 'PicCreateTime' => [ + 'description' => '图片创建的时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1543458157522', + ], + 'ThumbUrl' => [ + 'description' => '缩略图URL。'."\n" + ."\n" + .'> URL有效期为1小时。', + 'type' => 'string', + 'example' => 'http://***.jpg', + ], + 'IotId' => [ + 'description' => 'IPC设备的设备ID。', + 'type' => 'string', + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"product is not active.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Page\\": 1,\\n \\"PageSize\\": 10,\\n \\"List\\": [\\n {\\n \\"PicId\\": \\"pZJUqijOyfpFOOGNP******\\",\\n \\"PicUrl\\": \\"http://***_normal.jpg\\",\\n \\"PicCreateTime\\": 1543458157522,\\n \\"ThumbUrl\\": \\"http://***.jpg\\",\\n \\"IotId\\": \\"zLZyi6aOLyOSHa9hsPyD00****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":" <QueryPictureFilesResponse>\\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n <Data>\\n <PageSize>10</PageSize>\\n <Page>1</Page>\\n <List>\\n <IotId>zLZyi6aOLyOSHa9hsPyD00****</IotId>\\n <ThumbUrl>http://***.jpg</ThumbUrl>\\n <PicUrl>http://***_normal.jpg</PicUrl>\\n <PicId>pZJUqijOyfpFOOGNP******</PicId>\\n <PicCreateTime>1543458157522</PicCreateTime>\\n </List>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</QueryPictureFilesResponse>","errorExample":""}]', + 'title' => '获取图片列表', + 'summary' => '调用该接口获取图片列表。', + 'description' => '## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为500。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BindPictureSearchAppWithDevices' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例ID，可调用[QueryPictureSearchApps](~~206608~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '5a502d3fbab8410e8fd4be9037c7****', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'- 企业版实例：必须传入此参数。您可在物联网平台控制台的**实例概览**页面，查看您的企业版实例ID。'."\n" + .'- 公共实例：无需传入此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-060a****', + ], + ], + [ + 'name' => 'DeviceIotIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '设备IotId列表。支持传入V系列边缘一体机或摄像机的IotId。'."\n" + ."\n" + .'IotId是物联网平台为设备颁发的ID，设备的唯一标识符。'."\n" + .'可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'单次最多可填写20个设备IotId。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'iotIdList is error', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'B8A4153B-4F18-49B1-90C0-C9194866FF88', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"iotIdList is error\\",\\n \\"RequestId\\": \\"B8A4153B-4F18-49B1-90C0-C9194866FF88\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<BindPictureSearchAppWithDevicesResponse>\\n<RequestId>B8A4153B-4F18-49B1-90C0-C9194866FF88</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</BindPictureSearchAppWithDevicesResponse>","errorExample":""}]', + 'title' => '将图片搜索应用程序与设备绑定', + 'summary' => '调用该接口可用以图搜图实例批量绑定设备。', + 'description' => '## 使用限制'."\n" + .'如果在企业版实例中调用该接口，请求参数**IotInstanceId**必须填写。否则，调用接口会失败。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnbindPictureSearchAppWithDevices' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例ID。可调用[QueryPictureSearchApps](~~206608~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '5a502d3fbab8410e8fd4be9037c7****', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'- 企业版实例：必须传入此参数。您可在物联网平台控制台的**实例概览**页面，查看您的企业版实例ID。'."\n" + .'- 公共实例：无需传入此参数。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'iot-060a****', + ], + ], + [ + 'name' => 'DeviceIotIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '设备IotId列表。支持传入V系列边缘一体机或摄像头的IotId。'."\n" + ."\n" + .'IotId是物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'单次最多可填写20个设备IotId。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'iotIdList is error', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E779C673-E8E8-41F0-883E-7D9275DF733C', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"iotIdList is error\\",\\n \\"RequestId\\": \\"E779C673-E8E8-41F0-883E-7D9275DF733C\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UnbindPictureSearchAppWithDevicesResponse>\\n<RequestId>E779C673-E8E8-41F0-883E-7D9275DF733C</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</UnbindPictureSearchAppWithDevicesResponse>","errorExample":""}]', + 'title' => '解绑图片搜索应用程序与设备', + 'summary' => '调用该接口，批量解绑以图搜图应用实例关联的设备。', + 'description' => '## 使用限制'."\n" + .'如果在企业版实例中调用该接口，请求参数**IotInstanceId**必须填写。否则，调用接口会失败。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'PictureSearchPicture' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'AppInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '以图搜图应用实例ID。可调用[QueryPictureSearchApps](~~206608~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '5a502d3fbab8410e8fd4be9037c7****', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。最大取值10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '20', + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。页数从1开始排序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'SearchPicUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '待检索图片的地址。', + 'type' => 'string', + 'required' => true, + 'example' => ' http://***.***/2393.jpg', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检索范围起始时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1614297000000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '检索范围结束时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1614850651299', + ], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => [ + 'description' => '检索阈值。取值范围0~1。'."\n" + ."\n" + .'> 建议设置检索阈值大于等于0.3，以保证与检测对象匹配。'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '0.5', + ], + ], + [ + 'name' => 'ContainPicUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '响应结果包含照片。'."\n" + ."\n" + .'> 当前设置为ture或false均返回响应结果。'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'PictureSearchType', + 'in' => 'query', + 'schema' => [ + 'description' => '检索类型：'."\n" + .'- **1**（默认）：人脸'."\n" + .'- **0**：人体'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '0', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Specified parameter CurrentPage is not valid.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '3ddd5f30-7ccd-11eb-b164-bfd389491534', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应信息。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前页面号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageData' => [ + 'description' => '应用列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PicUrl' => [ + 'description' => '图片地址。', + 'type' => 'string', + 'example' => 'https://XXX.XXX/XXX', + ], + 'EventTime' => [ + 'description' => '创建事件的时间，格式为毫秒级的13位时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614500317482', + ], + 'GatewayIotId' => [ + 'description' => 'V系列边缘一体机的IotId。', + 'type' => 'string', + 'example' => 'pZJUqijOyfpFOOGNPF7S00****', + ], + 'VectorId' => [ + 'description' => '图片特征ID。', + 'type' => 'string', + 'example' => 'vectorId86d9a5c32b9947278e526c2eef8a****', + ], + 'Threshold' => [ + 'description' => '人脸相似度。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.5', + ], + 'VectorType' => [ + 'description' => '图片特征类型：'."\n" + .'- 0：人体。'."\n" + .'- 1：人脸。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IotId' => [ + 'description' => '查询的设备的IotId。', + 'type' => 'string', + 'example' => '5RUngwC1RknD4lPiHgH300****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Specified parameter CurrentPage is not valid.\\",\\n \\"RequestId\\": \\"3ddd5f30-7ccd-11eb-b164-bfd389491534\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"PageCount\\": 1,\\n \\"PageData\\": [\\n {\\n \\"PicUrl\\": \\"https://XXX.XXX/XXX\\",\\n \\"EventTime\\": 1614500317482,\\n \\"GatewayIotId\\": \\"pZJUqijOyfpFOOGNPF7S00****\\",\\n \\"VectorId\\": \\"vectorId86d9a5c32b9947278e526c2eef8a****\\",\\n \\"Threshold\\": 0.5,\\n \\"VectorType\\": 1,\\n \\"IotId\\": \\"5RUngwC1RknD4lPiHgH300****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<PictureSearchPictureResponse>\\n<RequestId>3ddd5f30-7ccd-11eb-b164-bfd389491534</RequestId>\\n<Data>\\n <PageSize>10</PageSize>\\n <PageCount>1</PageCount>\\n <CurrentPage>1</CurrentPage>\\n <Total>1</Total>\\n <PageData>\\n <IotId>5RUngwC1RknD4lPiHgH300****</IotId>\\n <VectorType>1</VectorType>\\n <EventTime>1614500317482</EventTime>\\n <GatewayIotId>pZJUqijOyfpFOOGNPF7S00****</GatewayIotId>\\n <PicUrl>https://XXX.XXX/XXX</PicUrl>\\n <Threshold>0.5</Threshold>\\n <VectorId>vectorId86d9a5c32b9947278e526c2eef8a****</VectorId>\\n </PageData>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</PictureSearchPictureResponse>","errorExample":""}]', + 'title' => '图片搜索', + 'summary' => '调用该接口启动以图搜图应用实例，进行图片检索。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TriggerCapturePicture' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'<props="china">您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。</props>'."\n" + ."\n" + .'<props="intl">无需传入此参数。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'IPC设备拍摄图片后，为图片生成的图片ID。'."\n" + ."\n" + .'>IPC设备成功上传图片后，图片ID生效。', + 'type' => 'string', + 'example' => 'eventPicId_12****', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'request forbidden', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"eventPicId_12****\\",\\n \\"ErrorMessage\\": \\"request forbidden\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<TriggerCapturePictureResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>eventPicId_12****</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</TriggerCapturePictureResponse>","errorExample":""}]', + 'title' => '主动触发抓图', + 'summary' => '调用该接口主动触发IPC设备拍摄图片并上传至云端。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateRecordPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '录像计划名称。'."\n" + ."\n" + .'名称长度小于48个字符，可以包含英文字母、数字和特殊字符：短划线（-）、下划线（_）、at（@）、英文句号（.）、英文冒号（:）。', + 'type' => 'string', + 'required' => true, + 'example' => 'plan1', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '录像计划对应的时间模板ID，可调用[CreateTimeTemplate](~~107888~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '36f06322442e4e3f85a5ae8862c9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '录像计划ID。', + 'type' => 'string', + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"5b60bf0dd55944c19d7817442bc9****\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateRecordPlanResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>5b60bf0dd55944c19d7817442bc9****</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</CreateRecordPlanResponse>","errorExample":""}]', + 'title' => '创建录像计划', + 'summary' => '调用该接口，根据时间模板创建录像计划。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddRecordPlanDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型：'."\n" + ."\n" + .'- **0**（默认）：主码流。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '录像计划ID。可调用[QueryRecordPlans](~~107896~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddRecordPlanDeviceResponse>\\r\\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\r\\n <code>200</code>\\r\\n <Success>true</Success>\\r\\n</AddRecordPlanDeviceResponse>","errorExample":""}]', + 'title' => '为录像计划添加摄像头', + 'summary' => '调用该接口为IPC设备添加连续录像计划。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteRecordPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '录像计划ID。可调用[QueryRecordPlans](~~107896~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '6c5a397bc17c4b48ace86f0f0c30****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'request forbidden.', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"request forbidden.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteRecordPlanResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</DeleteRecordPlanResponse>","errorExample":""}]', + 'title' => '删除录像计划', + 'summary' => '调用该接口删除录像计划。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteRecordPlanDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型：'."\n" + ."\n" + .'- **0**：主码流。'."\n" + .'- **1**：辅码流。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的错误信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteRecordPlanDeviceResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</DeleteRecordPlanDeviceResponse>","errorExample":""}]', + 'title' => '删除录像计划执行设备', + 'summary' => '调用该接口删除IPC设备关联的录像计划。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetDeviceRecordLifeCycle' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + ], + [ + 'name' => 'Day', + 'in' => 'query', + 'schema' => [ + 'description' => '录像生命周期，即录像文件在云端保存的天数。'."\n" + ."\n" + .'> 您需要设置录像生命周期大于0，才可使用视频服务提供的其他录像功能。录像生命周期最大可设置为3650天。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"InvalidParameter\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SetDeviceRecordLifeCycleResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</SetDeviceRecordLifeCycleResponse>","errorExample":""}]', + 'title' => '设置设备录像在云上的存储生命周期', + 'summary' => '调用该接口，设置IPC设备的录像生命周期，即录像文件在云端存储的天数。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopTriggeredRecord' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => '录像ID。可调用[TriggerRecord](~~107915~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'fc82774fa749485bad7d719f9670****', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>IPC的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。'."\n" + ."\n" + .'可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。'."\n", + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopTriggeredRecordResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</StopTriggeredRecordResponse>","errorExample":""}]', + 'title' => '停止主动触发录像', + 'summary' => '调用该接口使IPC设备停止主动触发录像。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateEventRecordPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能告警事件录像计划ID。可调用[QueryEventRecordPlans](~~107907~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '智能告警事件录像名称。'."\n" + ."\n" + .'名称长度小于48个字符，可以包含英文字母、数字和特殊字符：短划线（-）、下划线（_）、at（@）、英文句号（.）、英文冒号（:）。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'record1', + ], + ], + [ + 'name' => 'EventTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '智能告警事件类型：'."\n" + ."\n" + .'- 设置为全部智能告警事件：0。'."\n" + .'- 设置为多个智能告警事件：输入智能告警事件对应的序号，并用英文逗号（,）分隔，例如：`10001,10002`。'."\n" + .'>设置多个智能告警事件时，单次最多支持设置10个。'."\n" + ."\n" + .'请在物联网平台控制台，**产品详情**页面的**功能定义**页签，查看全部智能告警事件类型。详细信息，请参考[查看智能告警事件类型](~~207701~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PreRecordDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '预录时长，取值范围0~10，单位为秒。'."\n" + ."\n" + .'>设备具备预录功能时，才可生成预录时长，否则，预录时长为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '0', + ], + ], + [ + 'name' => 'RecordDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '录像时长，包括预录时长，取值范围10~60，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '30', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '时间模板ID。可调用[QueryTimeTemplate](~~107890~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '36f06322442e4e3f85a5ae8862c9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateEventRecordPlanResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</UpdateEventRecordPlanResponse>","errorExample":""}]', + 'title' => '更新事件联动录像计划', + 'summary' => '调用该接口更新智能告警事件录像计划。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateRecordPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '录像计划ID。可调用[QueryRecordPlans](~~107896~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '6c5a397bc17c4b48ace86f0f0c30****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '录像计划名称。'."\n" + ."\n" + .'名称长度小于48个字符，可以包含英文字母、数字和特殊字符：短划线（-）、下划线（_）、at（@）、英文句号（.）、英文冒号（:）。', + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '录像计划要关联的时间模板ID。可调用[QueryTimeTemplate](~~107890~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '36f06322442e4e3f85a5ae8862c9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error.', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateRecordPlanResponse>\\n<RequestId>B68F5C11-4844-4A34-872B-313986482C06</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</UpdateRecordPlanResponse>","errorExample":""}]', + 'title' => '更新录像计划', + 'summary' => '调用该接口更新录像计划。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRecord' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型：'."\n" + .'- **0**（默认）：主码流。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询范围开始时间，格式为10位时间戳，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1508200012', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询范围结束时间，格式为10位时间戳，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1582420940', + ], + ], + [ + 'name' => 'RecordType', + 'in' => 'query', + 'schema' => [ + 'description' => '录像类型：'."\n" + ."\n" + .'- **0**：连续录像。'."\n" + .'- **1**：智能告警事件录像。'."\n" + .'- **2**（默认）：主动录像。'."\n" + ."\n" + .'当该参数值置空时，返回全部录像类型。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果第几页开始显示，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。默认值为10，最大值为50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NeedSnapshot', + 'in' => 'query', + 'schema' => [ + 'description' => '是否需要缩略图：'."\n" + ."\n" + .'- **true**：需要。'."\n" + .'- **false**（默认）：不需要。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页签，查看当前实例的ID。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该**ID**值，否则调用会失败。'."\n" + .'- 若无ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-060a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。'."\n", + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error.', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'Page' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'List' => [ + 'description' => '返回的录像列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SnapshotUrl' => [ + 'description' => '缩略图地址。', + 'type' => 'string', + 'example' => 'https://lin****/****2Cq_90', + ], + 'EndTime' => [ + 'description' => '录像结束时间。', + 'type' => 'string', + 'example' => '2018-09-10 00:00:30', + ], + 'EventType' => [ + 'description' => '录像类型（**RecordType**）为**智能告警事件录像**时返回该参数，表示录像对应的事件类型。'."\n" + ."\n" + .'例如：**1**表示移动侦测事件。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RecordType' => [ + 'description' => '录像类型：'."\n" + ."\n" + .'- **0**：连续录像。'."\n" + .'- **1**：智能告警事件录像。'."\n" + .'- **2**：主动录像。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StreamType' => [ + 'description' => '码流类型：'."\n" + .'- **0**：主码流。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'BeginTime' => [ + 'description' => '录像开始时间。', + 'type' => 'string', + 'example' => '2018-09-10 00:00:00', + ], + 'FileName' => [ + 'description' => '录像文件名。', + 'type' => 'string', + 'example' => 'file1', + ], + 'VideoFrameNumber' => [ + 'description' => '录像文件的视频帧数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1352', + ], + 'FileSize' => [ + 'description' => '录像文件大小，单位为字节。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '204800', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Page\\": 1,\\n \\"PageSize\\": 10,\\n \\"List\\": [\\n {\\n \\"SnapshotUrl\\": \\"https://lin****/****2Cq_90\\",\\n \\"EndTime\\": \\"2018-09-10 00:00:30\\",\\n \\"EventType\\": 1,\\n \\"RecordType\\": 1,\\n \\"StreamType\\": 1,\\n \\"BeginTime\\": \\"2018-09-10 00:00:00\\",\\n \\"FileName\\": \\"file1\\",\\n \\"VideoFrameNumber\\": 1352,\\n \\"FileSize\\": 204800\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>\\n <PageSize>10</PageSize>\\n <Page>1</Page>\\n <List>\\n <StreamType>1</StreamType>\\n <EventType>1</EventType>\\n <VideoFrameNumber>1352</VideoFrameNumber>\\n <RecordType>1</RecordType>\\n <EndTime>2018-09-10 00:00:30</EndTime>\\n <SnapshotUrl>https://lin****/****2Cq_90</SnapshotUrl>\\n <FileName>file1</FileName>\\n <BeginTime>2018-09-10 00:00:00</BeginTime>\\n <FileSize>204800</FileSize>\\n </List>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryRecordResponse>","errorExample":""}]', + 'title' => '查询录像列表', + 'summary' => '调用该接口查询云端录像列表。', + 'description' => '## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为250。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRecordByRecordId' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'RecordId', + 'in' => 'query', + 'schema' => [ + 'description' => '录像文件ID。可调用[QueryRecord](~~107922~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '2c5bf5b6a8704bd3a6a1517fd125****', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'<props="china">您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。</props>'."\n" + ."\n" + .'<props="intl">无需传入此参数。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-060a01****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'F46E12A5-633D-4761-80F2-285752A052D5', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'RecordId is mandatory for this action.', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '录像结束时间。', + 'type' => 'string', + 'example' => '2020-10-12 14:07:31', + ], + 'FileName' => [ + 'description' => '录像文件名。', + 'type' => 'string', + 'example' => 'test', + ], + 'VodUrl' => [ + 'description' => '录像文件的URL。', + 'type' => 'string', + 'example' => 'https://iotx-vision-vod-vpc-hz-pre.aliyun-inc.com/vod/device/localrecord/flv/play/1****668.flv?token=e9****a9e14482c56be52&session=470e****3d015', + ], + 'BeginTime' => [ + 'description' => '录像开始时间。', + 'type' => 'string', + 'example' => '2020-10-12 14:07:20', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"F46E12A5-633D-4761-80F2-285752A052D5\\",\\n \\"ErrorMessage\\": \\"RecordId is mandatory for this action.\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EndTime\\": \\"2020-10-12 14:07:31\\",\\n \\"FileName\\": \\"test\\",\\n \\"VodUrl\\": \\"https://iotx-vision-vod-vpc-hz-pre.aliyun-inc.com/vod/device/localrecord/flv/play/1****668.flv?token=e9****a9e14482c56be52&session=470e****3d015\\",\\n \\"BeginTime\\": \\"2020-10-12 14:07:20\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordByRecordIdResponse>\\n<RequestId>F46E12A5-633D-4761-80F2-285752A052D5</RequestId>\\n<Data>\\n <EndTime>2020-10-12 14:07:31</EndTime>\\n <FileName>test</FileName>\\n <BeginTime>2020-10-12 14:07:20</BeginTime>\\n <VodUrl>https://iotx-vision-vod-vpc-hz-pre.aliyun-inc.com/vod/device/localrecord/flv/play/1****668.flv?token=e9****a9e14482c56be52&session=470e****3d015</VodUrl>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryRecordByRecordIdResponse>","errorExample":""}]', + 'title' => '通过设备和录像id查询录像信息', + 'summary' => '调用该接口通过录像文件ID查询录像文件URL。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRecordPlanDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '录像计划ID。可调用[QueryRecordPlans](~~107896~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '录像计划详细信息。', + 'type' => 'object', + 'properties' => [ + 'PlanId' => [ + 'description' => '录像计划ID。', + 'type' => 'string', + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + 'Name' => [ + 'description' => '录像计划模板名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'TemplateId' => [ + 'description' => '录像计划的时间模板ID。', + 'type' => 'string', + 'example' => '693e244a038f4255bb2f5db32874****', + ], + 'TemplateInfo' => [ + 'description' => '时间模板信息。', + 'type' => 'object', + 'properties' => [ + 'AllDay' => [ + 'description' => '是否7天*24小时录像：'."\n" + ."\n" + .'- 1：7天*24小时录像。'."\n" + .'- 0：非7天*24小时录像。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Default' => [ + 'description' => '模板类型：'."\n" + .'- **1**：默认模板'."\n" + .'- **0**：自定义模板', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'description' => '时间模板名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'TemplateId' => [ + 'description' => '时间模板ID。', + 'type' => 'string', + 'example' => '693e244a038f4255bb2f5db32874****', + ], + 'TimeSectionList' => [ + 'description' => '时间模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'End' => [ + 'description' => '每天结束的时间，取值范围1~86399，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20000', + ], + 'DayOfWeek' => [ + 'description' => '每周的周几，取值范围0~6，表示周日~周六。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Begin' => [ + 'description' => '每天开始的时间，取值范围0~86399，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PlanId\\": \\"5b60bf0dd55944c19d7817442bc9****\\",\\n \\"Name\\": \\"test\\",\\n \\"TemplateId\\": \\"693e244a038f4255bb2f5db32874****\\",\\n \\"TemplateInfo\\": {\\n \\"AllDay\\": 1,\\n \\"Default\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"TemplateId\\": \\"693e244a038f4255bb2f5db32874****\\",\\n \\"TimeSectionList\\": [\\n {\\n \\"End\\": 20000,\\n \\"DayOfWeek\\": 0,\\n \\"Begin\\": 6000\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordPlanDetailResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>\\n <PlanId>5b60bf0dd55944c19d7817442bc9****</PlanId>\\n <TemplateId>693e244a038f4255bb2f5db32874****</TemplateId>\\n <Name>test</Name>\\n <TemplateInfo>\\n <AllDay>0</AllDay>\\n <Default>0</Default>\\n <TemplateId>693e244a038f4255bb2f5db32874****</TemplateId>\\n <Name>test</Name>\\n <TimeSectionList>\\n <DayOfWeek>0</DayOfWeek>\\n <Begin>6000</Begin>\\n <End>20000</End>\\n </TimeSectionList>\\n </TemplateInfo>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryRecordPlanDetailResponse>","errorExample":""}]', + 'title' => '查询录像计划详情', + 'summary' => '调用该接口查询录像计划详情。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRecordPlanDeviceByDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型：'."\n" + .'- **0**：主码流'."\n" + .'- **1**：辅码流', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '录像计划信息。', + 'type' => 'object', + 'properties' => [ + 'PlanId' => [ + 'description' => '录像计划ID。', + 'type' => 'string', + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + 'Name' => [ + 'description' => '录像计划模板名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'TemplateId' => [ + 'description' => '录像计划关联的时间模板ID。', + 'type' => 'string', + 'example' => '693e244a038f4255bb2f5db32874****', + ], + 'TemplateInfo' => [ + 'description' => '时间模板信息。', + 'type' => 'object', + 'properties' => [ + 'AllDay' => [ + 'description' => '是否7天*24小时录像：'."\n" + ."\n" + .'- 1：是。'."\n" + .'- 0：否，详细配置请查看TimeSectionList参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Default' => [ + 'description' => '模板类型：'."\n" + .'- **1**：默认模板'."\n" + .'- **0**：自定义模板', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Name' => [ + 'description' => '时间模板名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'TemplateId' => [ + 'description' => '时间模板ID。', + 'type' => 'string', + 'example' => '693e244a038f4255bb2f5db32874****', + ], + 'TimeSectionList' => [ + 'description' => '时间模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'End' => [ + 'description' => '每天结束的时间，取值范围1~86399，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20000', + ], + 'DayOfWeek' => [ + 'description' => '每周的周几，取值范围0~6，表示周日~周六。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Begin' => [ + 'description' => '每天开始的时间，取值范围0~86399，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PlanId\\": \\"5b60bf0dd55944c19d7817442bc9****\\",\\n \\"Name\\": \\"test\\",\\n \\"TemplateId\\": \\"693e244a038f4255bb2f5db32874****\\",\\n \\"TemplateInfo\\": {\\n \\"AllDay\\": 1,\\n \\"Default\\": 0,\\n \\"Name\\": \\"test\\",\\n \\"TemplateId\\": \\"693e244a038f4255bb2f5db32874****\\",\\n \\"TimeSectionList\\": [\\n {\\n \\"End\\": 20000,\\n \\"DayOfWeek\\": 0,\\n \\"Begin\\": 6000\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordPlanByDeviceResponse> \\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>\\n <PlanId>5b60bf0dd55944c19d7817442bc9****</PlanId>\\n <TemplateId>693e244a038f4255bb2f5db32874****</TemplateId>\\n <Name>test</Name>\\n <TemplateInfo>\\n <AllDay>0</AllDay>\\n <Default>0</Default>\\n <TemplateId>693e244a038f4255bb2f5db32874****</TemplateId>\\n <Name>test</Name>\\n <TimeSectionList>\\n <DayOfWeek>0</DayOfWeek>\\n <Begin>6000</Begin>\\n <End>20000</End>\\n </TimeSectionList>\\n </TemplateInfo>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryRecordPlanByDeviceResponse> ","errorExample":""}]', + 'title' => '根据设备查询录像计划', + 'summary' => '调用该接口根据IPC的设备ID，查询该视频设备的录像计划。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRecordPlanDeviceByPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '录像计划ID。可调用[QueryRecordPlans](~~107896~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。页数从1开始排序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。最小值为1，最大值为50，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。'."\n", + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Page' => [ + 'description' => '当前页面号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'List' => [ + 'description' => '返回的模板列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StreamType' => [ + 'description' => '码流类型：'."\n" + .'- **0**：主码流'."\n" + .'- **1**：辅码流', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IotId' => [ + 'description' => '设备ID。', + 'type' => 'string', + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"PageCount\\": 1,\\n \\"Page\\": 1,\\n \\"List\\": [\\n {\\n \\"StreamType\\": 1,\\n \\"IotId\\": \\"zLZyi6aOLyOSHa9hsPyD00****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordPlanDeviceResponse> \\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n <code>200</code>\\n <Success>true</Success>\\n <Data>\\n <Total>2</Total>\\n <PageCount>1</PageCount>\\n <PageSize>10</PageSize>\\n <Page>1</Page>\\n <List>\\n <IotId>zLZyi6aOLyOSHa9hsPyD00****</IotId>\\n <StreamType>1</StreamType>\\n </List>\\n <List>\\n <IotId>C47T6xwp6ms4bNlkHRWCg4****</IotId>\\n <StreamType>1</StreamType>\\n </List>\\n </Data>\\n</QueryRecordPlanDeviceResponse> ","errorExample":""}]', + 'title' => '查询录像计划关联设备列表', + 'summary' => '调用该接口查询录像计划关联的设备。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRecordPlans' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。页数从1开始排序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。最小值1，最大值50，默认值10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询信息。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Total' => [ + 'description' => '查询到的录像计划的总记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Page' => [ + 'description' => '当前页面号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'List' => [ + 'description' => '返回的录像计划模板列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PlanId' => [ + 'description' => '录像计划ID。', + 'type' => 'string', + 'example' => '6c5a397bc17c4b48ace86f0f0c30****', + ], + 'Name' => [ + 'description' => '录像计划名称。', + 'type' => 'string', + 'example' => 'plan1', + ], + 'TemplateId' => [ + 'description' => '录像计划对应的时间模板ID。', + 'type' => 'string', + 'example' => '693e244a038f4255bb2f5db32874****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 1,\\n \\"Total\\": 2,\\n \\"Page\\": 1,\\n \\"List\\": [\\n {\\n \\"PlanId\\": \\"6c5a397bc17c4b48ace86f0f0c30****\\",\\n \\"Name\\": \\"plan1\\",\\n \\"TemplateId\\": \\"693e244a038f4255bb2f5db32874****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordPlansResponse>\\n<RequestId>11A0BBA2-92B6-4EEF-8542-DBCA40E94611</RequestId>\\n<Data>\\n <PageSize>10</PageSize>\\n <PageCount>1</PageCount>\\n <Total>2</Total>\\n <Page>1</Page>\\n <List>\\n <PlanId>6c5a397bc17c4b48ace86f0f0c30****</PlanId>\\n <TemplateId>693e244a038f4255bb2f5db32874****</TemplateId>\\n <Name>plan1</Name>\\n </List>\\n <List>\\n <PlanId>5b60bf0dd55944c19d7817442bc9****</PlanId>\\n <TemplateId>693e244a038f4255bb2f5db32874****</TemplateId>\\n <Name>plan2</Name>\\n </List>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryRecordPlansResponse>","errorExample":""}]', + 'title' => '查询录像计划列表', + 'summary' => '调用该接口查询录像计划列表。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRecordUrl' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => '云端录像文件名，可调用[QueryRecord](~~107922~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'file1', + ], + ], + [ + 'name' => 'SeekTime', + 'in' => 'query', + 'schema' => [ + 'description' => '录像播放偏移时间，单位秒。默认值为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'<props="china">您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。</props>'."\n" + ."\n" + .'<props="intl">无需传入此参数。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', + ], + ], + [ + 'name' => 'UrlValidDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'URL有效期，单位秒，取值范围10~3600，单位秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '3600', + 'minimum' => '10', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '录像文件的URL。URL包含鉴权信息，且无法重复使用。', + 'type' => 'string', + 'example' => 'https://linkvisual.aliyun.com/ddsffa****.m3u8', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"https://linkvisual.aliyun.com/ddsffa****.m3u8\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordUrlResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>https://linkvisual.aliyun.com/ddsffa****.m3u8</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryRecordUrlResponse>","errorExample":""}]', + 'title' => '查询录像播放地址', + 'summary' => '调用该接口查询云端录像文件的播放地址。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryTimeTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。页数从1开始排序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。最小值为1，最大值为50，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功时，返回时间模板信息。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Page' => [ + 'description' => '当前页面号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'List' => [ + 'description' => '返回的模板列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AllDay' => [ + 'description' => '是否7天*24小时录像：'."\n" + ."\n" + .'- 1：是。'."\n" + .'- 0：否，详细配置请查看TimeSectionList参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Default' => [ + 'description' => '是否是默认模板：'."\n" + ."\n" + .'- **1**：默认模板。'."\n" + .'- **0**：自定义模板。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Name' => [ + 'description' => '时间模板名称。', + 'type' => 'string', + 'example' => 'exampleName', + ], + 'TemplateId' => [ + 'description' => '时间模板ID。', + 'type' => 'string', + 'example' => 'adxxx', + ], + 'TimeSectionList' => [ + 'description' => '时间模板信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'End' => [ + 'description' => '每天结束的时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60000', + ], + 'DayOfWeek' => [ + 'description' => '每周的周几，取值范围0~6，表示周日~周六。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Begin' => [ + 'description' => '每天开始的时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"PageCount\\": 1,\\n \\"Page\\": 1,\\n \\"List\\": [\\n {\\n \\"AllDay\\": 1,\\n \\"Default\\": 1,\\n \\"Name\\": \\"exampleName\\",\\n \\"TemplateId\\": \\"adxxx\\",\\n \\"TimeSectionList\\": [\\n {\\n \\"End\\": 60000,\\n \\"DayOfWeek\\": 0,\\n \\"Begin\\": 20000\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryTimeTemplateResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>\\n <Total>2</Total>\\n <PageCount>1</PageCount>\\n <Page>1</Page>\\n <PageSize>10</PageSize>\\n <List>\\n <TemplateId>joijoz***</TemplateId>\\n <Name>testtime1</Name>\\n <AllDay>0</AllDay>\\n <Default>0</Default>\\n <TimeSectionList>\\n <DayOfWeek>0</DayOfWeek>\\n <Begin>20000</Begin>\\n <End>60000</End>\\n </TimeSectionList>\\n <TimeSectionList>\\n <DayOfWeek>1</DayOfWeek>\\n <Begin>20000</Begin>\\n <End>60000</End>\\n </TimeSectionList>\\n </List>\\n <List>\\n <TemplateId>joijoz***</TemplateId>\\n <Name>testtime2</Name>\\n <AllDay>0</AllDay>\\n <Default>0</Default>\\n <TimeSectionList>\\n <DayOfWeek>1</DayOfWeek>\\n <Begin>20000</Begin>\\n <End>60000</End>\\n </TimeSectionList>\\n <TimeSectionList>\\n <DayOfWeek>2</DayOfWeek>\\n <Begin>20000</Begin>\\n <End>60000</End>\\n </TimeSectionList>\\n </List>\\n</Data>\\n</QueryTimeTemplateResponse>","errorExample":""}]', + 'title' => '查询设备录像在云上的存储生命周期', + 'summary' => '调用该接口查询设备的时间模板信息。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryDeviceEventRecord' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'EventId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能告警事件ID。可通过[QueryDeviceEvent](~~107916~~)接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '907084996e1d44788d0*****43906_160803*****37', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'<props="china">您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。</props>'."\n" + ."\n" + .'<props="intl">无需传入此参数。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1****z0t', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '录像结束时间。', + 'type' => 'string', + 'example' => '2021-09-08 15:56:32', + ], + 'FileName' => [ + 'description' => '录像文件名。', + 'type' => 'string', + 'example' => 'file1', + ], + 'VodUrl' => [ + 'description' => '录像文件的URL。'."\n" + ."\n" + .'> URL中包含鉴权信息，且单次有效，不可重复使用。', + 'type' => 'string', + 'example' => 'rtmp://****/****.mp4', + ], + 'BeginTime' => [ + 'description' => '录像开始时间。', + 'type' => 'string', + 'example' => '2021-09-08 15:55:35', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EndTime\\": \\"2021-09-08 15:56:32\\",\\n \\"FileName\\": \\"file1\\",\\n \\"VodUrl\\": \\"rtmp://****/****.mp4\\",\\n \\"BeginTime\\": \\"2021-09-08 15:55:35\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryDeviceEventRecordResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>\\n <EndTime>2021-09-08 15:56:32</EndTime>\\n <FileName>file1</FileName>\\n <BeginTime>2021-09-08 15:55:35</BeginTime>\\n <VodUrl>rtmp://****/****.mp4</VodUrl>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryDeviceEventRecordResponse>","errorExample":""}]', + 'title' => '获取事件录像', + 'summary' => '调用该接口获取IPC设备的指定智能告警事件，对应的录像文件URL。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryDeviceVodUrl' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => '录像文件名。可调用物联网平台提供的[InvokeThingService](~~69584~~)查询，其中请求参数示例，请参见下方的**请求参数补充说明**。'."\n" + ."\n" + .'> 录像文件名长度不得超过180个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'file1', + ], + ], + [ + 'name' => 'Scheme', + 'in' => 'query', + 'schema' => [ + 'description' => '协议类型：'."\n" + .'- **rtmp**：RTMP协议。'."\n" + .'- **flv**：HTTP-FLV协议。'."\n" + .'- **hls**：HLS协议。'."\n" + .' > HLS协议使用限制详细内容，请参见[云端开发](~~208584~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'rtmp', + ], + ], + [ + 'name' => 'SeekTime', + 'in' => 'query', + 'schema' => [ + 'description' => '相对于录像开始时间**BeginTime**的偏移量，单位为秒，默认值为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'EnableStun', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + ], + [ + 'name' => 'ShouldEncrypt', + 'in' => 'query', + 'schema' => [ + 'description' => '是否加密：'."\n" + .'- **true**：加密'."\n" + .'- **false**（默认）：不加密', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'UrlValidDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'URL有效期，取值范围为10~14400，单位为秒。默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'PlayUnLimited', + 'in' => 'query', + 'schema' => [ + 'description' => '播放地址是否可以无限次使用：'."\n" + .'- **true**：10秒内可无限次使用。'."\n" + .'- **false**（默认）：仅可使用一次。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'EncryptType', + 'in' => 'query', + 'schema' => [ + 'description' => '加密类型。目前仅支持I帧加密，取值为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'product is not active.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'DecryptKey' => [ + 'description' => '解密密钥。'."\n" + .'设置**ShouldEncrypt**参数为**true**时，生成解密密钥。', + 'type' => 'string', + 'example' => '{"iv": "MDEy****OTo7PD0+Pw==","key": "eA2r****fHjOmnyBfQ=="}', + ], + 'StunInfo' => [ + 'type' => 'string', + ], + 'VodUrl' => [ + 'description' => '本地录像URL。', + 'type' => 'string', + 'example' => 'rtmp://***/***.mp4', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"product is not active.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"VodUrl\\": \\"rtmp://***/***.mp4\\",\\n \\"DecryptKey\\": \\"{\\\\\\"iv\\\\\\": \\\\\\"MDEy****OTo7PD0+Pw==\\\\\\",\\\\\\"key\\\\\\": \\\\\\"eA2r****fHjOmnyBfQ==\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryDeviceVodUrlResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>\\n <DecryptKey>\\n <iv>MDEy****OTo7PD0+Pw==</iv>\\n <key>eA2r****fHjOmnyBfQ==</key>\\n </DecryptKey>\\n <VodUrl>rtmp://***/***.mp4</VodUrl>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryDeviceVodUrlResponse>","errorExample":""}]', + 'title' => '查询本地录像列表', + 'summary' => '调用该接口，获取本地NVR设备或IPC设备的存储卡中，指定录像文件名的录像文件URL。', + 'requestParamsDescription' => '## 请求参数补充说明'."\n" + .'InvokeThingService接口请求参数示例如下，详细信息，请参见[本地录像播放](~~208584~~)。'."\n" + .'```'."\n" + .'https://iot.cn-shanghai.aliyuncs.com/?Action=InvokeThingService'."\n" + .'&ProductKey=a1BwAGV****'."\n" + .'&DeviceName=device1'."\n" + .'&Identifier=QueryRecordList //服务的标识符'."\n" + .'&Args={ //要启用服务的入参信息，数据格式为JSON String'."\n" + .' "BeginTime":10, //录像文件查询范围的起始时间，单位为秒，取值范围为0~2147483647'."\n" + .' "Type":0, //录像类型。0表示计划录像，1表示报警录像，2表示主动录像，99表示所有录像'."\n" + .' "QuerySize":2, //查询记录数，取值范围为0~128'."\n" + .' "EndTime":1541662222 //录像文件查询范围的结束时间，单位为秒，取值范围为0~2147483647'."\n" + .'}'."\n" + .'&<公共请求参数>'."\n" + .'```', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryMonthRecord' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', + ], + ], + [ + 'name' => 'Month', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的月份，格式为YYYYMM。', + 'type' => 'string', + 'required' => true, + 'example' => '201901', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'<props="china">您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。</props>'."\n" + ."\n" + .'<props="intl">无需传入此参数。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回数据的长度为当月天数，每位数据表示当天是否有录像信息，其中：'."\n" + ."\n" + .'- **1**：有录像。'."\n" + .'- **0**：未录像。', + 'type' => 'string', + 'example' => '110111111011111001111100111110', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"110111111011111001111100111110\\",\\n \\"ErrorMessage\\": \\"tenant auth error.\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<QueryMonthRecordResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>110111111011111001111100111110</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryMonthRecordResponse>","errorExample":""}]', + 'title' => '查询月录像', + 'summary' => '调用该接口，查询IPC设备某月份的每一天是否有录像。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryDeviceRecordLifeCycle' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'DeviceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'IPC设备的IotId列表。IotId是物联网平台为该设备颁发的ID，设备的唯一标识符。'."\n" + ."\n" + .'可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + 'example' => '["C47T6xwp6ms4bNlkHRWCg4****", "d7XmBoJhAr88C6PelXDF00****"]', + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'InvalidParameters', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Day' => [ + 'description' => 'IPC的录像生命周期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'IotId' => [ + 'description' => '设备ID。', + 'type' => 'string', + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"InvalidParameters\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Day\\": 7,\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryDeviceRecordLifeCycleResponse>\\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n <Data>\\n <IotId>C47T6xwp6ms4bNlkHRWCg4****</IotId>\\n <Day>7</Day>\\n </Data>\\n <ErrorMessage>InvalidParameters</ErrorMessage>\\n <Code>200</Code>\\n <Success>true</Success>\\n</QueryDeviceRecordLifeCycleResponse>","errorExample":""}]', + 'title' => '获取设备云存储录像生命周期', + 'summary' => '调用该接口，获取IPC设备在云端保存录像文件的时间，即录像生命周期。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryEventRecordPlanDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能告警事件录像计划ID。可调用[QueryEventRecordPlans](~~107907~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '智能告警事件录像计划详情。', + 'type' => 'object', + 'properties' => [ + 'PreRecordDuration' => [ + 'description' => '预录时长，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Name' => [ + 'description' => '智能告警事件录像名称。', + 'type' => 'string', + 'example' => 'record1', + ], + 'PlanId' => [ + 'description' => '智能告警事件录像计划ID。', + 'type' => 'string', + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + 'TemplateId' => [ + 'description' => '时间模板ID。', + 'type' => 'string', + 'example' => '36f06322442e4e3f85a5ae8862c9****', + ], + 'RecordDuration' => [ + 'description' => '录像时长，包括预录时长。单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120', + ], + 'TemplateInfo' => [ + 'description' => '时间模板详情。', + 'type' => 'object', + 'properties' => [ + 'AllDay' => [ + 'description' => '是否7天*24小时录像：'."\n" + ."\n" + .'- 1：是。'."\n" + .'- 0：否，详细配置请查看TimeSectionList参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Default' => [ + 'description' => '模板类型：'."\n" + .'- 1：默认模板'."\n" + .'- 0：自定义模板', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Name' => [ + 'description' => '时间模板名称。', + 'type' => 'string', + 'example' => 'temp1', + ], + 'TemplateId' => [ + 'description' => '时间模板ID。', + 'type' => 'string', + 'example' => '36f06322442e4e3f85a5ae8862c9****', + ], + 'TimeSectionList' => [ + 'description' => 'AllDay为0时，时间模板的详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'End' => [ + 'description' => '每天结束的时间，取值范围1~86399，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20000', + ], + 'DayOfWeek' => [ + 'description' => '每周的周几，取值范围0~6，表示周日~周六。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Begin' => [ + 'description' => '每天开始的时间，取值范围0~86399，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PreRecordDuration\\": 30,\\n \\"Name\\": \\"record1\\",\\n \\"PlanId\\": \\"5b60bf0dd55944c19d7817442bc9****\\",\\n \\"TemplateId\\": \\"36f06322442e4e3f85a5ae8862c9****\\",\\n \\"RecordDuration\\": 120,\\n \\"TemplateInfo\\": {\\n \\"AllDay\\": 0,\\n \\"Default\\": 0,\\n \\"Name\\": \\"temp1\\",\\n \\"TemplateId\\": \\"36f06322442e4e3f85a5ae8862c9****\\",\\n \\"TimeSectionList\\": [\\n {\\n \\"End\\": 20000,\\n \\"DayOfWeek\\": 0,\\n \\"Begin\\": 6000\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryEventRecordPlanDetailResponse> \\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>\\n <RecordDuration>120</RecordDuration>\\n <PlanId>5b60bf0dd55944c19d7817442bc9****</PlanId>\\n <PreRecordDuration>30</PreRecordDuration>\\n <TemplateId>36f06322442e4e3f85a5ae8862c9****</TemplateId>\\n <Name>record1</Name>\\n <TemplateInfo>\\n <AllDay>0</AllDay>\\n <Default>0</Default>\\n <TemplateId>36f06322442e4e3f85a5ae8862c9****</TemplateId>\\n <Name>temp1</Name>\\n <TimeSectionList>\\n <DayOfWeek>0</DayOfWeek>\\n <Begin>6000</Begin>\\n <End>20000</End>\\n </TimeSectionList>\\n <TimeSectionList>\\n <DayOfWeek>5</DayOfWeek>\\n <Begin>0</Begin>\\n <End>40000</End>\\n </TimeSectionList>\\n </TemplateInfo>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryEventRecordPlanDetailResponse> ","errorExample":""}]', + 'title' => '查询事件联动录像计划详情', + 'summary' => '调用该接口查询智能告警事件录像计划详情。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryEventRecordPlanDeviceByDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型：'."\n" + .'- **0**（默认）：主码流'."\n" + .'- **1**：辅码流'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'PreRecordDuration' => [ + 'description' => '预录时长，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Name' => [ + 'description' => '智能告警事件录像名称。', + 'type' => 'string', + 'example' => 'planAA', + ], + 'PlanId' => [ + 'description' => '智能告警事件录像计划ID。', + 'type' => 'string', + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + 'TemplateId' => [ + 'description' => '时间模板ID。', + 'type' => 'string', + 'example' => '36f06322442e4e3f85a5ae8862c9****', + ], + 'RecordDuration' => [ + 'description' => '录像时长，包括预录时长，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '120', + ], + 'TemplateInfo' => [ + 'description' => '时间模板详情。', + 'type' => 'object', + 'properties' => [ + 'AllDay' => [ + 'description' => '是否7天*24小时录像：'."\n" + ."\n" + .'- **1**：是。'."\n" + .'- **0**：否，详细配置请查看**TimeSectionList**参数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Default' => [ + 'description' => '时间模板类型：'."\n" + .'- **1**：默认模板'."\n" + .'- **0**：自定义模板', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Name' => [ + 'description' => '时间模板名称。', + 'type' => 'string', + 'example' => 'testtime1', + ], + 'TemplateId' => [ + 'description' => '时间模板ID。', + 'type' => 'string', + 'example' => '36f06322442e4e3f85a5ae8862c9****', + ], + 'TimeSectionList' => [ + 'description' => '时间模板列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'End' => [ + 'description' => '每天结束的时间，取值范围1~86399，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '86399', + ], + 'DayOfWeek' => [ + 'description' => '每周的周几，取值范围0~6，表示周日~周六。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Begin' => [ + 'description' => '每天开始的时间，取值范围0~86399，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PreRecordDuration\\": 5,\\n \\"Name\\": \\"planAA\\",\\n \\"PlanId\\": \\"5b60bf0dd55944c19d7817442bc9****\\",\\n \\"TemplateId\\": \\"36f06322442e4e3f85a5ae8862c9****\\",\\n \\"RecordDuration\\": 120,\\n \\"TemplateInfo\\": {\\n \\"AllDay\\": 0,\\n \\"Default\\": 0,\\n \\"Name\\": \\"testtime1\\",\\n \\"TemplateId\\": \\"36f06322442e4e3f85a5ae8862c9****\\",\\n \\"TimeSectionList\\": [\\n {\\n \\"End\\": 86399,\\n \\"DayOfWeek\\": 0,\\n \\"Begin\\": 0\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryEventRecordPlanByDeviceResponse> \\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n <Data>\\n <PlanId>5b60bf0dd55944c19d7817442bc9****</PlanId>\\n <Name>planAA</Name>\\n <PreRecordDuration>5</PreRecordDuration>\\n <RecordDuration>120</RecordDuration>\\n <TemplateId>36f06322442e4e3f85a5ae8862c9****</TemplateId>\\n <TemplateInfo>\\n <TemplateId>36f06322442e4e3f85a5ae8862c9****</TemplateId>\\n <Name>testtime1</Name>\\n <AllDay>0</AllDay>\\n <Default>0</Default>\\n <TimeSectionList>\\n <DayOfWeek>1</DayOfWeek>\\n <Begin>0</Begin>\\n <End>86399</End>\\n </TimeSectionList>\\n <TimeSectionList>\\n <DayOfWeek>5</DayOfWeek>\\n <Begin>0</Begin>\\n <End>40000</End>\\n </TimeSectionList>\\n </TemplateInfo>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</QueryEventRecordPlanByDeviceResponse>","errorExample":""}]', + 'title' => '根据设备查询事件联动录像计划', + 'summary' => '调用该接口，根据IPC的设备ID查询智能告警事件录像计划。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryEventRecordPlanDeviceByPlan' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '智能告警事件录像计划ID。可调用[QueryEventRecordPlans](~~107907~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示，默认值1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。最小值为1，最大值为50，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。'."\n", + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Page' => [ + 'description' => '当前页面号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'List' => [ + 'description' => '设备信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StreamType' => [ + 'description' => '码流类型：'."\n" + .'- **0**：主码流'."\n" + .'- **1**：辅码流'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IotId' => [ + 'description' => '摄像头的设备ID。', + 'type' => 'string', + 'example' => 'P7WqhWvhplhHlWPO9Op5g4****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 2,\\n \\"PageCount\\": 1,\\n \\"Page\\": 1,\\n \\"List\\": [\\n {\\n \\"StreamType\\": 1,\\n \\"IotId\\": \\"P7WqhWvhplhHlWPO9Op5g4****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryEventRecordPlanDeviceByPlanResponse> \\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n <Success>true</Success>\\n <Data>\\n <Total>2</Total>\\n <PageCount>1</PageCount>\\n <Page>1</Page>\\n <PageSize>10</PageSize>\\n <List>\\n <IotId>P7WqhWvhplhHlWPO9Op5g4****</IotId>\\n <StreamType>1</StreamType>\\n </List>\\n <List>\\n <IotId>C47T6xwp6ms4bNlkHRWCg4****</IotId>\\n <StreamType>1</StreamType>\\n </List>\\n </Data>\\n</QueryEventRecordPlanDeviceByPlanResponse> ","errorExample":""}]', + 'title' => '查询事件联动录像计划摄像头列表', + 'summary' => '调用该接口，查询智能告警事件录像计划，关联的摄像头列表。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryEventRecordPlans' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。最小值为1，最大值为50，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用失败时，返回的错误码。更多信息，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Page' => [ + 'description' => '当前页面号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'List' => [ + 'description' => '智能告警事件录像计划列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventType' => [ + 'description' => '智能告警事件类型。请在物联网平台控制台，**产品详情**页面的**功能定义**页签，找到**智能告警**，查看全部智能告警事件类型。'."\n" + ."\n" + .'详细信息，请参考[智能告警事件](~~207701~~)。', + 'type' => 'string', + 'example' => '1', + ], + 'RecordDuration' => [ + 'description' => '录像时长，包括预录时长，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'PreRecordDuration' => [ + 'description' => '预录时长，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PlanId' => [ + 'description' => '智能告警事件录像计划ID。', + 'type' => 'string', + 'example' => '5b60bf0dd55944c19d7817442bc9****', + ], + 'Name' => [ + 'description' => '智能告警事件录像名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'TemplateId' => [ + 'description' => '时间模板ID。', + 'type' => 'string', + 'example' => '36f06322442e4e3f85a5ae8862c9****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 1,\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"List\\": [\\n {\\n \\"EventType\\": \\"1\\",\\n \\"RecordDuration\\": 60,\\n \\"PreRecordDuration\\": 5,\\n \\"PlanId\\": \\"5b60bf0dd55944c19d7817442bc9****\\",\\n \\"Name\\": \\"test\\",\\n \\"TemplateId\\": \\"36f06322442e4e3f85a5ae8862c9****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryEventRecordPlansResponse> \\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n <Success>true</Success>\\n <Data>\\n <Total>1</Total>\\n <PageCount>1</PageCount>\\n <Page>1</Page>\\n <PageSize>10</PageSize>\\n <List>\\n <PlanId>5b60bf0dd55944c19d7817442bc9****</PlanId>\\n <Name>planAA</Name>\\n <PreRecordDuration>5</PreRecordDuration>\\n <RecordDuration>60</RecordDuration>\\n <TemplateId>36f06322442e4e3f85a5ae8862c9****</TemplateId>\\n </List>\\n </Data>\\n</QueryEventRecordPlansResponse>","errorExample":""}]', + 'title' => '查询事件录像计划列表', + 'summary' => '调用该接口查询智能告警事件录像计划列表。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TriggerRecord' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'zLZyi6aOLyOSHa****yD000100', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型：'."\n" + .'- **0**（默认）：主码流。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'PreRecordDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '预录时长，取值范围0~10，单位为秒。'."\n" + ."\n" + .'>设备具备预录功能时，才可生成预录时长，否则，预录时长为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'RecordDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '录像时长，包括预录时长，取值范围10~7200，单位为秒。'."\n" + ."\n" + .'> 单个录像文件长度最大为30分钟，当录像时长大于30分钟时，会自动切割成多个录像文件。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '60', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'<props="china">您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。</props>'."\n" + ."\n" + .'<props="intl">无需传入此参数。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y5****0t', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => 'IPC设备获取的录像上传后，生成的录像文件ID。', + 'type' => 'string', + 'example' => 'fc82774fa749485bad7d719f9670****', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"fc82774fa749485bad7d719f9670****\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<TriggerRecordResponse>\\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n <Data>fc82774fa749485bad7d719f9670****</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</TriggerRecordResponse>","errorExample":""}]', + 'title' => '触发录像', + 'summary' => '调用该接口立即触发指定IPC设备开始录像，并上传录像文件至云端。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryDevicePictureByList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '1CJ0****e7qiq8VkQi1000000', + ], + ], + [ + 'name' => 'ThumbWidth', + 'in' => 'query', + 'schema' => [ + 'description' => '指定目标缩放图的宽度，单位为px，取值范围为1~4096。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + 'default' => '0', + ], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => '图片URL的失效时间，单位为分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + 'default' => '0', + ], + ], + [ + 'name' => 'PictureType', + 'in' => 'query', + 'schema' => [ + 'description' => '图片类型：'."\n" + ."\n" + .'- **0**：缩略图。'."\n" + .'- **1**：原图。 '."\n" + .'- **2**（默认）：全部。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '2', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'<props="china">您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。</props>'."\n" + ."\n" + .'<props="intl">无需传入此参数。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y******', + ], + ], + [ + 'name' => 'PictureIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '图片ID列表。图片ID由调用[TriggerCapturePicture](~~107914~~)时生成。'."\n" + ."\n" + .'> 单次调用最多支持输入50个图片ID。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + 'example' => 'cFc5MzZ****npYT1***TDFzX1hrVzA0Z****', + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'request forbidden', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'picData' => [ + 'description' => '响应结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PicId' => [ + 'description' => '图片ID。', + 'type' => 'string', + 'example' => 'RW****HFRO****jUyMjIy', + ], + 'PicUrl' => [ + 'description' => '图片URL。', + 'type' => 'string', + 'example' => 'https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEp****%3D', + ], + 'PicCreateTime' => [ + 'description' => '图片创建时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1632453652222', + ], + 'ThumbUrl' => [ + 'description' => '缩略图URL。', + 'type' => 'string', + 'example' => 'https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEpDE****%2Cq_90', + ], + 'IotId' => [ + 'description' => 'IPC设备的设备ID。', + 'type' => 'string', + 'example' => '1CJ0****e7qiq8VkQi1000000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"request forbidden\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"picData\\": [\\n {\\n \\"PicId\\": \\"RW****HFRO****jUyMjIy\\",\\n \\"PicUrl\\": \\"https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEp****%3D\\",\\n \\"PicCreateTime\\": 1632453652222,\\n \\"ThumbUrl\\": \\"https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEpDE****%2Cq_90\\",\\n \\"IotId\\": \\"1CJ0****e7qiq8VkQi1000000\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryDevicePictureByListResponse>\\n<RequestId>B68F5AC3-F1AF-5C4A-8170-913F4FDDE2B8</RequestId>\\n<Data>\\n <picData>\\n <IotId>1CJ03rzf****Qi1000000</IotId>\\n <ThumbUrl>https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEpDE****%2Cq_90</ThumbUrl>\\n <PicUrl>https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEp****%3D</PicUrl>\\n <PicCreateTime>1632453652222</PicCreateTime>\\n <PicId>RW****HFRO****jUyMjIy</PicId>\\n </picData>\\n <picData>\\n <IotId>1CJ03rzf****Qi1000000</IotId>\\n <ThumbUrl>https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEpDEUQ****uality%2Cq_90</ThumbUrl>\\n <PicUrl>https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbO****%3D</PicUrl>\\n <PicCreateTime>1632454869397</PicCreateTime>\\n <PicId>RWJ****OSHFZm****Mzk3</PicId>\\n </picData>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryDevicePictureByListResponse>","errorExample":""}]', + 'title' => 'QueryDevicePictureByList', + 'summary' => '，根据图片ID列表，获取图片地址。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TransferDeviceInstance' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DeviceNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '待迁移的设备名称列表。最多包含100个设备名称。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + 'example' => 'RepeatList', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '设备所属产品的ProductKey，创建产品时，物联网平台为该产品生成的唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'SourceInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备所属的源实例ID：'."\n" + ."\n" + .'- 公共实例ID：iotx-oxssharez200。'."\n" + .' > 目前仅支持华东2（上海）地域，其实例ID为iotx-oxssharez200。'."\n" + ."\n" + .'- 企业版实例ID：登录物联网平台控制台，在**实例概览**页面，单击实例名称，在**实例详情**页面的**实例基本信息**中查看**实例ID**。', + 'type' => 'string', + 'required' => false, + 'example' => 'iotx-oxssharez200', + ], + ], + [ + 'name' => 'TargetInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备迁移的目标实例ID。目标实例仅支持企业版实例。'."\n" + ."\n" + .'您可登录物联网平台控制台，在**实例概览**页面，单击实例名称，在**实例详情**页面的**实例基本信息**中查看**实例ID**。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'iot-060***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '27AF2E38-12ED-4F67-BD20-36E812CD7A42', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => '来源实例和目标实例不能相同', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'SuccessList' => [ + 'description' => '迁移成功的设备列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceName' => [ + 'description' => '设备名称。', + 'type' => 'string', + 'example' => 'e598798j****', + ], + 'Message' => [ + 'description' => '迁移成功的描述信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + 'FailedList' => [ + 'description' => '迁移失败的设备列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceName' => [ + 'description' => '设备名称。', + 'type' => 'string', + 'example' => 'e5jdfalekj****', + ], + 'Message' => [ + 'description' => '迁移失败的描述信息。', + 'type' => 'string', + 'example' => '设备已经转移或不属于来源实例', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"27AF2E38-12ED-4F67-BD20-36E812CD7A42\\",\\n \\"ErrorMessage\\": \\"来源实例和目标实例不能相同\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SuccessList\\": [\\n {\\n \\"DeviceName\\": \\"e598798j****\\",\\n \\"Message\\": \\"success\\"\\n }\\n ],\\n \\"FailedList\\": [\\n {\\n \\"DeviceName\\": \\"e5jdfalekj****\\",\\n \\"Message\\": \\"设备已经转移或不属于来源实例\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<TransferDeviceInstanceResponse>\\n<RequestId>F1F1CD2E-0918-4804-9D44-8C3EE26DD3B5</RequestId>\\n<Data>\\n <SuccessList>\\n <Message>success</Message>\\n <DeviceName>QYA1</DeviceName>\\n </SuccessList>\\n <SuccessList>\\n <Message>success</Message>\\n <DeviceName>QYA2</DeviceName>\\n </SuccessList>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</TransferDeviceInstanceResponse>","errorExample":""}]', + 'title' => 'TransferDeviceInstance', + 'summary' => '，迁移设备所在的实例。', + 'description' => '调用该接口迁移设备所在的实例前，请您联系技术支持人员进行迁移方案评估，防止迁移后功能无法使用。'."\n" + ."\n" + .'**前提条件**'."\n" + ."\n" + .'- 被迁移的设备已开通视频服务功能。'."\n" + .' - 公共实例的设备：登录物联网平台控制台，单击**公共实例**。在左侧菜单栏，选择**视频服务** > **接入服务**。在**接入服务**页面，单击**产品管理**页签。确认待迁移设备所在产品，对应**已开通/未开通状态**列为**已开通**。'."\n" + .' - 企业版实例的设备：已启用视频服务。'."\n" + .'- 设备分发任务已经完成。详细信息，请参考[CreateDeviceDistributeJob](~~199390~~)或[设备分发](~~143450~~)。'."\n" + .'- 确保摄像头设备已配置图片生命周期。若摄像头设备未配置图片生命周期，调用该接口后，会自动设置图片生命周期为180天。详细信息，请参考[SetDevicePictureLifeCycle](~~107880~~)。'."\n" + ."\n" + .'**背景信息**'."\n" + .'- 若迁移的源实例与目标实例类型不同，迁移前请了解实例的计费方式。计费方式详细内容，请参考[计费概述](~~124250~~)。'."\n" + .'- 迁移过程中，设备会离线，设备数量越多迁移时间越长，在此期间设备产生的数据无法保留。'."\n" + ."\n\n" + ."\n", + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRecordDownloadUrl' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => '录像文件名。可调用[QueryRecord](~~107922~~)查询。', + 'type' => 'string', + 'required' => true, + 'example' => '1623999491_LYPsmZGeEN8GdKzMtYNiBXXXXXXXXX_0/c0064411-2065-400a-a13e-********', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'<props="china">您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。</props>'."\n" + ."\n" + .'<props="intl">无需传入此参数。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'C47T6xwp6ms4bNlkHRWR****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'XXX is mandatory for this action', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '录像文件的生成状态：'."\n" + ."\n" + .'- **-1**：录像文件生成异常。'."\n" + .'- **0**：录像文件已生成完毕。'."\n" + .'- **1**：录像文件正在生成中。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Url' => [ + 'description' => '录像文件的下载地址。'."\n" + ."\n" + .'当**Status**为0且**Progress**为100时，该字段才有效。', + 'type' => 'string', + 'example' => 'https://link-vision-storage-online.oss-cn-shanghai.aliyuncs.com/transcode%2Fgk-********.mp4?OSSAccessKeyId=LTA*****TTTTTTTT&Expires=16****804&Signature=****', + ], + 'Progress' => [ + 'description' => '录像文件的生成进度，取值范围为0~100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"XXX is mandatory for this action\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"Url\\": \\"https://link-vision-storage-online.oss-cn-shanghai.aliyuncs.com/transcode%2Fgk-********.mp4?OSSAccessKeyId=LTA*****TTTTTTTT&Expires=16****804&Signature=****\\",\\n \\"Progress\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordDownloadUrlResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>\\n <Status>0</Status>\\n <Progress>0</Progress>\\n <Url>https://link-vision-storage-online.oss-cn-shanghai.aliyuncs.com/transcode%2Fgk-********.mp4?OSSAccessKeyId=LTA*****TTTTTTTT&Expires=16****804&Signature=****</Url>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryRecordDownloadUrlResponse>","errorExample":""}]', + 'title' => 'QueryRecordDownloadUrl', + 'summary' => '请求云端录像文件的下载地址。', + 'description' => '## 使用说明'."\n" + .'云端录像文件生成过程耗时较长，需要您轮询该接口获取进度，当进度完成后才会生成下载地址。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateLocalFileUploadJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'TimeSlot', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '时段列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '上传本地录像的结束时间，格式为10位时间戳，单位为秒。'."\n" + .'>单次本地录像上传任务的最大时间范围为1小时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1631019775', + ], + 'StartTime' => [ + 'description' => '上传本地录像的开始时间，格式为10位时间戳，单位为秒。'."\n" + .'>单次本地录像上传任务的最大时间范围为1小时。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1631019675', + ], + 'ProductKey' => [ + 'description' => '视频设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + 'DeviceName' => [ + 'description' => '视频设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + 'IotId' => [ + 'description' => '视频设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '本地录像上传任务ID。'."\n" + .'>请您妥善保存**JobId**。录像上传任务完成后，需使用**JobId**查询本地录像上传任务结果：[QueryLocalFileUploadJob](~~363004~~)。您也可以根据需要， 使用**JobId**停止本地录像上传任务：[DeleteLocalFileUploadJob](~~363003~~)。'."\n", + 'type' => 'string', + 'example' => '1ec1a2****d0435fbc0****34f6f139d', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InvalidParameter\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"1ec1a2****d0435fbc0****34f6f139d\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateLocalFileUploadJobResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>\\n <JobId>1ec1a2****d0435fbc0****34f6f139d</JobId>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</CreateLocalFileUploadJobResponse>","errorExample":""}]', + 'title' => 'CreateLocalFileUploadJob', + 'summary' => '调用该接口用于创建本地录像上传任务。', + 'description' => '单次本地录像上传任务最多支持上传200个文件，即TimeSlot列表最大取值为200。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteLocalFileUploadJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '本地录像上传任务ID，由创建本地录像上传任务[CreateLocalFileUploadJob](~~363002~~)生成。', + 'type' => 'string', + 'required' => true, + 'example' => '1ec1a2****d0435fbc0****34f6f139d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '该返回参数置空。', + 'type' => 'object', + 'example' => ' {}', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {},\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteLocalFileUploadJobResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data><Data/>\\n<Code>200</Code>\\n<Success>true</Success>\\n</DeleteLocalFileUploadJobResponse>","errorExample":""}]', + 'title' => '停止本地录像上传任务', + 'summary' => '调用该接口停止本地录像上传任务。', + 'description' => '停止本地录像上传任务后，已经创建的录像文件不会删除。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryLocalFileUploadJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '本地录像上传任务ID。通过[CreateLocalFileUploadJob](~~363002~~)创建。', + 'type' => 'string', + 'required' => true, + 'example' => '1ec1a****5d0435fbc0****34f6f139d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '449ECE75-A36A-4ACE-B253-147C78C440C5', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询结果。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '录像上传任务状态：'."\n" + ."\n" + .'- 0：任务初始化中。'."\n" + .'- 1：任务执行中。'."\n" + .'- 2：任务执行完成。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ResultList' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SlotEndTime' => [ + 'description' => '录像上传任务结束时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1634746054', + ], + 'ProductKey' => [ + 'description' => '视频设备所属产品的ProductKey。', + 'type' => 'string', + 'example' => 'g2****Q6ggK', + ], + 'DeviceName' => [ + 'description' => '视频设备的设备名称。', + 'type' => 'string', + 'example' => 'gb_hik_IPC', + ], + 'SlotStartTime' => [ + 'description' => '录像上传任务开始时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1634745754', + ], + 'Code' => [ + 'description' => '录像上传任务状态码：'."\n" + ."\n" + .'- 200：正常。'."\n" + .'- 9201 ：设备不在线。请上线设备后重试。'."\n" + .'- 9409 ：无云存储配额。请检查云存储配额后重试。'."\n" + .'- 9417：设备、网络或其它异常。请您重试，或检查设备和网络状态。'."\n" + .'- 9435 ：录像文件不存在。请确保视频设备本地存证录像文件，然后重试。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9201', + ], + 'SlotStatus' => [ + 'description' => '**SlotStartTime**和**SlotEndTime**的时间段内，录像上传任务的执行状态：'."\n" + .'- 0：任务初始化中。'."\n" + .'- 1：任务执行中。'."\n" + .'- 2：任务执行完成。'."\n" + .'- 3：任务执行异常。'."\n" + .'- 4：任务主动结束。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'IotId' => [ + 'description' => '视频设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。', + 'type' => 'string', + 'example' => 'IQ9mO4tvMnAj****QUdcg2n400', + ], + 'FileList' => [ + 'description' => '录像文件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileName' => [ + 'description' => '录像文件名。', + 'type' => 'string', + 'example' => 'video1', + ], + 'FileStartTime' => [ + 'description' => '录像文件开始时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1634747054', + ], + 'FileEndTime' => [ + 'description' => '录像文件结束时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1634746054', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"449ECE75-A36A-4ACE-B253-147C78C440C5\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": 2,\\n \\"ResultList\\": [\\n {\\n \\"SlotEndTime\\": 1634746054,\\n \\"ProductKey\\": \\"g2****Q6ggK\\",\\n \\"DeviceName\\": \\"gb_hik_IPC\\",\\n \\"SlotStartTime\\": 1634745754,\\n \\"Code\\": 9201,\\n \\"SlotStatus\\": 3,\\n \\"IotId\\": \\"IQ9mO4tvMnAj****QUdcg2n400\\",\\n \\"FileList\\": [\\n {\\n \\"FileName\\": \\"video1\\",\\n \\"FileStartTime\\": 1634747054,\\n \\"FileEndTime\\": 1634746054\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryLocalFileUploadJobResponse>\\n<RequestId>F9220B6D-E9BD-166E-B103-22ECF0B64393</RequestId>\\n<Data>\\n <Status>2</Status>\\n <ResultList>\\n <IotId>IQ9mO4tvM****kQRQUdcg2n400</IotId>\\n <SlotStartTime>1634745754</SlotStartTime>\\n <FileList>\\n <FileEndTime>1634746054</FileEndTime>\\n <FileName>video1</FileName>\\n <FileStartTime>1634747054</FileStartTime>\\n </FileList>\\n <SlotStatus>3</SlotStatus>\\n <SlotEndTime>1634746054</SlotEndTime>\\n <Code>200</Code>\\n <ProductKey>g2n4DLQ6ggK</ProductKey>\\n <DeviceName>gb_hik_IPC</DeviceName>\\n </ResultList>\\n <ResultList>\\n <IotId>kIDFJy49n****aSSxtqvg2n400</IotId>\\n <SlotStartTime>1634745754</SlotStartTime>\\n <SlotStatus>3</SlotStatus>\\n <SlotEndTime>1634746054</SlotEndTime>\\n <Code>9201</Code>\\n <ProductKey>g2n4DLQ6ggK</ProductKey>\\n <DeviceName>hik_nvr_39_IPC</DeviceName>\\n </ResultList>\\n <ResultList>\\n <IotId>JWNQ5oTFzU5****BJZKJg2n400</IotId>\\n <SlotStartTime>1634745754</SlotStartTime>\\n <SlotStatus>3</SlotStatus>\\n <SlotEndTime>1634752834</SlotEndTime>\\n <Code>9201</Code>\\n <ProductKey>g2n4DLQ6ggK</ProductKey>\\n <DeviceName>hik_nvr_33_</DeviceName>\\n </ResultList>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryLocalFileUploadJobResponse>","errorExample":""}]', + 'title' => '查询本地录像上传任务结果', + 'summary' => '查询本地录像上传任务结果。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFaceUserBatch' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'UserIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户ID列表。请传入在调用[AddFaceUser](~~288338~~)接口添加用户后，获取并保存到本地的用户ID。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + 'example' => '["xqymlby****4whye","6qyyb69zqara****","64nbfx8****hzmy4"]', + 'maxItems' => 50, + ], + ], + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离ID，用于隔离同一个阿里云账号下不同业务应用之间的数据。请与调用[AddFaceUser](~~288338~~)接口添加用户时设置的**IsolationId**保持一致。', + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHZ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'face user not exist', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Params' => [ + 'description' => '自定义的用户参数。', + 'type' => 'string', + 'example' => '{"key1":"value1", "key2":"value2"}', + ], + 'CustomUserId' => [ + 'description' => '用户身份识别ID。', + 'type' => 'string', + 'example' => '1234567890', + ], + 'CreateTime' => [ + 'description' => '用户创建人脸数据的13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1636427314000', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '3mtjaqebeq4d****', + ], + 'Name' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'Tony', + ], + 'ModifyTime' => [ + 'description' => '用户最后一次修改人脸数据的13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1636436864000', + ], + 'FacePicList' => [ + 'description' => '用户的人脸图片信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceUrl' => [ + 'description' => '用户的人脸图片URL地址。', + 'type' => 'string', + 'example' => 'https://example.com/test.jpeg', + ], + 'FaceMd5' => [ + 'description' => '用户人脸图片的MD5值。 ', + 'type' => 'string', + 'example' => 'TestFaceMd5', + ], + 'FeatureDTOList' => [ + 'description' => '人脸特征值列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AlgorithmName' => [ + 'description' => '算法名。', + 'type' => 'string', + 'example' => 'TestAlgorithmName', + ], + 'AlgorithmVersion' => [ + 'description' => '算法版本。', + 'type' => 'string', + 'example' => 'TestAlgorithmVersion', + ], + 'AlgorithmProvider' => [ + 'description' => '算法提供者。', + 'type' => 'string', + 'example' => 'TestAlgorithmProvider', + ], + 'ErrorMessage' => [ + 'description' => '算法执行出错时，返回的错误信息。', + 'type' => 'string', + 'example' => 'parameter error', + ], + 'ErrorCode' => [ + 'description' => '算法返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'FaceMd5' => [ + 'description' => '人脸特征的MD5值。', + 'type' => 'string', + 'example' => 'TestFaceMd5', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"face user not exist\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Params\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"CustomUserId\\": \\"1234567890\\",\\n \\"CreateTime\\": 1636427314000,\\n \\"UserId\\": \\"3mtjaqebeq4d****\\",\\n \\"Name\\": \\"Tony\\",\\n \\"ModifyTime\\": 1636436864000,\\n \\"FacePicList\\": [\\n {\\n \\"FaceUrl\\": \\"https://example.com/test.jpeg\\",\\n \\"FaceMd5\\": \\"TestFaceMd5\\",\\n \\"FeatureDTOList\\": [\\n {\\n \\"AlgorithmName\\": \\"TestAlgorithmName\\",\\n \\"AlgorithmVersion\\": \\"TestAlgorithmVersion\\",\\n \\"AlgorithmProvider\\": \\"TestAlgorithmProvider\\",\\n \\"ErrorMessage\\": \\"parameter error\\",\\n \\"ErrorCode\\": \\"200\\",\\n \\"FaceMd5\\": \\"TestFaceMd5\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryFaceUserBatchResponse>\\n<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <ModifyTime>1636436864000</ModifyTime>\\n <UserId>3mtjaqebeq4d****</UserId>\\n <CreateTime>1636427314000</CreateTime>\\n <Params>{\\"key1\\":\\"value1\\", \\"key2\\":\\"value2\\"}</Params>\\n <CustomUserId>63f45472c2bf4cfa98b56****49238fa</CustomUserId>\\n <Name>Tony</Name>\\n <FacePicList>\\n <FaceMd5>TestFaceMd5</FaceMd5>\\n <FaceUrl>https://example.com/test.jpeg</FaceUrl>\\n <FeatureDTOList>\\n <AlgorithmVersion>TestAlgorithmVersion</AlgorithmVersion>\\n <ErrorCode>200</ErrorCode>\\n <AlgorithmProvider>TestAlgorithmProvider</AlgorithmProvider>\\n <FaceMd5>TestFaceMd5</FaceMd5>\\n <AlgorithmName>TestAlgorithmName</AlgorithmName>\\n </FeatureDTOList>\\n </FacePicList>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryFaceUserBatchResponse>","errorExample":""}]', + 'title' => 'QueryFaceUserBatch', + 'summary' => '根据用户ID列表批量获取用户信息。', + 'description' => '## 使用说明'."\n" + ."\n" + .'- 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + ."\n" + .' > RAM用户共享阿里云账号配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~288312~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryFaceUserByName' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务隔离ID，用于隔离同一个阿里云账号下不同业务应用之间的数据。请与调用[AddFaceUser](~~288338~~)接口添加用户时设置的**IsolationId**保持一致。', + 'type' => 'string', + 'required' => true, + 'example' => 'ZheJiangHZ', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名。支持中文、英文字母大小写、数字、下划线（_）和短划线（-），长度不超过64个字符。'."\n" + ."\n" + .'支持模糊匹配，若不填，则为全量匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'Tony', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'description' => '用户参数，请自定义。'."\n" + ."\n" + .'支持匹配搜索，但不支持模糊匹配。', + 'type' => 'string', + 'required' => false, + 'example' => '{"key1":"value1", "key2":"value2"}', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '返回结果中，每页显示的记录数量。最大取值50，最小取值1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。最小取值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1000000', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'face user not exist', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'Page' => [ + 'description' => '当前页面号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'List' => [ + 'description' => '调用成功时，返回的人脸信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Params' => [ + 'description' => '自定义的用户参数。', + 'type' => 'string', + 'example' => '{"key1":"value1", "key2":"value2"}', + ], + 'CustomUserId' => [ + 'description' => '用户身份识别ID。', + 'type' => 'string', + 'example' => '1234567890', + ], + 'CreateTime' => [ + 'description' => '创建人脸数据的的13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1636427314000', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '3mtjaqebeq4d****', + ], + 'Name' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'Tony', + ], + 'ModifyTime' => [ + 'description' => '最后一次修改人脸数据的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1636436864000', + ], + 'FacePicList' => [ + 'description' => '用户的人脸图片信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceUrl' => [ + 'description' => '用户的人脸图片URL地址。', + 'type' => 'string', + 'example' => 'https://example.com/test.jpeg', + ], + 'FaceMd5' => [ + 'description' => '用户人脸图片的MD5值。', + 'type' => 'string', + 'example' => 'TestFaceMd5', + ], + 'FeatureDTOList' => [ + 'description' => '人脸特征值列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AlgorithmName' => [ + 'description' => '算法名。', + 'type' => 'string', + 'example' => 'TestAlgorithmName', + ], + 'AlgorithmVersion' => [ + 'description' => '算法版本。', + 'type' => 'string', + 'example' => 'TestAlgorithmVersion', + ], + 'AlgorithmProvider' => [ + 'description' => '算法提供者。', + 'type' => 'string', + 'example' => 'TestAlgorithmProvider', + ], + 'ErrorMessage' => [ + 'description' => '算法执行出错时，返回的错误信息。', + 'type' => 'string', + 'example' => 'parameter error', + ], + 'ErrorCode' => [ + 'description' => '算法返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'FaceMd5' => [ + 'description' => '人脸特征的MD5值。', + 'type' => 'string', + 'example' => 'TestFaceMd5', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Forbidden.RiskControl', + 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"face user not exist\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 15,\\n \\"Total\\": 8,\\n \\"Page\\": 1,\\n \\"List\\": [\\n {\\n \\"Params\\": \\"{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}\\",\\n \\"CustomUserId\\": \\"1234567890\\",\\n \\"CreateTime\\": 1636427314000,\\n \\"UserId\\": \\"3mtjaqebeq4d****\\",\\n \\"Name\\": \\"Tony\\",\\n \\"ModifyTime\\": 1636436864000,\\n \\"FacePicList\\": [\\n {\\n \\"FaceUrl\\": \\"https://example.com/test.jpeg\\",\\n \\"FaceMd5\\": \\"TestFaceMd5\\",\\n \\"FeatureDTOList\\": [\\n {\\n \\"AlgorithmName\\": \\"TestAlgorithmName\\",\\n \\"AlgorithmVersion\\": \\"TestAlgorithmVersion\\",\\n \\"AlgorithmProvider\\": \\"TestAlgorithmProvider\\",\\n \\"ErrorMessage\\": \\"parameter error\\",\\n \\"ErrorCode\\": \\"200\\",\\n \\"FaceMd5\\": \\"TestFaceMd5\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryFaceUserByNameResponse>\\n<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <PageSize>15</PageSize>\\n <Total>1</Total>\\n <Page>1</Page>\\n <List>\\n <ModifyTime>1636436864000</ModifyTime>\\n <UserId>3mtjaqebeq4d****</UserId>\\n <CreateTime>1636427314000</CreateTime>\\n <Params>{\\"key1\\":\\"value1\\", \\"key2\\":\\"value2\\"}</Params>\\n <CustomUserId>1234567890</CustomUserId>\\n <Name>Tony</Name>\\n <FacePicList>\\n <FaceMd5>TestFaceMd5</FaceMd5>\\n <FaceUrl>https://example.com/test.jpeg</FaceUrl>\\n <FeatureDTOList>\\n <AlgorithmVersion>TestAlgorithmVersion</AlgorithmVersion>\\n <ErrorCode>200</ErrorCode>\\n <AlgorithmProvider>TestAlgorithmProvider</AlgorithmProvider>\\n <FaceMd5>TestFaceMd5</FaceMd5>\\n <AlgorithmName>TestAlgorithmName</AlgorithmName>\\n </FeatureDTOList>\\n </FacePicList>\\n </List>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryFaceUserByNameResponse>","errorExample":""}]', + 'title' => ' 通过人脸名称查找人脸数据', + 'summary' => '通过人脸名称查找人脸数据。', + 'description' => '## 使用说明'."\n" + ."\n" + .'- 单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为100。'."\n" + ."\n" + .' > RAM用户共享阿里云账号配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~288312~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteRecord' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'FileNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '待删除的录像文件名列表。录像文件名可使用[QueryRecord](~~107922~~)获取。'."\n" + ."\n" + .'> 单次最多支持删除50个的录像文件。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + 'example' => 'file1', + 'maxItems' => 50, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-060a****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应信息。', + 'type' => 'object', + 'properties' => [ + 'DeletedCount' => [ + 'description' => '成功删除的录像文件数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"tenant auth error.\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DeletedCount\\": 3\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeleteRecordResponse>\\n<RequestId>0A13279A-5640-45E7-87AA-83750541AD0E</RequestId>\\n<Data>\\n <DeletedCount>3</DeletedCount>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</DeleteRecordResponse>","errorExample":""}]', + 'title' => '删除云端存储的录像文件', + 'summary' => '删除云端存储的录像文件。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRecordUrlByTime' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。'."\n" + ."\n" + .'您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。若有ID值，必须传入该ID值，否则调用会失败。'."\n" + ."\n" + .'> 如果公共实例没有ID值，请参见[如何获取实例ID](~~267533~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-060a****', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型：'."\n" + ."\n" + .'- **0**（默认）：主码流'."\n" + .'- **1**：辅码流', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询范围起始时间，格式为10位时间戳，单位为秒。'."\n" + ."\n" + .'最小取值为0，最大取值为2147483647。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => '1638675381', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询范围结束时间，格式为10位时间戳，单位为秒。'."\n" + ."\n" + .'最小取值为0，最大取值为2147483647。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => '1638866820', + ], + ], + [ + 'name' => 'UrlValidDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'URL有效期，取值范围为10~3600，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '3600', + 'minimum' => '10', + 'example' => '200', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '录像文件的URL。URL包含鉴权信息，且无法重复使用。'."\n" + ."\n" + .'录像文件的URL对应指定时间范围内所有的录像文件，将所有录像文件合并播放。'."\n", + 'type' => 'string', + 'example' => 'https://linkvisual.aliyun.com/ddsffa****.m3u8', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'tenant auth error', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"https://linkvisual.aliyun.com/ddsffa****.m3u8\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordUrlByTimeResponse>\\n<RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n<Data>https://linkvisual.aliyun.com/ddsffa****.m3u8</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryRecordUrlByTimeResponse>","errorExample":""}]', + 'title' => 'QueryRecordUrlByTime', + 'summary' => '获取指定时间范围内的录像文件的播放URL。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryCarProcessEvents' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iotx-oxsshare****', + ], + ], + [ + 'name' => 'SubIotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'ImP6ECd1aQ****CAfWTO000101', + ], + ], + [ + 'name' => 'SubProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1Duh0F****', + ], + ], + [ + 'name' => 'SubDeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'car_test', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询范围起始时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '10000000000000', + 'minimum' => '0', + 'example' => '1646288487368', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询范围结束时间，格式为13位时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '10000000000000', + 'minimum' => '0', + 'example' => '1646288488368', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。页数从1开始排序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '10000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。最小值为1，最大值为20，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + ], + ], + [ + 'name' => 'PlateNo', + 'in' => 'query', + 'schema' => [ + 'description' => '车牌号码。最大支持输入15个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '浙AM****', + ], + ], + [ + 'name' => 'ActionType', + 'in' => 'query', + 'schema' => [ + 'description' => '车辆的动作类型，包含以下三种类型：'."\n" + ."\n" + .'- **1**：进入'."\n" + .'- **2**：停留'."\n" + .'- **3**：离开', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'AreaIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的检测框。您可调用[InvokeThingService](~~69584~~)查询检测框数量。其中**identifier**设置为**QueryAlgoTaskDetails**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '0', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~288314~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Specified access key is not found.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '8B8E77F0-7713-0139-A3D6-93482A025D45', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '车辆识别事件总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'PageCount' => [ + 'description' => '总页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageData' => [ + 'description' => '返回的智能告警事件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventPicUrl' => [ + 'description' => '智能告警事件照片URL地址。', + 'type' => 'string', + 'example' => 'https://example.com/test.jpg', + ], + 'EventTime' => [ + 'description' => '事件发生的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1646288428361', + ], + 'ActionType' => [ + 'description' => '车辆的动作类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Confidence' => [ + 'description' => '识别是车辆的自信度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '63', + ], + 'SubProductKey' => [ + 'description' => 'IPC设备的ProductKey。', + 'type' => 'string', + 'example' => 'a1Duh0F****', + ], + 'EventId' => [ + 'description' => '智能告警事件ID。', + 'type' => 'string', + 'example' => 'dailyb3d6658d9****', + ], + 'SubIotId' => [ + 'description' => 'IPC设备的设备ID。', + 'type' => 'string', + 'example' => 'ImP6ECd1aQxio9CAfWTO****', + ], + 'AreaIndex' => [ + 'description' => 'IPC设备识别检测框的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'EventType' => [ + 'description' => '智能告警事件类型：'."\n" + ."\n" + .'- 设置为全部智能告警事件：0。'."\n" + .'- 设置为多个智能告警事件：输入智能告警事件对应的序号，并用英文逗号（,）分隔，例如：`10001,10002`。'."\n" + .'>设置多个智能告警事件时，单次最多支持设置10个。'."\n" + ."\n" + .'请在物联网平台控制台，**产品详情**页面的**功能定义**页签，查看全部智能告警事件类型。详细信息，请参考[查看智能告警事件类型](~~207701~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10005', + ], + 'EventPicId' => [ + 'description' => '智能告警事件照片ID。', + 'type' => 'string', + 'example' => 'SU5LT2pXaUM4MV****Nzg', + ], + 'TaskId' => [ + 'description' => '车辆检测事件的任务ID。', + 'type' => 'string', + 'example' => 'daily55617e7653354490938d****', + ], + 'SubDeviceName' => [ + 'description' => 'IPC设备的DeviceName。', + 'type' => 'string', + 'example' => 'car_test', + ], + 'IotId' => [ + 'description' => 'V系列边缘一体机的设备IotId。', + 'type' => 'string', + 'example' => 'gl9kLgp0UsPSCcIM8EAY00****', + ], + 'SubDeviceNickName' => [ + 'description' => 'IPC设备的DeviceNickName。', + 'type' => 'string', + 'example' => '测试车辆', + ], + 'PlateNo' => [ + 'description' => '车牌号。', + 'type' => 'string', + 'example' => '浙A6****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.lv.requestError', + 'errorMessage' => 'Request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + [ + 'errorCode' => 'iot.lv.requestTimeError', + 'errorMessage' => 'Request time error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Specified access key is not found.\\",\\n \\"RequestId\\": \\"8B8E77F0-7713-0139-A3D6-93482A025D45\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 50,\\n \\"PageCount\\": 1,\\n \\"PageData\\": [\\n {\\n \\"EventPicUrl\\": \\"https://example.com/test.jpg\\",\\n \\"EventTime\\": 1646288428361,\\n \\"ActionType\\": 1,\\n \\"Confidence\\": 63,\\n \\"SubProductKey\\": \\"a1Duh0F****\\",\\n \\"EventId\\": \\"dailyb3d6658d9****\\",\\n \\"SubIotId\\": \\"ImP6ECd1aQxio9CAfWTO****\\",\\n \\"AreaIndex\\": 0,\\n \\"EventType\\": 10005,\\n \\"EventPicId\\": \\"SU5LT2pXaUM4MV****Nzg\\",\\n \\"TaskId\\": \\"daily55617e7653354490938d****\\",\\n \\"SubDeviceName\\": \\"car_test\\",\\n \\"IotId\\": \\"gl9kLgp0UsPSCcIM8EAY00****\\",\\n \\"SubDeviceNickName\\": \\"测试车辆\\",\\n \\"PlateNo\\": \\"浙A6****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryCarProcessEventsResponse>\\n<RequestId>8B8E77F0-7713-0139-A3D6-93482A025D45</RequestId>\\n<Data>\\n <PageSize>10</PageSize>\\n <PageCount>1</PageCount>\\n <CurrentPage>1</CurrentPage>\\n <Total>50</Total>\\n <PageData>\\n <TaskId>daily55617e7653354490938d****</TaskId>\\n <ActionType>1</ActionType>\\n <EventType>10005</EventType>\\n <SubIotId>ImP6ECd1aQxio9CAfWTO****</SubIotId>\\n <SubDeviceNickName>测试车辆</SubDeviceNickName>\\n <EventPicId>SU5LT2pXaUM4MV****Nzg</EventPicId>\\n <IotId>gl9kLgp0UsPSCcIM8EAY00****</IotId>\\n <EventPicUrl>https://example.com/test.jpg</EventPicUrl>\\n <Confidence>63</Confidence>\\n <SubProductKey>a1Duh0F****</SubProductKey>\\n <EventTime>1646288428361</EventTime>\\n <SubDeviceName>car_test</SubDeviceName>\\n <EventId>dailyb3d6658d9****</EventId>\\n <AreaIndex>0</AreaIndex>\\n <PlateNo>浙A6****</PlateNo>\\n </PageData>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryCarProcessEventsResponse>","errorExample":""}]', + 'title' => 'QueryCarProcessEvents', + 'summary' => '调用该接口查询车辆作业的智能告警事件列表。', + 'description' => '## 使用说明'."\n" + .'单个阿里云账号调用改接口的每秒请求数（QOS）最大限制为10。 '."\n" + .'> RAM用户共享阿里云账号配额。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~288312~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeletePicture' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PictureIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '图片ID列表。图片ID由调用[TriggerCapturePicture](~~107914~~)时生成。'."\n" + ."\n" + .'> 单次调用最多支持输入50个图片ID。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => true, + 'example' => 'cFc5MzZ****npYT1***TDFzX1hrVzA0Z****', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPC设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> 如果传入该参数，则无需传入**ProductKey**和**DeviceName**。**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**的组合是一一对应的关系。如果您同时传入**IotId**和**ProductKey**与**DeviceName**的组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '1CJ0****e7qiq8VkQi1000000', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'iot-cn-n6w1y******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'request forbidden', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '响应结果。', + 'type' => 'object', + 'properties' => [ + 'DeletedCount' => [ + 'description' => '成功删除的云端图片数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.lv.requestError', + 'errorMessage' => 'Request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"request forbidden\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DeletedCount\\": 3\\n }\\n}","errorExample":""},{"type":"xml","example":"<DeletePictureResponse>\\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n <Data>\\n <DeletedCount>3</DeletedCount>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeletePictureResponse>","errorExample":""}]', + 'title' => 'DeletePicture', + 'summary' => '调用该接口，批量删除指定IPC设备下指定图片ID的云端图片。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateInstanceInternetProtocol' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页面，查看当前实例的**ID**。'."\n" + ."\n" + .'><notice>'."\n" + .'- 若有ID值，必须传入该ID值，否则调用会失败。'."\n" + .'- 若无<props="intl"><ph>**实例概览**页面或</ph></props>ID值，则无需传入。'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'实例的更多信息，请参见[实例概述](~~356505~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP协议版本：'."\n" + .'- IPv4（默认）'."\n" + .'- IPv6'."\n" + ."\n" + .'> 当IP协议版本设置为IPv6，流媒体相关地址会修改为IPv4/IPv6双栈地址，请确保您的设备和应用端已完成IPv6相关设置，否则会出现播放画面加载失败等异常情况。', + 'type' => 'string', + 'required' => true, + 'example' => 'IPv4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '响应结果。', + 'type' => 'object', + 'example' => '无', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'InvalidParameter', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.lv.requestError', + 'errorMessage' => 'Request error', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ErrorMessage\\": \\"InvalidParameter\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateInstanceInternetProtocolResponse>\\n <RequestId>06DC77A0-4622-42DB-9EE0-25FIOHS82JK1</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdateInstanceInternetProtocolResponse>","errorExample":""}]', + 'title' => 'UpdateInstanceInternetProtocol', + 'summary' => '调用该接口设置实例支持的IP协议版本。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateRecordDownloadByTimeJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页签，查看当前实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'iot-******', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '视频设备所属产品的**ProductKey**。'."\n" + ."\n" + .'您可以在[物联网平台控制台](https://iot.console.aliyun.com/product)的**产品**页面或调用[QueryProductList](~~69271~~)接口，查看当前实例下所有产品的信息。'."\n" + ."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1Bw******', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '视频设备的设备名称。您可以在[物联网平台控制台](https://iot.console.aliyun.com/devices)的**设备**页面，或调用[QueryDevice](~~69905~~)接口查看指定产品下设备的**DeviceName**。'."\n" + ."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'Device01', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型。可选：'."\n" + ."\n" + .'- **0**（默认）：主码流。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，格式为10位的时间戳，单位为秒。取值范围0~2147483647。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2147483648', + 'minimum' => '0', + 'example' => '1900000000', + ], + ], + [ + 'name' => 'RecordType', + 'in' => 'query', + 'schema' => [ + 'description' => '录像类型。可选：'."\n" + ."\n" + .'- **0**：连续录像。'."\n" + .'- **1**：事件录像。'."\n" + .'- **2**：主动录像。'."\n" + .'- **4**：本地上云录像。'."\n" + .'- **为空**：表示全部录像。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频设备的设备ID。可调用[QueryDeviceDetail](~~69594~~)接口查询。'."\n" + ."\n" + .'><notice> **IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**组合是一一对应的关系。如果传入该参数，则无需传入**ProductKey**和**DeviceName**。如果您同时传入**IotId**和**ProductKey**与**DeviceName**组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，格式为10位的时间戳，单位为秒。取值范围为0~2147483647，必须大于开始时间**BeginTime**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '9999999999999', + 'minimum' => '0', + 'example' => '2100000000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用结果状态码：'."\n" + ."\n" + .'- 调用成功，返回200。'."\n" + .'- 调用失败，返回错误码。详细信息，请参见下文**错误码**。', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Record not exist.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E55***B7-4***-4***-8***-D3******F565', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'w2s******', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RecordNotExist', + 'errorMessage' => 'Record not exist.', + ], + [ + 'errorCode' => 'iot.vision.DownloadJobError', + 'errorMessage' => 'Download job error.', + ], + [ + 'errorCode' => 'iot.vision.ConcurrencyExceedLimit', + 'errorMessage' => 'Concurrency exceed the limit.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Record not exist.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"w2s******\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateRecordDownloadByTimeJobResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <JobId>w2s******</JobId>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</CreateRecordDownloadByTimeJobResponse>","errorExample":""}]', + 'title' => 'CreateRecordDownloadByTimeJob', + 'summary' => '调用该接口创建按时间下载云端录像的任务。', + 'description' => '## 使用限制'."\n" + ."\n" + .'- 单次按时间下载时长限制：30分钟。'."\n" + .'- 下载时间精度： 下载时间范围精度在10秒内。例如截取选择下载20秒数据， 可能会出现最多下载了30秒数据的情况。'."\n" + .'- 单次按时间下载录像文件数量限制：100。'."\n" + .'- 下载任务和文件最多保存时长为1天, 超时后可重新下载。'."\n" + .'- 单实例最多同时支持下载并发限制为10路（下载完成不计入）。'."\n" + .'- 若音视频编码参数发生改变，默认下载的录像为前半段录像。'."\n" + .'- 若下载录像时间存在重叠，云端会对数据重叠部分去重。'."\n" + ."\n\n" + .'## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRecordDownloadJobById' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页签，查看当前实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'Iot-r******', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '云端录像下载任务的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'w2s******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用结果状态码：'."\n" + ."\n" + .'- 调用成功，返回200。'."\n" + .'- 调用失败，返回错误码。详细信息，请参见下文**错误码**。', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Request failed.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E55***B7-4***-4***-8***-D3******F565', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '录像文件的生成状态。'."\n" + ."\n" + .'- **-1**：录像文件生成异常。'."\n" + .'- **0**：录像文件已生成完毕。'."\n" + .'- **1**：录像文件正在生成中。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'EndTime' => [ + 'description' => '查询范围结束时间，格式为10位时间戳，单位为秒。 取值范围为0~2147483647。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2100000000', + ], + 'Type' => [ + 'description' => '下载类型。'."\n" + ."\n" + .'- **1**：按文件下载。'."\n" + .'- **2**：设备云端录像按时间范围下载。'."\n" + .'- **3**：设备本地录像按时间范围下载。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Progress' => [ + 'description' => '录像文件生成进度，范围为0~100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'RecordType' => [ + 'description' => '录像类型。'."\n" + ."\n" + .'- **0**：连续录像。'."\n" + .'- **1**：事件录像。'."\n" + .'- **2**：主动录像。'."\n" + .'- **4**：本地上云录像。'."\n" + .'- **99**：混合类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'StreamType' => [ + 'description' => '码流类型。'."\n" + ."\n" + .'- **0**：主码流。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BeginTime' => [ + 'description' => '查询范围起始时间，格式为10位的时间戳，单位为秒。取值范围为0~2147483647。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1900000000', + ], + 'Url' => [ + 'description' => '云端录像下载地址，有效期为1小时。', + 'type' => 'string', + 'example' => 'http://*********', + ], + 'JobErrorCode' => [ + 'description' => '任务异常原因，当**Status**为**-1**时返回异常信息：'."\n" + ."\n" + .'- **9441**：网络异常。'."\n" + .'- **9442**：音视频数据错误。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9441', + ], + 'FileName' => [ + 'description' => '文件名，**Type**为1时，显示该参数。', + 'type' => 'string', + 'example' => 'testfile', + ], + 'IotId' => [ + 'description' => '设备ID。', + 'type' => 'string', + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.JobNotExist', + 'errorMessage' => 'Job not exist or expired.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request failed.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": -1,\\n \\"EndTime\\": 2100000000,\\n \\"Type\\": 1,\\n \\"Progress\\": 90,\\n \\"RecordType\\": 0,\\n \\"StreamType\\": 0,\\n \\"BeginTime\\": 1900000000,\\n \\"Url\\": \\"http://*********\\",\\n \\"JobErrorCode\\": 9441,\\n \\"FileName\\": \\"testfile\\",\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordDownloadJobByIdResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <Status>-1</Status>\\n <IotId>C47T6xwp6ms4bNlkHRWCg4****</IotId>\\n <StreamType>0</StreamType>\\n <Progress>90</Progress>\\n <Type>1</Type>\\n <RecordType>0</RecordType>\\n <EndTime>2100000000</EndTime>\\n <JobErrorCode>9441</JobErrorCode>\\n <FileName>testfile</FileName>\\n <BeginTime>1900000000</BeginTime>\\n <Url>http://*********</Url>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryRecordDownloadJobByIdResponse>","errorExample":""}]', + 'title' => 'QueryRecordDownloadJobById', + 'summary' => '调用该接口按任务ID查询云端录像下载任务的详细信息，包括起始时间、录像进度、录像类型和下载地址等。', + 'description' => '## 使用限制'."\n" + ."\n" + .'获取到的录像下载地址有效期为1小时。'."\n" + ."\n" + .'## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryRecordDownloadJobList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页签，查看当前实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'iot-2w******', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回结果中每页显示的设备数量，最大值是50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '视频设备所属产品的**ProductKey**。'."\n" + ."\n" + .'您可以在[物联网平台控制台](https://iot.console.aliyun.com/product)的**产品**页面或调用[QueryProductList](~~69271~~)接口，查看当前实例下所有产品的信息。'."\n" + ."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1Bw******', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '视频设备的设备名称。您可以在[物联网平台控制台](https://iot.console.aliyun.com/devices)的**设备**页面，或调用[QueryDevice](~~69905~~)接口查看指定产品下设备的**DeviceName**。'."\n" + ."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'Device01', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频设备的设备ID。可调用[QueryDeviceDetail](~~69594~~)接口查询。'."\n" + ."\n" + .'><notice> **IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**组合是一一对应的关系。如果传入该参数，则无需传入**ProductKey**和**DeviceName**。如果您同时传入**IotId**和**ProductKey**与**DeviceName**组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定从返回结果中的第几页开始显示。默认页数从1开始排序。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用结果状态码：'."\n" + ."\n" + .'- 调用成功，返回200。'."\n" + .'- 调用失败，返回错误码。详细信息，请参见下文**错误码**。', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'iot.vision.RequestFailed', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E55***B7-4***-4***-8***-D3******F565', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功后，返回的任务列表。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '任务总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'JobList' => [ + 'description' => '云端录像下载任务的详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '录像文件的生成状态。'."\n" + ."\n" + .'- **-1**：录像文件生成异常。'."\n" + .'- **0**：录像文件已生成完毕。'."\n" + .'- **1**：录像文件正在生成中。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '-1', + ], + 'Type' => [ + 'description' => '下载类型。'."\n" + ."\n" + .'- **1**：按文件下载。'."\n" + .'- **2**：设备云端录像按时间范围下载。'."\n" + .'- **3**：设备本地录像按时间范围下载。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Progress' => [ + 'description' => '录像文件生成进度，范围为0~100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'RecordType' => [ + 'description' => '录像类型。'."\n" + ."\n" + .'- **0**：连续录像。'."\n" + .'- **1**：事件录像。'."\n" + .'- **2**：主动录像。'."\n" + .'- **4**：本地上云录像。'."\n" + .'- **99**：混合类型。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'BeginTime' => [ + 'description' => '查询范围起始时间，格式为10位的时间戳，单位为秒。取值范围为0~2147483647。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1900000000', + ], + 'Url' => [ + 'description' => '云端录像下载地址，有效期为1小时。', + 'type' => 'string', + 'example' => 'http://*********', + ], + 'FileName' => [ + 'description' => '文件名，**Type**为1时，显示该参数。', + 'type' => 'string', + 'example' => 'testfile', + ], + 'EndTime' => [ + 'description' => '查询范围结束时间，格式为10位时间戳，单位为秒。 取值范围为0~2147483647。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2100000000', + ], + 'StreamType' => [ + 'description' => '码流类型。'."\n" + ."\n" + .'- **0**：主码流。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'w2s******', + ], + 'JobErrorCode' => [ + 'description' => '任务异常原因，当**Status**为**-1**时返回异常信息：'."\n" + ."\n" + .'- **9441**：网络异常。'."\n" + .'- **9442**：音视频数据错误。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9441', + ], + 'IotId' => [ + 'description' => '设备ID。', + 'type' => 'string', + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestFailed', + 'errorMessage' => 'Request failed.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"iot.vision.RequestFailed\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Total\\": 1,\\n \\"JobList\\": [\\n {\\n \\"Status\\": -1,\\n \\"Type\\": 1,\\n \\"Progress\\": 90,\\n \\"RecordType\\": 0,\\n \\"BeginTime\\": 1900000000,\\n \\"Url\\": \\"http://*********\\",\\n \\"FileName\\": \\"testfile\\",\\n \\"EndTime\\": 2100000000,\\n \\"StreamType\\": 0,\\n \\"JobId\\": \\"w2s******\\",\\n \\"JobErrorCode\\": 9441,\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordDownloadJobListResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <Total>1</Total>\\n <JobList>\\n <Status>-1</Status>\\n <IotId>C47T6xwp6ms4bNlkHRWCg4****</IotId>\\n <StreamType>0</StreamType>\\n <Type>1</Type>\\n <Progress>90</Progress>\\n <RecordType>0</RecordType>\\n <EndTime>2100000000</EndTime>\\n <FileName>testfile</FileName>\\n <JobErrorCode>9441</JobErrorCode>\\n <BeginTime>1900000000</BeginTime>\\n <JobId>w2s******</JobId>\\n <Url>http://*********</Url>\\n </JobList>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryRecordDownloadJobListResponse>","errorExample":""}]', + 'title' => 'QueryRecordDownloadJobList', + 'summary' => '调用该接口查询云端录像下载任务的列表。', + 'description' => '## 使用限制'."\n" + ."\n" + .'获取到的录像下载地址有效期为1小时。'."\n" + ."\n" + .'## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => ' 调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateLocalRecordDownloadByTimeJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页签，查看当前实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'iot-******', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '视频设备所属产品的**ProductKey**。'."\n" + ."\n" + .'您可以在物联网平台控制台的**产品**页面或调用[QueryProductList](~~69271~~)接口，查看当前实例下所有产品的信息。'."\n" + ."\n" + .'><notice>如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1Bw******', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '视频设备的设备名称。您可以在物联网平台控制台的**设备**页面，或调用[QueryDevice](~~69905~~)接口查看指定产品下设备的**DeviceName**。'."\n" + ."\n\n" + .'><notice>如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'Device01', + ], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => [ + 'description' => '设备上传倍速。 默认值**1.0**，取值范围为**0.125**~**8.0**。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1.0', + 'default' => '1.0', + ], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，格式为10位的时间戳，单位为秒。取值范围0~2147483647。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2147483648', + 'minimum' => '0', + 'example' => '1900000000', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => '视频设备的设备ID。可调用[QueryDeviceDetail](~~69594~~)接口查询。'."\n" + ."\n" + .'><notice>'."\n" + .'**IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**组合是一一对应的关系。如果传入该参数，则无需传入**ProductKey**和**DeviceName**。如果您同时传入**IotId**和**ProductKey**与**DeviceName**组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，格式为10位的时间戳，单位为秒。取值范围为0~2147483647，必须大于开始时间**BeginTime**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '9999999999999', + 'minimum' => '0', + 'example' => '2100000000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '调用结果状态码：'."\n" + ."\n" + .'- 调用成功，返回200。'."\n" + .'- 调用失败，返回错误码。详细信息，请参见下文**错误码**。', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Download job error.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E55***B7-4***-4***-8***-D3******F565', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'w2s******', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.DownloadJobError', + 'errorMessage' => 'Download job error.', + ], + [ + 'errorCode' => 'iot.vision.ConcurrencyExceedLimit', + 'errorMessage' => 'Concurrency exceed the limit.', + ], + [ + 'errorCode' => 'iot.vision.StreamPushFailed', + 'errorMessage' => 'Stream push failed.', + ], + [ + 'errorCode' => 'iot.vision.DeviceOffline', + 'errorMessage' => 'Device is offline.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Download job error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"w2s******\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateLocalRecordDownloadByTimeJobResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <JobId>w2s******</JobId>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</CreateLocalRecordDownloadByTimeJobResponse>","errorExample":""}]', + 'title' => 'CreateLocalRecordDownloadByTimeJob', + 'summary' => '调用该接口创建按时间下载本地录像的任务。', + 'description' => '## 使用限制'."\n" + ."\n" + .'- 单次按时间下载时长限制：30分钟。'."\n" + .'- 下载任务和文件最多保存时长为1天, 超时后可重新下载。'."\n" + .'- 单实例最多同时支持下载并发限制为10路（下载完成不计入）。'."\n" + .'- 若音视频编码参数发生变化，默认下载的录像为前半段录像。'."\n" + .'- 由于设备上行网络波动可能引起链路异常断开或者设备主动丢数据，上传和下载的录像可能为不完整的录像文件。'."\n" + .'- 下载的录像数据由设备推流逻辑实现决定，若推流数据异常可能出现下载录像时长与任务设置时间段不一致的情况。'."\n" + ."\n" + .'## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BatchQueryVisionDeviceInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DeviceNameList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'IotIdList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceInfoList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'type' => 'string', + ], + 'DeviceType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'IotId' => [ + 'type' => 'string', + ], + 'GbDeviceInfo' => [ + 'type' => 'object', + 'properties' => [ + 'GbId' => [ + 'type' => 'string', + ], + 'Password' => [ + 'type' => 'string', + ], + 'NickName' => [ + 'type' => 'string', + ], + 'SubProductKey' => [ + 'type' => 'string', + ], + 'DeviceProtocol' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'NetProtocol' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'RtmpDeviceInfo' => [ + 'type' => 'object', + 'properties' => [ + 'StreamStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PushKeyExpireTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'StreamName' => [ + 'type' => 'string', + ], + 'PushAuthKey' => [ + 'type' => 'string', + ], + 'PullAuthKey' => [ + 'type' => 'string', + ], + 'PullKeyExpireTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PushUrlSample' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParameterError', + 'errorMessage' => 'Request parameter error:%s', + ], + [ + 'errorCode' => 'iot.vision.RequestError', + 'errorMessage' => 'Request error.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + ], + 'CreateRtmpDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PullKeyExpireTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '3600', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'PushKeyExpireTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '3600', + ], + ], + [ + 'name' => 'PushAuthKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PullAuthKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'SubStreamName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceName' => [ + 'type' => 'string', + ], + 'StreamName' => [ + 'type' => 'string', + ], + 'IotId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParameterError', + 'errorMessage' => 'Request parameter error:%s', + ], + [ + 'errorCode' => 'iot.vision.DeviceNameDuplicate', + 'errorMessage' => 'Device name duplicate.', + ], + [ + 'errorCode' => 'iot.vision.StreamNameDuplicate', + 'errorMessage' => 'Stream name duplicate.', + ], + [ + 'errorCode' => 'iot.vision.RequestError', + 'errorMessage' => 'Request error.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + ], + 'DeleteRtmpDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParameterError', + 'errorMessage' => 'Request parameter error:%s', + ], + [ + 'errorCode' => 'iot.vision.RequestError', + 'errorMessage' => 'Request error.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + ], + 'DeleteRtmpKey' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1', + 'minimum' => '0', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParameterError', + 'errorMessage' => 'Request parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + ], + 'QueryRtmpKey' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'PullAuthKey' => [ + 'type' => 'string', + ], + 'PullKeyExpireTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PushKeyExpireTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'StreamName' => [ + 'type' => 'string', + ], + 'PushAuthKey' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParameterError', + 'errorMessage' => 'Request parameter error:%s', + ], + [ + 'errorCode' => 'iot.vision.RtmpKeyNotSet', + 'errorMessage' => 'Rtmp key not set.', + ], + [ + 'errorCode' => 'iot.vision.RequestError', + 'errorMessage' => 'Request error.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + ], + 'QueryVisionDeviceInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'type' => 'string', + ], + 'DeviceType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'GbDeviceInfo' => [ + 'type' => 'object', + 'properties' => [ + 'GbId' => [ + 'type' => 'string', + ], + 'Password' => [ + 'type' => 'string', + ], + 'NickName' => [ + 'type' => 'string', + ], + 'SubProductKey' => [ + 'type' => 'string', + ], + 'DeviceProtocol' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'NetProtocol' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'RtmpDeviceInfo' => [ + 'type' => 'object', + 'properties' => [ + 'StreamStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PushKeyExpireTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'StreamName' => [ + 'type' => 'string', + ], + 'PushAuthKey' => [ + 'type' => 'string', + ], + 'PullAuthKey' => [ + 'type' => 'string', + ], + 'PullKeyExpireTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PushUrlSample' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParameterError', + 'errorMessage' => 'Request parameter error:%s', + ], + [ + 'errorCode' => 'iot.vision.RequestError', + 'errorMessage' => 'Request error.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + ], + 'UpdateRtmpKey' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PullKeyExpireTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'PushKeyExpireTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'PushAuthKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PullAuthKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParameterError', + 'errorMessage' => 'Request parameter error:%s', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + ], + 'CreateGbDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'GbId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'DeviceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'default' => '1', + ], + ], + [ + 'name' => 'SubProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MediaNetProtocol', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceName' => [ + 'type' => 'string', + ], + 'IotId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.common.RamActionPermissionDeny', + 'errorMessage' => 'You do not have the RAM permission.', + ], + [ + 'errorCode' => 'iot.vision.GbServiceNotEnabled', + 'errorMessage' => 'The GB28181 service has not been enabled.', + ], + [ + 'errorCode' => 'iot.vision.GbIdDuplicate', + 'errorMessage' => 'The GB28181 deviceId is duplicated.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + ], + ], + ], + 'DeleteGbDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.common.RamActionPermissionDeny', + 'errorMessage' => 'You do not have the RAM permission.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + ], + ], + ], + 'EnableGbSubDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'SubDeviceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceName' => [ + 'type' => 'string', + ], + 'ProductKey' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.common.RamActionPermissionDeny', + 'errorMessage' => 'You do not have the RAM permission.', + ], + [ + 'errorCode' => 'iot.vision.GbServiceNotEnabled', + 'errorMessage' => 'The GB28181 service has not been enabled.', + ], + [ + 'errorCode' => 'iot.vision.GbIdDuplicate', + 'errorMessage' => 'The GB28181 deviceId is duplicated.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + ], + ], + ], + 'QueryGbSubDeviceList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'PageStart', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '512', + 'minimum' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'GbSubDeviceList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductKey' => [ + 'type' => 'string', + ], + 'DeviceName' => [ + 'type' => 'string', + ], + 'DeviceId' => [ + 'type' => 'string', + ], + 'DeviceEnable' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'IotId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.common.RamActionPermissionDeny', + 'errorMessage' => 'You do not have the RAM permission.', + ], + [ + 'errorCode' => 'iot.vision.GbServiceNotEnabled', + 'errorMessage' => 'The GB28181 service has not been enabled.', + ], + [ + 'errorCode' => 'iot.vision.GbIdDuplicate', + 'errorMessage' => 'The GB28181 deviceId is duplicated.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + ], + ], + ], + 'RefreshGbSubDeviceList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.common.RamActionPermissionDeny', + 'errorMessage' => 'You do not have the RAM permission.', + ], + [ + 'errorCode' => 'iot.vision.GbServiceNotEnabled', + 'errorMessage' => 'The GB28181 service has not been enabled.', + ], + [ + 'errorCode' => 'iot.vision.GbIdDuplicate', + 'errorMessage' => 'The GB28181 deviceId is duplicated.', + ], + [ + 'errorCode' => 'iot.vision.RefreshTooFrequently', + 'errorMessage' => 'Refresh too frequently.', + ], + [ + 'errorCode' => 'iot.vision.DeviceOffline', + 'errorMessage' => 'Device is offline.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + ], + ], + ], + 'UpdateGbDevice' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'GbId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'ErrorMessage' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.common.RamActionPermissionDeny', + 'errorMessage' => 'You do not have the RAM permission.', + ], + [ + 'errorCode' => 'iot.vision.GbIdDuplicate', + 'errorMessage' => 'The GB28181 deviceId is duplicated.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.lv.requestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.lv.requestAuthError', + 'errorMessage' => 'Request auth error.', + ], + ], + ], + ], + 'CreateStreamPushJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '设备所属产品的**ProductKey**。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> **IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**组合是一一对应的关系。如果传入该参数，则无需传入**ProductKey**和**DeviceName**。如果您同时传入**IotId**和**ProductKey**与**DeviceName**组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页签，查看当前实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型。'."\n" + ."\n" + .'- **0**（默认）：主码流 。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'PushUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '推流地址，限制长度为500个字节。', + 'type' => 'string', + 'required' => true, + 'example' => 'rtmp://****', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'query', + 'schema' => [ + 'description' => '推流任务类型。'."\n" + ."\n" + .'- **1**（默认）：持续型任务。'."\n" + .'- **2**：触发式任务，中断后结束。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '403', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Request forbidden.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E55***B7-4***-4***-8***-D3******F565', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功返回的结果。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '23***********', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.vision.RequestFailed', + 'errorMessage' => 'Request failed.', + ], + [ + 'errorCode' => 'iot.vision.StreamPushFailed', + 'errorMessage' => 'Stream push failed.', + ], + [ + 'errorCode' => 'iot.vision.DeviceOffline', + 'errorMessage' => 'Device is offline.', + ], + [ + 'errorCode' => 'iot.vision.DeviceNotStreaming', + 'errorMessage' => 'Device is not streaming.', + ], + [ + 'errorCode' => 'iot.vision.ConcurrencyExceedLimit', + 'errorMessage' => 'Concurrency exceed the limit.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestAuthFailed', + 'errorMessage' => 'Request auth failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"403\\",\\n \\"ErrorMessage\\": \\"Request forbidden.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"23***********\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateStreamPushJobResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <JobId>23***********</JobId>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</CreateStreamPushJobResponse>","errorExample":""}]', + 'title' => 'CreateStreamPushJob', + 'summary' => '调用接口CreateStreamPushJob创建视频推流任务。', + 'description' => '## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateStreamSnapshotJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '设备所属产品的**ProductKey**。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> **IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**组合是一一对应的关系。如果传入该参数，则无需传入**ProductKey**和**DeviceName**。如果您同时传入**IotId**和**ProductKey**与**DeviceName**组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页签，查看当前实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型。'."\n" + ."\n" + .'- **0**（默认）：主码流 。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'SnapshotInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '截图时间的间隔，时间设置范围为60秒~1800秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '1800', + 'minimum' => '60', + 'example' => '600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '403', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Request auth failed.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E55***B7-4***-4***-8***-D3******F565', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestFailed', + 'errorMessage' => 'Request failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.vision.NoStorageQuota', + 'errorMessage' => 'No storage quota.', + ], + [ + 'errorCode' => 'iot.vision.RequestError', + 'errorMessage' => 'Request error.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestAuthFailed', + 'errorMessage' => 'Request auth failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"403\\",\\n \\"ErrorMessage\\": \\"Request auth failed.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateStreamSnapshotJobResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</CreateStreamSnapshotJobResponse>","errorExample":""}]', + 'title' => 'CreateStreamSnapshotJob', + 'summary' => '调用接口CreateStreamSnapshotJob设置云端截图任务。', + 'description' => '## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteStreamPushJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '23******', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> **IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**组合是一一对应的关系。如果传入该参数，则无需传入**ProductKey**和**DeviceName**。如果您同时传入**IotId**和**ProductKey**与**DeviceName**组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页签，查看当前实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Request parameter error.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E55***B7-4***-4***-8***-D3******F565', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.vision.RequestFailed', + 'errorMessage' => 'Request failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestError', + 'errorMessage' => 'Request error.', + ], + [ + 'errorCode' => 'iot.vision.JobNotExist', + 'errorMessage' => 'Job not exist or expired.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestAuthFailed', + 'errorMessage' => 'Request auth failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteStreamPushJobResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</DeleteStreamPushJobResponse>","errorExample":""}]', + 'title' => 'DeleteStreamPushJob', + 'summary' => '调用接口DeleteStreamPushJob删除视频推流任务。', + 'description' => '## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteStreamSnapshotJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '设备所属产品的**ProductKey**。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> **IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**组合是一一对应的关系。如果传入该参数，则无需传入**ProductKey**和**DeviceName**。如果您同时传入**IotId**和**ProductKey**与**DeviceName**组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页签，查看当前实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => [ + 'description' => '码流类型。'."\n" + ."\n" + .'- **0**（默认）：主码流 。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Request parameter error.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E55***B7-4***-4***-8***-D3******F565', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.vision.RequestFailed', + 'errorMessage' => 'Request failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestError', + 'errorMessage' => 'Request error.', + ], + [ + 'errorCode' => 'iot.vision.JobNotExist', + 'errorMessage' => 'Job not exist or expired.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestAuthFailed', + 'errorMessage' => 'Request auth failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteStreamSnapshotJobResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Code>200</Code>\\n<Success>true</Success>\\n</DeleteStreamSnapshotJobResponse>","errorExample":""}]', + 'title' => 'DeleteStreamSnapshotJob', + 'summary' => '调用接口DeleteStreamSnapshotJob删除视频截图任务。', + 'description' => '## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryStreamPushJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '设备所属产品的**ProductKey**。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '23*********', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> **IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**组合是一一对应的关系。如果传入该参数，则无需传入**ProductKey**和**DeviceName**。如果您同时传入**IotId**和**ProductKey**与**DeviceName**组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页签，查看当前实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Request parameter error.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E55***B7-4***-4***-8***-D3******F565', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功返回的结果。', + 'type' => 'object', + 'properties' => [ + 'JobType' => [ + 'description' => '推流任务类型。'."\n" + ."\n" + .'- **1**：持续型任务。'."\n" + .'- **2**：触发式任务，中断后结束。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PushUrl' => [ + 'description' => '推流地址。', + 'type' => 'string', + 'example' => 'rtmp://****', + ], + 'StreamType' => [ + 'description' => '码流类型。'."\n" + ."\n" + .'- **0**：主码流 。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1581595942', + ], + 'PushStatus' => [ + 'description' => '当前推流状态。'."\n" + ."\n" + .'- **1**：正在推流。'."\n" + .'- **2**：等待推流。'."\n" + .'- **3**：推流结束。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.vision.RequestFailed', + 'errorMessage' => 'Request failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestError', + 'errorMessage' => 'Request error.', + ], + [ + 'errorCode' => 'iot.vision.JobNotExist', + 'errorMessage' => 'Job not exist or expired.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestAuthFailed', + 'errorMessage' => 'Request auth failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobType\\": 1,\\n \\"PushUrl\\": \\"rtmp://****\\",\\n \\"StreamType\\": 1,\\n \\"CreateTime\\": 1581595942,\\n \\"PushStatus\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryStreamPushJobResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <PushStatus>1</PushStatus>\\n <StreamType>1</StreamType>\\n <JobType>1</JobType>\\n <CreateTime>1581595942</CreateTime>\\n <PushUrl>rtmp://****</PushUrl>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryStreamPushJobResponse>","errorExample":""}]', + 'title' => 'QueryStreamPushJob', + 'summary' => '调用接口QueryStreamPushJob查询视频推流任务详情：创建时间、当前推流状态、任务类型、推流地址等。', + 'description' => '## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryStreamPushJobList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回结果中每页显示的记录数量，最大值是100，默认值是10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '设备所属产品的**ProductKey**。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> **IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**组合是一一对应的关系。如果传入该参数，则无需传入**ProductKey**和**DeviceName**。如果您同时传入**IotId**和**ProductKey**与**DeviceName**组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页签，查看当前实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '指定显示返回结果中的第几页的内容。默认值是起始页码1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'JobType', + 'in' => 'query', + 'schema' => [ + 'description' => '推流任务类型。'."\n" + ."\n" + .'- **1**（默认）：持续型任务。'."\n" + .'- **2**：触发式任务，中断后结束。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '400', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Request parameter error.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E55***B7-4***-4***-8***-D3******F565', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功返回的结果。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '总任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'JobList' => [ + 'description' => '任务列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PushUrl' => [ + 'description' => '推流地址。', + 'type' => 'string', + 'example' => 'rtmp://****', + ], + 'StreamType' => [ + 'description' => '码流类型。'."\n" + ."\n" + .'- **0**：主码流 。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'JobId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '23********', + ], + 'CreateTime' => [ + 'description' => '任务创建时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1581595942', + ], + 'PushStatus' => [ + 'description' => '当前推流状态。'."\n" + ."\n" + .'- **1**：正在推流。'."\n" + .'- **2**：等待推流。'."\n" + .'- **3**：推流结束。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'JobType' => [ + 'description' => '推流任务类型。'."\n" + ."\n" + .'- **1**：持续型任务。'."\n" + .'- **2**：触发式任务，中断后结束。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.vision.RequestFailed', + 'errorMessage' => 'Request failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestError', + 'errorMessage' => 'Request error.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestAuthFailed', + 'errorMessage' => 'Request auth failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Total\\": 10,\\n \\"JobList\\": [\\n {\\n \\"PushUrl\\": \\"rtmp://****\\",\\n \\"StreamType\\": 0,\\n \\"JobId\\": \\"23********\\",\\n \\"CreateTime\\": 1581595942,\\n \\"PushStatus\\": 1,\\n \\"JobType\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryStreamPushJobListResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <Total>1</Total>\\n <JobList>\\n <PushStatus>1</PushStatus>\\n <StreamType>0</StreamType>\\n <JobType>1</JobType>\\n <CreateTime>1581595942</CreateTime>\\n <PushUrl>rtmp://****</PushUrl>\\n <JobId>23********</JobId>\\n </JobList>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryStreamPushJobListResponse>","errorExample":""}]', + 'title' => 'QueryStreamPushJobList', + 'summary' => '调用接口QueryStreamPushJobList查询视频推流任务列表及详情：创建时间、当前推流状态、任务类型、推流地址等。', + 'description' => '## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryStreamSnapshotJob' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => [ + 'description' => '设备所属产品的ProductKey。'."\n" + .'您可以在物联网平台控制台**产品**页查看或调用[QueryProductList](~~69271~~)查看当前账号下所有产品的信息。'."\n" + .'><notice> 如果传入该参数，需同时传入**DeviceName**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'a1BwAGV****', + ], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备名称。'."\n" + .'您可以在物联网平台控制台的**设备**页查看**DeviceName**。'."\n" + .'><notice> 如果传入该参数，需同时传入**ProductKey**。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'camera1', + ], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => [ + 'description' => '设备的设备ID。物联网平台为该设备颁发的ID，设备的唯一标识符。可调用物联网平台[QueryDeviceDetail](~~69594~~)查询。'."\n" + ."\n" + .'><notice> **IotId**作为设备唯一标识符，和**ProductKey**与**DeviceName**组合是一一对应的关系。如果传入该参数，则无需传入**ProductKey**和**DeviceName**。如果您同时传入**IotId**和**ProductKey**与**DeviceName**组合，则以**IotId**为准。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。您可在物联网平台控制台的**实例概览**页签，查看当前实例的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'iot-cn-n6w1y59****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口返回码：'."\n" + ."\n" + .'- **200**：表示成功。'."\n" + .'- 其它：表示错误码。错误码详情，请参见[错误码](~~145071~~)。', + 'type' => 'string', + 'example' => '403', + ], + 'ErrorMessage' => [ + 'description' => '调用失败时，返回的出错信息。', + 'type' => 'string', + 'example' => 'Request forbidden.', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => 'E55***B7-4***-4***-8***-D3******F565', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '调用成功返回的结果。', + 'type' => 'object', + 'properties' => [ + 'JobList' => [ + 'description' => '任务信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StreamType' => [ + 'description' => '码流类型。'."\n" + ."\n" + .'- **0**：主码流 。'."\n" + .'- **1**：辅码流。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SnapshotInterval' => [ + 'description' => '截图时间的间隔。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '600', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'iot.vision.RequestParamError', + 'errorMessage' => 'Request parameter error.', + ], + [ + 'errorCode' => 'iot.vision.RequestFailed', + 'errorMessage' => 'Request failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestError', + 'errorMessage' => 'Request error.', + ], + ], + 403 => [ + [ + 'errorCode' => 'iot.vision.RequestAuthFailed', + 'errorMessage' => 'Request auth failed.', + ], + [ + 'errorCode' => 'iot.vision.RequestForbidden', + 'errorMessage' => 'Request forbidden.', + ], + ], + 429 => [ + [ + 'errorCode' => 'iot.vision.RequestTrafficControl', + 'errorMessage' => 'Request traffic control.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"403\\",\\n \\"ErrorMessage\\": \\"Request forbidden.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobList\\": [\\n {\\n \\"StreamType\\": 0,\\n \\"SnapshotInterval\\": 600\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryStreamSnapshotJobResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <JobList>\\n <SnapshotInterval>600</SnapshotInterval>\\n <StreamType>0</StreamType>\\n </JobList>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryStreamSnapshotJobResponse>","errorExample":""}]', + 'title' => 'QueryStreamSnapshotJob', + 'summary' => '调用接口QueryStreamSnapshotJob查询云端截图任务列表及详情：截图时间的间隔、码流类型。', + 'description' => '## QPS限制'."\n" + ."\n" + .'单个阿里云账号调用该接口的每秒请求数（QPS）最大限制为50。'."\n" + ."\n" + .'> 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。', + 'requestParamsDescription' => '调用API时，除了本文介绍的该API的特有请求参数，还需传入公共请求参数。公共请求参数说明，请参见[公共参数](~~141505~~)文档。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'linkvisual.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'linkvisual.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'linkvisual.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'linkvisual.aliyuncs.com', + ], + ], +]; |