diff options
Diffstat (limited to 'data/en_us/linkvisual')
| -rw-r--r-- | data/en_us/linkvisual/2018-01-20/api-docs.php | 22829 | ||||
| -rw-r--r-- | data/en_us/linkvisual/2023-06-30/api-docs.php | 7688 |
2 files changed, 13974 insertions, 16543 deletions
diff --git a/data/en_us/linkvisual/2018-01-20/api-docs.php b/data/en_us/linkvisual/2018-01-20/api-docs.php index ab28241..4ac47f7 100644 --- a/data/en_us/linkvisual/2018-01-20/api-docs.php +++ b/data/en_us/linkvisual/2018-01-20/api-docs.php @@ -1,187 +1,57 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Linkvisual', - 'version' => '2018-01-20', - ], + 'info' => ['style' => 'RPC', 'product' => 'Linkvisual', 'version' => '2018-01-20'], 'directories' => [ [ - 'id' => 65321, - 'title' => null, + 'children' => ['AddEventRecordPlanDevice', 'CreateEventRecordPlan', 'DeleteEventRecordPlan', 'DeleteEventRecordPlanDevice', 'QueryDeviceEventPicture'], 'type' => 'directory', - 'children' => [ - 'AddEventRecordPlanDevice', - 'CreateEventRecordPlan', - 'DeleteEventRecordPlan', - 'DeleteEventRecordPlanDevice', - 'QueryDeviceEventPicture', - ], + 'title' => 'Event', ], [ - 'id' => 65327, - 'title' => null, + 'children' => ['CreateTimeTemplate', 'DeleteTimeTemplate', 'UpdateTimeTemplate', 'QueryTimeTemplateDetail'], 'type' => 'directory', - 'children' => [ - 'CreateTimeTemplate', - 'DeleteTimeTemplate', - 'UpdateTimeTemplate', - 'QueryTimeTemplateDetail', - ], + 'title' => 'Time template', ], [ - 'id' => 65339, - 'title' => null, + 'children' => ['AddFaceDeviceGroup', 'AddFaceDeviceToDeviceGroup', 'DeleteFaceDeviceGroup', 'SetDevicePictureLifeCycle', 'StopLiveStreaming', 'QueryDeviceEvent', 'QueryDevicePictureFile', 'QueryDevicePictureLifeCycle', 'QueryDeviceVodUrlByTime', 'QueryFaceAllDeviceGroup', 'QueryFaceDeviceGroupsByDevice', 'QueryLiveStreaming', 'QueryVoiceIntercom', 'RemoveFaceDeviceFromDeviceGroup'], 'type' => 'directory', - 'children' => [ - 'AddFaceDeviceGroup', - 'AddFaceDeviceToDeviceGroup', - 'DeleteFaceDeviceGroup', - 'SetDevicePictureLifeCycle', - 'StopLiveStreaming', - 'QueryDeviceEvent', - 'QueryDevicePictureFile', - 'QueryDevicePictureLifeCycle', - 'QueryDeviceVodUrlByTime', - 'QueryFaceAllDeviceGroup', - 'QueryFaceDeviceGroupsByDevice', - 'QueryLiveStreaming', - 'QueryVoiceIntercom', - 'RemoveFaceDeviceFromDeviceGroup', - ], + 'title' => 'Device', ], [ - 'id' => 65364, - 'title' => null, + 'children' => ['AddFaceUserGroup', 'AddFaceUserToUserGroup', 'DeleteFaceUserGroup', 'UpdateFaceUserGroupAndDeviceGroupRelation', 'UpdateFaceUser', 'QueryFaceAllUserGroupAndDeviceGroupRelation', 'QueryFaceUserGroupAndDeviceGroupRelation', 'QueryFaceUserIdByCustomUserId', 'QueryFaceAllUserGroup', 'QueryFaceAllUserIdsByGroupId', 'QueryFaceCustomUserIdByUserId', 'QueryFaceUser', 'QueryFaceUserGroup', 'RemoveFaceUserFromUserGroup'], 'type' => 'directory', - 'children' => [ - 'AddFaceUserGroup', - 'AddFaceUserToUserGroup', - 'DeleteFaceUserGroup', - 'UpdateFaceUserGroupAndDeviceGroupRelation', - 'UpdateFaceUser', - 'QueryFaceAllUserGroupAndDeviceGroupRelation', - 'QueryFaceUserGroupAndDeviceGroupRelation', - 'QueryFaceUserIdByCustomUserId', - 'QueryFaceAllUserGroup', - 'QueryFaceAllUserIdsByGroupId', - 'QueryFaceCustomUserIdByUserId', - 'QueryFaceUser', - 'QueryFaceUserGroup', - 'RemoveFaceUserFromUserGroup', - ], + 'title' => 'User', ], [ - 'id' => 65379, - 'title' => null, + 'children' => ['AddFaceUser', 'AddFaceUserGroupAndDeviceGroupRelation', 'AddFaceUserPicture', 'DeleteFaceUser', 'DeleteFaceUserGroupAndDeviceGroupRelation', 'DeleteFaceUserPicture', 'CheckFaceUserDoExistOnDevice', 'ClearFaceDeviceDB'], 'type' => 'directory', - 'children' => [ - 'AddFaceUser', - 'AddFaceUserGroupAndDeviceGroupRelation', - 'AddFaceUserPicture', - 'DeleteFaceUser', - 'DeleteFaceUserGroupAndDeviceGroupRelation', - 'DeleteFaceUserPicture', - 'CheckFaceUserDoExistOnDevice', - 'ClearFaceDeviceDB', - ], + 'title' => 'Face', ], [ - 'id' => 65389, - 'title' => null, + 'children' => ['CreatePictureSearchApp', 'CreatePictureSearchJob', 'UpdatePictureSearchApp', 'QueryPictureSearchAiboxes', 'QueryPictureSearchApps', 'QueryPictureSearchDevices', 'QueryPictureSearchJob', 'QueryPictureSearchJobResult', 'GetPictureSearchJobStatus', 'QueryPictureFiles', 'BindPictureSearchAppWithDevices', 'UnbindPictureSearchAppWithDevices', 'PictureSearchPicture', 'TriggerCapturePicture'], 'type' => 'directory', + 'title' => 'Image search', + ], + [ 'children' => [ - 'CreatePictureSearchApp', - 'CreatePictureSearchJob', - 'UpdatePictureSearchApp', - 'QueryPictureSearchAiboxes', - 'QueryPictureSearchApps', - 'QueryPictureSearchDevices', - 'QueryPictureSearchJob', - 'QueryPictureSearchJobResult', - 'GetPictureSearchJobStatus', - 'QueryPictureFiles', - 'BindPictureSearchAppWithDevices', - 'UnbindPictureSearchAppWithDevices', - 'PictureSearchPicture', - 'TriggerCapturePicture', + 'CreateRecordPlan', 'AddRecordPlanDevice', 'DeleteRecordPlan', 'DeleteRecordPlanDevice', 'SetDeviceRecordLifeCycle', 'StopTriggeredRecord', 'UpdateEventRecordPlan', 'UpdateRecordPlan', 'QueryRecord', 'QueryRecordByRecordId', 'QueryRecordPlanDetail', 'QueryRecordPlanDeviceByDevice', 'QueryRecordPlanDeviceByPlan', 'QueryRecordPlans', 'QueryRecordUrl', 'QueryTimeTemplate', 'QueryDeviceEventRecord', 'QueryDeviceVodUrl', 'QueryMonthRecord', 'QueryDeviceRecordLifeCycle', + 'QueryEventRecordPlanDetail', 'QueryEventRecordPlanDeviceByDevice', 'QueryEventRecordPlanDeviceByPlan', 'QueryEventRecordPlans', ], + 'type' => 'directory', + 'title' => 'Recording', ], [ - 'id' => 65418, - 'title' => null, - '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', + 'QueryDevicePictureByList', 'TransferDeviceInstance', 'QueryRecordDownloadUrl', 'CreateLocalFileUploadJob', 'DeleteLocalFileUploadJob', 'QueryLocalFileUploadJob', 'QueryFaceUserBatch', 'QueryFaceUserByName', 'QueryRecordUrlByTime', 'QueryCarProcessEvents', 'DeletePicture', 'UpdateInstanceInternetProtocol', 'CreateRecordDownloadByTimeJob', 'QueryRecordDownloadJobById', 'QueryRecordDownloadJobList', 'CreateLocalRecordDownloadByTimeJob', 'CreateStreamPushJob', 'CreateStreamSnapshotJob', 'DeleteStreamPushJob', 'DeleteStreamSnapshotJob', + 'QueryStreamPushJob', 'QueryStreamPushJobList', 'QueryStreamSnapshotJob', ], + 'type' => 'directory', + 'title' => 'Other', ], [ - 'id' => 177204, - 'title' => null, + 'children' => ['BatchQueryVisionDeviceInfo', 'CreateGbDevice', 'CreateRtmpDevice', 'DeleteGbDevice', 'DeleteRecord', 'DeleteRtmpDevice', 'DeleteRtmpKey', 'EnableGbSubDevice', 'QueryGbSubDeviceList', 'QueryRtmpKey', 'QueryVisionDeviceInfo', 'RefreshGbSubDeviceList', 'TriggerRecord', 'UpdateGbDevice', 'UpdateRtmpKey'], + 'title' => 'Others', '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' => [ @@ -189,84 +59,59 @@ ], 'apis' => [ 'AddEventRecordPlanDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console. If an ID value exists, you must specify this ID value. Otherwise, the call fails.'."\n" + ."\n" + .'> If no ID value exists for the public instance, refer to [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to query information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The device name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** serves as the unique identifier of the device and has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify **IotId** together with the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], ], [ 'name' => 'StreamType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The stream type. Valid values:'."\n" + .'- **0** (default): main stream.'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], ], [ 'name' => 'PlanId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5b60bf0dd55944c19d7817442bc9****', - ], + 'schema' => ['description' => 'The ID of the intelligent alert event recording plan. You can call [QueryEventRecordPlans](~~107907~~) to query the plan ID.', 'type' => 'string', 'required' => true, 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], ], ], 'responses' => [ @@ -274,108 +119,74 @@ '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' => 'request forbidden', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, refer to [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'request forbidden', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'AddEventRecordPlanDevice', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"request forbidden\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Associate a camera with an event linkage plan', + 'summary' => 'Adds an intelligent alert event recording plan for an IPC device.', + 'requestParamsDescription' => 'When you invoke this API operation, you must specify common request parameters in addition to the operation-specific request parameters described in this topic. For metric description of common request parameters, refer to [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateEventRecordPlan' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddEventRecordPlanDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddEventRecordPlanDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AddFaceDeviceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'plan1', - ], - ], - [ - 'name' => 'EventTypes', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PreRecordDuration', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - 'default' => '0', - ], - ], - [ - 'name' => 'RecordDuration', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The business isolation ID used for data isolation between different business applications under the same Alibaba Cloud account. The value can contain uppercase and lowercase letters and digits.'."\n" + ."\n" + .'For example, if you have facial recognition services in both Region A and Region B, you can set different business isolation IDs to distinguish between the facial recognition services in Region A and Region B.'."\n" + ."\n" + .'><notice>'."\n" + .'Save the business isolation ID for subsequent use in calls to other operations under this business isolation scope.'."\n" + .'></notice>', 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHZ', 'title' => ''], ], [ - 'name' => 'TemplateId', + 'name' => 'DeviceGroupName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fc82774fa749485bad7d719f9670****', - ], + 'schema' => ['description' => 'The name of the device group. Customize the value. The name can be up to 128 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'TestDeviceGroup', 'title' => ''], ], ], 'responses' => [ @@ -383,175 +194,102 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'Code' => ['description' => 'The response code:'."\n" + .'- **200**: The request was successful.'."\n" + .'- Other codes: An error occurred. For more information about error codes, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'group already exist', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful:'."\n" + .'- **true**: The request was successful.'."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The data returned if the request was successful.', + 'type' => 'object', + 'properties' => [ + 'DeviceGroupId' => ['description' => 'The unique ID generated by the system for the device group.'."\n" + ."\n" + .'> **DeviceGroupId** is used in calls to other operations of the face database service. Save this value properly.', 'type' => 'string', 'example' => 'jvkv****', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the device group was added.', 'type' => 'string', 'example' => '2020-11-20 18:59:01', 'title' => ''], + 'DeviceGroupName' => ['description' => 'The name of the device group.', 'type' => 'string', 'example' => 'TestDeviceGroup', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'CreateEventRecordPlan', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Add a device group', + 'summary' => 'Adds a face database device group.', + 'description' => '## Usage notes'."\n" + ."\n" + .'- The maximum number of queries per second (QPS) for a single Alibaba Cloud account to call this operation is 100.'."\n" + ."\n" + .' > RAM users share the quota of the Alibaba Cloud account.'."\n" + ."\n" + .'- After you call this operation, the system returns the ID of the device group (**DeviceGroupId**). We recommend that you save the value to the local device for subsequent use in calls to other operations.', + 'requestParamsDescription' => ' When you call this operation, in addition to the operation-specific request parameters described in this topic, you must also specify common request parameters. For more information about common request parameters, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteEventRecordPlan' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceDeviceGroup'], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'PlanId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2e34a1989aa54debac22358aca7f****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '438A20F2-AFF2-4CAC-89F9-3378EAA133BD', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tenant auth error', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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' => 'DeleteEventRecordPlan', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DeleteEventRecordPlanDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddFaceDeviceToDeviceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], + ], + [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'TestInstanceId', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The product key.', 'type' => 'string', 'required' => true, 'example' => 'a1Tp7KYZHHK', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The device name.', 'type' => 'string', 'required' => true, 'example' => 'TestDevice', 'title' => ''], ], [ - 'name' => 'IotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], - ], - [ - 'name' => 'StreamType', + 'name' => 'DeviceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The device group ID. You can obtain this ID by calling the AddFaceDeviceGroup operation.', 'type' => 'string', 'required' => true, 'example' => 'kvjyhurc', 'title' => ''], ], ], 'responses' => [ @@ -559,103 +297,87 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'DeleteEventRecordPlanDevice', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Add a device to a device group', + 'summary' => 'Adds a device to a device group.', + 'requestParamsDescription' => '1. IsolationId: Used for data isolation between different applications under a tenant. For example, if a user has businesses in both Zhejiang and Shaanxi, two separate isolation IDs can be created for the businesses in Zhejiang and Xi\'an.'."\n" + .'2. IotInstanceId: The instance ID of the IoT platform.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryDeviceEventPicture' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceDeviceToDeviceGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceDeviceToDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AddFaceUser' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ProductKey', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The business isolation ID, which is used for data isolation between different business applications under the same Alibaba Cloud account. The value can contain uppercase and lowercase letters and digits.'."\n" + ."\n" + .'For example, if you have facial recognition services in both Region A and Region B, you can set different business isolation IDs to distinguish the facial recognition services in Region A and Region B.'."\n" + ."\n" + .'><notice>'."\n" + .'Properly save the business isolation ID value for subsequent calls to other operations in this business isolation zone.'."\n" + .'></notice>'."\n", 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHZ', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'FacePicUrl', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The URL of the user\'s face image. Currently, only images in JPEG and JPG formats are supported, and the image URL cannot contain Chinese characters.', 'type' => 'string', 'required' => true, 'example' => 'https://example.com/test.jpeg', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'CustomUserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], + 'schema' => ['description' => 'The user identity ID. The value can contain uppercase letters and digits.'."\n" + ."\n" + .'We recommend that you set this parameter to the ID card number or student ID of the user.', 'type' => 'string', 'required' => true, 'example' => '1234567890', 'title' => ''], ], [ - 'name' => 'EventId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ae6b74f1dc7d402****32c21018****f1608036****71', - ], + 'schema' => ['description' => 'The username. The value can contain Chinese characters, uppercase and lowercase letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'Tony', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'Params', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y*****', - ], + 'schema' => ['description' => 'The custom user parameters.', 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1", "key2":"value2"}', 'title' => ''], ], ], 'responses' => [ @@ -663,119 +385,98 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Code' => ['description' => 'The response code.'."\n" + .'- **200**: indicates success.'."\n" + .'- Other codes: indicate error codes. For more information about error codes, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'face user already exist', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The data returned if the call is successful.', + 'type' => 'object', + 'properties' => [ + 'Params' => ['description' => 'The custom user parameters.', 'type' => 'string', 'example' => '{"key1":"value1", "key2":"value2"}', 'title' => ''], + 'CustomUserId' => ['description' => 'The user identity ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], + 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'Tony', 'title' => ''], + 'UserId' => ['description' => 'The ID generated by the system for the added user.'."\n" + ."\n" + .'> **UserId** is used in calls to other operations of the face database service. Save it properly.'."\n", 'type' => 'string', 'example' => '3mtjaqebeq4d****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryDeviceEventPicture', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Add a user to the face management service', + 'summary' => 'Calls this operation to add a user to the face database.', + 'description' => '## Usage notes'."\n" + ."\n" + .'- The maximum number of queries per second (QPS) for a single Alibaba Cloud account calling this operation is 100.'."\n" + ."\n" + .' > RAM users share the quota of the Alibaba Cloud account.'."\n" + ."\n" + .'- Configure a URL download address for the user\'s face image in advance.'."\n" + ."\n" + .' > Currently, only images in JPEG and JPG formats are supported, and the image URL cannot contain Chinese characters.'."\n" + ."\n" + .'- After you call this operation, the system returns a user ID (**UserId**). We recommend that you save this value locally for subsequent calls to other operations.', + 'requestParamsDescription' => 'When you call this operation, in addition to the request parameters described in this topic, you must also include common request parameters. For more information about common request parameters, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateTimeTemplate' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceUser'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AddFaceUserGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'TimeSections', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DayOfWeek' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Begin' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20000', - ], - 'End' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60000', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 1000, - ], - ], - [ - 'name' => 'Name', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example', - ], + 'schema' => ['description' => 'The business isolation ID, which is used for data isolation between different business applications under the same Alibaba Cloud account. The value can contain uppercase and lowercase letters and digits.'."\n" + ."\n" + .'For example, if you have face recognition services in both Region A and Region B, you can set different business isolation IDs to distinguish between the face recognition services in Region A and Region B.'."\n" + ."\n" + .'><notice>'."\n" + .'Save the business isolation ID for use when you call other operations in this isolation scope.'."\n" + .'></notice>.', 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHZ', 'title' => ''], ], [ - 'name' => 'AllDay', + 'name' => 'UserGroupName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => 'The name of the user group. Specify a custom value. The name can be up to 128 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'TestUserGroup', 'title' => ''], ], ], 'responses' => [ @@ -783,192 +484,102 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'group already exist', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The data returned if the call is successful.', + 'type' => 'object', + 'properties' => [ + 'UserGroupName' => ['description' => 'The name of the user group.', 'type' => 'string', 'example' => 'TestUserGroup', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the user group was created.', 'type' => 'string', 'example' => '2020-11-20 18:59:01', 'title' => ''], + 'UserGroupId' => ['description' => 'The ID generated by the system for the user group.'."\n" + ."\n" + .'> The **UserGroupId** is used in other operations of the face image library service. Save this value properly.', 'type' => 'string', 'example' => 'kvjy****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Create a user group', + 'summary' => 'Creates a user group.', + 'description' => '## Operation description'."\n" + ."\n" + .'- The maximum number of queries per second (QPS) per Alibaba Cloud account for invoking this operation is 100.'."\n" + ."\n" + .' > Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.'."\n" + ."\n" + .'- After you invoke this operation, the system returns the user group ID (**UserGroupId**). Save this value locally for use when you invoke other operations.', + 'requestParamsDescription' => ' When you invoke this operation, you must include common request parameters in addition to the operation-specific request parameters described in this topic. For more information about common request parameters, see [Common parameters](~~288312~~). For the metric description of common request parameters, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteTimeTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceUserGroup'], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '36f06322442e4e3f85a5ae8862c9****', - ], - ], - ], - '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' => 'RAM system auth error.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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' => 'DeleteTimeTemplate', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateTimeTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddFaceUserGroupAndDeviceGroupRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'TimeSections', + 'name' => 'IsolationId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DayOfWeek' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Begin' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20000', - ], - 'End' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60000', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 1000, - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], ], [ - 'name' => 'TemplateId', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fc82774fa749485bad7d719f9670****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'TestInstanceId', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'UserGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The user group ID.', 'type' => 'string', 'required' => true, 'example' => 'avjyxurd', 'title' => ''], ], [ - 'name' => 'AllDay', + 'name' => 'DeviceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => 'The device group ID.', 'type' => 'string', 'required' => true, 'example' => 'kvjyhurc', 'title' => ''], + ], + [ + 'name' => 'Relation', + 'in' => 'query', + 'schema' => ['description' => 'The face synchronization relationship.', 'type' => 'string', 'required' => true, 'example' => 'SYNC_INFO_PICTURE', 'title' => ''], ], ], 'responses' => [ @@ -976,64 +587,79 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The face synchronization relationship information.', + 'type' => 'object', + 'properties' => [ + 'ControlId' => ['description' => 'The association control ID.', 'type' => 'string', 'example' => 'qcb2yea4ha4dxmly', 'title' => ''], + 'ModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2020-11-20 18:59:01', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Add a face synchronization relationship for a user group and a device group', + 'summary' => 'Adds a face synchronization relationship for a user group and a device group.', + 'requestParamsDescription' => '1. IsolationId: Used for data isolation between different applications under a tenant. For example, if a user has businesses in both Zhejiang and Shaanxi, two separate isolation IDs can be created for the businesses in Zhejiang and Xi\'an.'."\n" + .'2. IotInstanceId: The instance ID of the IoT platform.'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryTimeTemplateDetail' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceUserGroupAndDeviceGroupRelation'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceUserGroupAndDeviceGroupRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AddFaceUserPicture' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '36f06322442e4e3f85a5ae8862c9****', - ], + 'schema' => ['description' => 'The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set this parameter to the same value as the **IsolationId** specified when you called the [AddFaceUser](~~288338~~) operation to add the user.', 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHZ', 'title' => ''], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => 'The user ID. Set this parameter to the **UserId** value that you obtained and saved locally after calling the [AddFaceUser](~~288338~~) operation to add the user.', 'type' => 'string', 'required' => true, 'example' => '3mtjaqebeq4d****', 'title' => ''], + ], + [ + 'name' => 'FacePicUrl', + 'in' => 'query', + 'schema' => ['description' => 'The URL for downloading the face image of the user. Only images in JPEG and JPG formats are supported. The image URL cannot contain Chinese characters.', 'type' => 'string', 'required' => true, 'example' => 'https://example.com/test.jpeg', 'title' => ''], ], ], 'responses' => [ @@ -1041,128 +667,90 @@ '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' => 'template owner error', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AllDay' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Default' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '36f06322442e4e3f85a5ae8862c9****', - ], - 'TimeSectionList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'End' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60000', - ], - 'DayOfWeek' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Begin' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + .'- **200**: Success.'."\n" + .'- Other values: An error code. For more information, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The unique identifier of the face image returned when the call is successful.'."\n" + ."\n" + .'> The unique identifier of the face image is used in other operations of the face database service. Save it properly.', 'type' => 'object', 'example' => '1bb580ef7****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'face user not exist', 'title' => ''], + 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '4de2c367-c1db-417c-aa15-8c585e595d92', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryTimeTemplateDetail', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'AddFaceUserPicture', + 'summary' => 'Adds a face image for a user in the face database.', + 'description' => '## Usage notes'."\n" + ."\n" + .'- The maximum number of queries per second (QPS) per Alibaba Cloud account for invoking this operation is 100.'."\n" + ."\n" + .' > Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.'."\n" + ."\n" + .'- Configure a URL for downloading the face image of the user in advance.'."\n" + ."\n" + .' > Only images in JPEG and JPG formats are supported. The image URL cannot contain Chinese characters.'."\n" + ."\n" + .'- After you invoke this operation, the system returns a unique identity for the face image (**Data**). Save this value locally for use when invoking other operations.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For more information about common request parameters, see [Common parameters](~~288312~~). For the metric description of common request parameters, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddFaceDeviceGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceUserPicture'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceUserPicture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AddFaceUserToUserGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ZheJiangHZ', - ], + 'schema' => ['description' => 'The business isolation ID, which is used for data isolation between different business applications under the same Alibaba Cloud account.'."\n" + ."\n" + .'><notice>'."\n" + .'The user and the user group must be under the same isolation ID. Set this parameter to the same value as the **IsolationId** that you specified when you called the [AddFaceUser](~~288338~~) operation to add the user and the [AddFaceUserGroup](~~288341~~) operation to create the user group.'."\n" + .'></notice>.', 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHZ', 'title' => ''], ], [ - 'name' => 'DeviceGroupName', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestDeviceGroup', - ], + 'schema' => ['description' => 'The user ID. Set this parameter to the user ID that you obtained and saved locally after calling the [AddFaceUser](~~288338~~) operation to add the user.', 'type' => 'string', 'required' => true, 'example' => '3mtjaqebeq4d****', 'title' => ''], + ], + [ + 'name' => 'UserGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The user group ID. Set this parameter to the user group ID that you obtained and saved locally after calling the [AddFaceUserGroup](~~288341~~) operation to create the user group.', 'type' => 'string', 'required' => true, 'example' => 'kvjy****', 'title' => ''], ], ], 'responses' => [ @@ -1170,124 +758,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'group already exist', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DeviceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'jvkv****', - ], - 'ModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-11-20 18:59:01', - ], - 'DeviceGroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestDeviceGroup', - ], - ], - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + .'- **200**: Success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'face user not exist', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'AddFaceDeviceGroup', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"face user not exist\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Add a user to a user group', + 'summary' => 'Adds a user to a user group.', + 'description' => '## Before you begin'."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account for this operation is 100.'."\n" + .' > Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when calling this operation. For more information, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddFaceDeviceToDeviceGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceUserToUserGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceUserToUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AddRecordPlanDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'IsolationId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', - ], - ], - [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestInstanceId', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Instance Overview** page in the IoT Platform console. If an ID value exists, you must specify this ID value. Otherwise, the call fails.'."\n" + ."\n" + .'> If no ID value exists for the public instance, refer to [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a1Tp7KYZHHK', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to query information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestDevice', - ], + 'schema' => ['description' => 'The device name of the IPC device.'."\n" + .'You can view **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'DeviceGroupId', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'kvjyhurc', - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** serves as the unique identifier of the device and has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => ['description' => 'The stream type. Valid values:'."\n" + ."\n" + .'- **0** (default): main stream.'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => ['description' => 'The recording plan ID. You can call [QueryRecordPlans](~~107896~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], ], ], 'responses' => [ @@ -1295,72 +865,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, refer to [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'AddFaceDeviceToDeviceGroup', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Add a camera to a recording plan', + 'summary' => 'Adds a continuous recording plan to an IPC device.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify common request parameters in addition to the operation-specific request parameters described in this topic. For the metric description of common request parameters, refer to [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteFaceDeviceGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddRecordPlanDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddRecordPlanDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'BatchQueryVisionDeviceInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DeviceNameList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 50, 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DeviceGroupId', + 'name' => 'IotIdList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 50, 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'qaf2tihq', + 'title' => '', + 'example' => '', ], ], ], @@ -1369,104 +962,146 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', - ], - 'Success' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceInfoList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GbDeviceInfo' => [ + 'type' => 'object', + 'properties' => [ + 'GbId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Password' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'NickName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SubProductKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceProtocol' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'NetProtocol' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RtmpDeviceInfo' => [ + 'type' => 'object', + 'properties' => [ + 'StreamStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PushKeyExpireTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'StreamName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PushAuthKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PullAuthKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PullKeyExpireTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PushUrlSample' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DeleteFaceDeviceGroup', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SetDevicePictureLifeCycle' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.RequestParameterError', 'errorMessage' => 'Request parameter error:%s', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.vision.RequestError', 'errorMessage' => 'Request error.', 'description' => 'The request failed.'], + ], + 403 => [ + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - 'systemTags' => [ - 'operationType' => 'update', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchQueryVisionDeviceInfo'], + ], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:BatchQueryVisionDeviceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"DeviceInfoList\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"DeviceType\\": 0,\\n \\"IotId\\": \\"\\",\\n \\"GbDeviceInfo\\": {\\n \\"GbId\\": \\"\\",\\n \\"Password\\": \\"\\",\\n \\"NickName\\": \\"\\",\\n \\"SubProductKey\\": \\"\\",\\n \\"DeviceProtocol\\": 0,\\n \\"NetProtocol\\": 0\\n },\\n \\"RtmpDeviceInfo\\": {\\n \\"StreamStatus\\": 0,\\n \\"PushKeyExpireTime\\": 0,\\n \\"StreamName\\": \\"\\",\\n \\"PushAuthKey\\": \\"\\",\\n \\"PullAuthKey\\": \\"\\",\\n \\"PullKeyExpireTime\\": 0,\\n \\"PushUrlSample\\": \\"\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'BindPictureSearchAppWithDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'AK' => [], ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'DeviceName', + 'name' => 'AppInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The ID of the image search application instance. You can call [QueryPictureSearchApps](~~206608~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '5a502d3fbab8410e8fd4be9037c7****', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHR****c300', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'- Enterprise Edition instance: This parameter is required. You can view the ID of the Enterprise Edition instance on the **Overview** page in the IoT Platform console.'."\n" + .'- Public instance: You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'iot-060a****', 'title' => ''], ], [ - 'name' => 'Day', + 'name' => 'DeviceIotIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The list of device IotIds. You can specify the IotIds of V-series edge servers or cameras.'."\n" + ."\n" + .'An IotId is the unique identifier that IoT Platform assigns to a device.'."\n" + .'You can call [QueryDeviceDetail](~~69594~~) in IoT Platform to query the IotId.'."\n" + ."\n" + .'You can specify up to 20 device IotIds in a single request.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, - 'example' => '7', + 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', + 'maxItems' => 20, + 'title' => '', ], ], ], @@ -1475,105 +1110,82 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '449ECE75-A36A-4ACE-B253-147C78C440C5', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tenant auth error', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'iotIdList is error', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'B8A4153B-4F18-49B1-90C0-C9194866FF88', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'SetDevicePictureLifeCycle', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"iotIdList is error\\",\\n \\"RequestId\\": \\"B8A4153B-4F18-49B1-90C0-C9194866FF88\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Bind a picture search application with devices', + 'summary' => 'Binds devices in batches with an image search instance.', + 'description' => '## Limits'."\n" + .'If you call this operation in an Enterprise Edition instance, the **IotInstanceId** request parameter is required. Otherwise, the call fails.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information, see [Common parameters](~~141505~~).'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'StopLiveStreaming' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindPictureSearchAppWithDevices'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:BindPictureSearchAppWithDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CheckFaceUserDoExistOnDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IotId', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'a103lZ86ovStDMnU', 'title' => ''], ], [ - 'name' => 'ProductKey', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => false, 'example' => 'TestIotInstanceId', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'tibce3fsgqelezk8', 'title' => ''], ], [ - 'name' => 'StreamType', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The ProductKey of the product in IoT Platform.', 'type' => 'string', 'required' => true, 'example' => 'a1654Sr4Y3f', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'The name of the device.', 'type' => 'string', 'required' => true, 'example' => 'TestDeviceName', 'title' => ''], ], ], 'responses' => [ @@ -1581,148 +1193,182 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'DoExist' => ['description' => 'Indicates whether the specified user has successfully synced face data on the device.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DoExist\\": true\\n }\\n}","type":"json"}]', + 'title' => 'CheckFaceUserDoExistOnDevice', + 'summary' => 'Checks whether the specified user has successfully synced face data on a device.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryDeviceEvent' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckFaceUserDoExistOnDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CheckFaceUserDoExistOnDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ClearFaceDeviceDB' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHZ', 'title' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console. If an ID value is available, you must specify this ID. Otherwise, the call fails.'."\n" + ."\n" + .'> If no ID value is available for the public instance, see [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot_instc_pu****_c*-v64********', 'title' => ''], + ], + [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The unique identifier of the product to which the device corresponding to the V series edge all-in-one device belongs. On the **Host Details** page of the V series edge all-in-one device in the Edge Computing console, click the **Basic Information** tab, find the **Video Gateway** section, and obtain the **ProductKey** value.', 'type' => 'string', 'required' => true, 'example' => 'a1Wmy******', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', + 'schema' => ['description' => 'The name of the device corresponding to the V series edge all-in-one device. On the **Host Details** page of the V series edge all-in-one device in the Edge Computing console, click the **Basic Information** tab, find the **Video Gateway** section, and obtain the **DeviceName** value.', 'type' => 'string', 'required' => true, 'example' => 'TestDevice_1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'If the call is successful, an empty value is returned, which indicates that the face database under the specified isolation ID on the V series edge all-in-one device has been cleared.', 'type' => 'object', 'example' => '""', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'device not found', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"\\",\\n \\"ErrorMessage\\": \\"device not found\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Clear face database on device', + 'summary' => 'Clears all face databases under the specified isolation ID on a V series edge all-in-one device.', + 'description' => '## Limits'."\n" + .'The maximum number of queries per second (QPS) for a single Alibaba Cloud account to call this API operation is 100.'."\n" + .' > RAM users share the quota of the Alibaba Cloud account.', + 'requestParamsDescription' => 'When you call this API operation, in addition to the request parameters described in this topic, you must also specify common request parameters. For more information, see [Common parameters](~~288312~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ClearFaceDeviceDB'], + ], + ], + 'ramActions' => [ [ - 'name' => 'IotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:ClearFaceDeviceDB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateEventRecordPlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EventType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ [ - 'name' => 'BeginTime', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1539507310000', - ], + 'schema' => ['description' => 'The name of the recording plan.'."\n" + ."\n" + .'The name must be fewer than 48 characters in length and can contain letters, digits, and the following special characters: hyphens (-), underscores (_), at signs (@), periods (.), and colons (:).', 'type' => 'string', 'required' => true, 'example' => 'plan1', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'EventTypes', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1539607310000', - ], + 'schema' => ['description' => 'The type of intelligent alert event.'."\n" + ."\n" + .'- To specify all intelligent alert event types, set this parameter to 0.'."\n" + .'- To specify multiple intelligent alert event types, enter the serial numbers of the intelligent alert events separated by commas (,). Example: `10001,10002`.'."\n" + .'>You can specify up to 10 intelligent alert events at a time.'."\n" + ."\n" + .'To view all intelligent alert event types, go to the **Feature Definition** tab on the **Product Details** page in the IoT Platform console. For more information, see [View intelligent alert event types](~~207701~~).', 'type' => 'string', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'PreRecordDuration', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The pre-recording duration. Unit: seconds. Default value: 0. Maximum value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '5', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RecordDuration', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The recording duration, including the pre-recording duration. Unit: seconds. Valid values: 10 to 60.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y****', - ], + 'schema' => ['description' => 'The ID of the time template. You can call [QueryTimeTemplate](~~107890~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => 'fc82774fa749485bad7d719f9670****', 'title' => ''], ], ], 'responses' => [ @@ -1730,209 +1376,104 @@ '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' => 'request forbidden', - ], - 'Success' => [ - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'aEtMSm9****ORTFxcGpTbDZ****6eTk0', - ], - 'EventDesc' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'EventData' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the recording plan.', 'type' => 'string', 'example' => 'fc82774fa749485bad7d719f9670****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'product is not active.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'a195f615-8c64-4cc6-af57-2f42c6cca15c', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + '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' => 'QueryDeviceEvent', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"fc82774fa749485bad7d719f9670****\\",\\n \\"ErrorMessage\\": \\"product is not active.\\",\\n \\"RequestId\\": \\"a195f615-8c64-4cc6-af57-2f42c6cca15c\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create an event-triggered recording plan', + 'summary' => 'Creates a recording plan for intelligent alert event-triggered recording.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryDevicePictureFile' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEventRecordPlan'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:CreateEventRecordPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateGbDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'IotId', + 'name' => 'GbId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CaptureId', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fdc576d03c094faea9fa10fbf48c****', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ThumbWidth', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - 'default' => '0', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ExpireTime', + 'name' => 'DeviceType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - 'default' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'PictureType', + 'name' => 'SubProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '2', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'MediaNetProtocol', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y******', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -1940,314 +1481,238 @@ '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' => 'request forbidden', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'PicId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'R****bVhsNCjMjIy', - ], - 'PicUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***3D', - ], - 'PicCreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632453652222', - ], - 'ThumbUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***2Cq_90', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1CJ0***kQi1000000', - ], + 'DeviceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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 \\"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' => 'QueryDevicePictureFile', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryDevicePictureLifeCycle' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'The RAM user does not have permissions to access the resource.'], + ['errorCode' => 'iot.vision.GbServiceNotEnabled', 'errorMessage' => 'The GB28181 service has not been enabled.', 'description' => 'The standard service is not started.'], + ['errorCode' => 'iot.vision.GbIdDuplicate', 'errorMessage' => 'The GB28181 deviceId is duplicated.', 'description' => 'The standard ID already exists.'], + ], + 403 => [ + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGbDevice'], + ], ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateGbDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"DeviceName\\": \\"\\",\\n \\"IotId\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'CreateLocalFileUploadJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IotId', + 'name' => 'TimeSlot', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + 'description' => 'The list of time slots.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time for uploading the local recording. The value is a 10-digit UNIX timestamp. Unit: seconds.'."\n" + .'>The maximum time range for a single local recording upload task is 1 hour.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1631019775', 'title' => ''], + 'StartTime' => ['description' => 'The start time for uploading the local recording. The value is a 10-digit UNIX timestamp. Unit: seconds.'."\n" + .'>The maximum time range for a single local recording upload task is 1 hour.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1631019675', 'title' => ''], + 'ProductKey' => ['description' => 'The ProductKey of the product to which the video device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console or call [QueryProductList](~~69271~~) to view the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], + 'DeviceName' => ['description' => 'The name of the video device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], + 'IotId' => ['description' => 'The ID of the video device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** is the globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'd7XmBoJhAr88C6PelXDF00****', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value exists, you must specify this parameter. Otherwise, the call fails.'."\n" + .'- If <props="intl"><ph>the **Overview** page or </ph></props>no ID value is available, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0E2244FD-0AC9-4AB4-A8F0-729D78BE1D77', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tenant auth error', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The query result.', 'type' => 'object', 'properties' => [ - 'Day' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'JobId' => ['description' => 'The ID of the local recording upload node.'."\n" + .'>Keep the **JobId** safe. After the recording upload node is complete, use the **JobId** to query the task result of the local recording upload: [QueryLocalFileUploadJob](~~363004~~). You can also use the **JobId** to stop the local recording upload node as needed: [DeleteLocalFileUploadJob](~~363003~~).', 'type' => 'string', 'example' => '1ec1a2****d0435fbc0****34f6f139d', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryDevicePictureLifeCycle', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'CreateLocalFileUploadJob', + 'summary' => 'Creates a local recording upload task.', + 'description' => 'A single local recording upload task supports a maximum of 200 files. This means the TimeSlot list can contain up to 200 entries.', + 'requestParamsDescription' => ' When you invoke this operation, you must specify the request parameters described in this topic and the common request parameters. For the metric description of common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryDeviceVodUrlByTime' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLocalFileUploadJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateLocalFileUploadJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateLocalRecordDownloadByTimeJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Scheme', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rtmp', - 'default' => 'rtmp', - ], - ], - [ - 'name' => 'SeekTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483648', - 'minimum' => '0', - 'example' => '0', - 'default' => '0', - ], - ], - [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y****', - ], + 'schema' => ['description' => 'The instance ID. You can view the ID of the current instance on the **Overview** tab of the IoT Platform console.', 'type' => 'string', 'required' => true, 'example' => 'iot-******', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the video device belongs.'."\n" + ."\n" + .'You can view the information about all products under the current instance on the **Products** page of the IoT Platform console or by calling the [QueryProductList](~~69271~~) operation.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1Bw******', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], - ], - [ - 'name' => 'EnableStun', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['description' => 'The device name of the video device. You can view the **DeviceName** of devices under a specified product on the **Devices** page of the IoT Platform console or by calling the [QueryDevice](~~69905~~) operation.'."\n" + ."\n\n" + .'><notice>If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'Device01', 'title' => ''], ], [ - 'name' => 'ShouldEncrypt', + 'name' => 'Speed', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'The upload speed multiplier of the device. Default value: **1.0**. Valid values: **0.125** to **8.0**.', 'type' => 'number', 'format' => 'float', 'required' => false, 'default' => '1.0', 'example' => '1.0', 'title' => ''], ], [ 'name' => 'BeginTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '2147483648', - 'minimum' => '0', - 'example' => '1508200012', - ], + 'schema' => ['description' => 'The start time, in the format of a 10-digit UNIX timestamp. Unit: seconds. Valid values: 0 to 2147483647.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '2147483648', 'minimum' => '0', 'example' => '1900000000', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], - ], - [ - 'name' => 'UrlValidDuration', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - ], - [ - 'name' => 'PlayUnLimited', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'The device ID of the video device. You can call the [QueryDeviceDetail](~~69594~~) operation to query the device ID.'."\n" + ."\n" + .'><notice>'."\n" + .'**IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '2147483648', - 'minimum' => '0', - 'example' => '1582420940', - ], - ], - [ - 'name' => 'EncryptType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483648', - 'minimum' => '0', - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The end time, in the format of a 10-digit UNIX timestamp. Unit: seconds. Valid values: 0 to 2147483647. The value must be greater than the value of **BeginTime**.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '9999999999999', 'minimum' => '0', 'example' => '2100000000', 'title' => ''], ], ], 'responses' => [ @@ -2255,114 +1720,116 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tenant auth error', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code of the call.'."\n" + ."\n" + .'- A value of 200 indicates success.'."\n" + .'- Other values indicate failure. For more information, see **Error codes** in this topic.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Download job error.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The data returned if the call is successful.', 'type' => 'object', 'properties' => [ - 'DecryptKey' => [ - 'description' => '', - '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', - ], + 'JobId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'w2s******', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryDeviceVodUrlByTime', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.DownloadJobError', 'errorMessage' => 'Download job error.', 'description' => 'An exception occurred on the download task.'], + ['errorCode' => 'iot.vision.ConcurrencyExceedLimit', 'errorMessage' => 'Concurrency exceed the limit.', 'description' => 'The number of concurrent threads exceeds the limit.'], + ['errorCode' => 'iot.vision.StreamPushFailed', 'errorMessage' => 'Stream push failed.', 'description' => 'The stream ingest failed.'], + ['errorCode' => 'iot.vision.DeviceOffline', 'errorMessage' => 'Device is offline.', 'description' => 'The device is offline.'], + ], + 403 => [ + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'CreateLocalRecordDownloadByTimeJob', + 'summary' => 'Creates a task to download local recordings by time.', + 'description' => '## Limits'."\n" + ."\n" + .'- The maximum duration for a single time-based download is 30 minutes.'."\n" + .'- Download nodes and files are retained for up to 1 day. After the timeout, you can download the files again.'."\n" + .'- A maximum of 10 concurrent download nodes are supported per instance. Completed downloads are not counted.'."\n" + .'- If audio or video encoding parameters change, the downloaded recording contains only the first half of the recording by default.'."\n" + .'- Due to fluctuations in the upstream network of the device, the link may be abnormally disconnected or the device may actively discard data. As a result, the uploaded and downloaded recordings may be incomplete.'."\n" + .'- The downloaded recording data depends on the stream pushing logic of the device. If the stream pushing data is abnormal, the duration of the downloaded recording may be inconsistent with the time range in the node settings.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'Each Alibaba Cloud account can invoke this operation up to 50 times per second (QPS).'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you invoke this operation. For more information about common request parameters and their metric descriptions, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryFaceAllDeviceGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLocalRecordDownloadByTimeJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateLocalRecordDownloadByTimeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreatePictureSearchApp' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'IsolationId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', - ], - ], - [ - 'name' => 'IotInstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestIotInstanceId', - ], + 'schema' => ['description' => 'The name of the image search application instance. '."\n" + ."\n" + .'The name can contain Chinese characters, letters, digits, underscores (_), and hyphens (-). The name can be up to 64 characters in length. Each Chinese character counts as two characters.', 'type' => 'string', 'required' => true, 'example' => '以图搜图', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Desc', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The description of the image search application instance.'."\n" + ."\n" + .'The description can contain Chinese characters, letters, digits, underscores (_), and hyphens (-). The description can be up to 1,024 characters in length. Each Chinese character counts as two characters.', 'type' => 'string', 'required' => true, 'example' => '以图搜图Demo', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Instance Overview** page in the IoT Platform console. If an ID value exists, you must specify this ID value. Otherwise, the call fails.'."\n" + ."\n" + .'> If the public instance does not have an ID value, refer to [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot_instc_pu****_c*-v64********', 'title' => ''], ], ], 'responses' => [ @@ -2370,164 +1837,105 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'wy250q0m', - ], - 'ModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-05-12 17:19:29', - ], - 'DeviceGroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestDeviceGroupName', - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + .'- **200**: Success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The instance ID of the image search application.', 'type' => 'string', 'example' => '5a502d3fbab8410e8fd4be9037c7****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Name is mandatory for this action.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '3A754C90-1286-4C2C-A3BA-8BF5BAD4BF76', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryFaceAllDeviceGroup', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'CreatePictureSearchApp', + 'summary' => 'Creates an image search application instance.', + 'description' => '## Before you begin'."\n" + .'The maximum number of queries per second (QPS) for a single Alibaba Cloud account that can invoke this operation is 100.'."\n" + .' > Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when calling this operation. For more information, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryFaceDeviceGroupsByDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePictureSearchApp'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:CreatePictureSearchApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreatePictureSearchJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'AppInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', - ], + 'schema' => ['description' => 'Instance ID of the image search application instance. You can call [QueryPictureSearchApps](~~206608~~) to query instance ID.', 'type' => 'string', 'required' => true, 'example' => '3e429560124b44b685095df81a27****', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'SearchPicUrl', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIotInstanceId', - ], + 'schema' => ['description' => 'The URL of the image to be searched.', 'type' => 'string', 'required' => true, 'example' => 'http://xxx.xxx/1.jpg', 'title' => ''], ], [ - 'name' => 'ProductKey', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestProductKey', - ], + 'schema' => ['description' => 'The start time of the search range. The value is a 13-digit UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9999999999999', 'minimum' => '0', 'example' => '1614227915000', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestDeviceName', - ], + 'schema' => ['description' => 'The end time of the search range. The value is a 13-digit UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9999999999999', 'minimum' => '0', 'example' => '1614327915000', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Threshold', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The face search threshold. Valid values: 0 to 1.'."\n" + ."\n" + .'To ensure the accuracy of search results, set this parameter to a value between 0.3 and 0.6.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '0.5', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'BodyThreshold', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The body search threshold. Valid values: 0 to 1.'."\n" + ."\n" + .'To ensure the accuracy of search results, set this parameter to a value greater than or equal to 0.8. If this parameter is not specified, the value of the Threshold parameter is used.', 'type' => 'number', 'format' => 'float', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'default' => '0.8', 'example' => '0.9', 'title' => ''], + ], + [ + 'name' => 'PictureSearchType', + 'in' => 'query', + 'schema' => ['description' => 'The search type. Valid values:'."\n" + ."\n" + .'- 1: face'."\n" + .'- 0: body'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -2535,243 +1943,228 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'TestDeviceGroupId', - ], - 'ModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-05-12 17:12:37', - ], - 'DeviceGroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestDeviceGroupName', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the image search task.', 'type' => 'string', 'example' => '71632df011294a85910c566e7181****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'The request has failed due to a temporary failure of the server.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FAEBE068-07DE-4B88-AC2A-51FC2B556211', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryFaceDeviceGroupsByDevice', - 'requestParamsDescription' => ' ', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Forbidden.RiskControl', 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Create image search job', + 'summary' => 'Creates an integrated image search task that searches by image.', + 'description' => 'Integrated image search refers to simultaneously retrieving both face and body features when searching by image.'."\n" + .'> This feature requires the deployment of face and body detection algorithms on V-series edge devices.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you invoke this operation. For the metric description of common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryLiveStreaming' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePictureSearchJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:CreatePictureSearchJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateRecordDownloadByTimeJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Scheme', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rtmp', - 'default' => 'rtmp', - ], - ], - [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'The instance ID. You can view the ID of the current instance on the **Overview** tab of the IoT Platform console.', 'type' => 'string', 'required' => true, 'example' => 'iot-******', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the video device belongs.'."\n" + ."\n" + .'You can view the information about all products under the current instance on the **Products** page of the [IoT Platform console](https://iot.console.aliyun.com/product) or by calling the [QueryProductList](~~69271~~) operation.'."\n" + ."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1Bw******', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The name of the video device. You can view the **DeviceName** of devices under a specified product on the **Devices** page of the [IoT Platform console](https://iot.console.aliyun.com/devices) or by calling the [QueryDevice](~~69905~~) operation.'."\n" + ."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'Device01', 'title' => ''], ], [ - 'name' => 'EnableStun', + 'name' => 'StreamType', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['description' => 'The stream type. Valid values:'."\n" + ."\n" + .'- **0** (default): main stream.'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], ], [ - 'name' => 'StreamType', + 'name' => 'BeginTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The start time, in the format of a 10-digit UNIX timestamp. Unit: seconds. Value range: 0 to 2147483647.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '2147483648', 'minimum' => '0', 'example' => '1900000000', 'title' => ''], ], [ - 'name' => 'CacheDuration', + 'name' => 'RecordType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '0', - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The recording type. Valid values:'."\n" + ."\n" + .'- **0**: continuous recording.'."\n" + .'- **1**: event-triggered recording.'."\n" + .'- **2**: active recording.'."\n" + .'- **4**: local-to-cloud recording.'."\n" + .'- **Empty**: all recordings.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'schema' => ['description' => 'The device ID of the video device. You can call the [QueryDeviceDetail](~~69594~~) operation to query the device ID.'."\n" + ."\n" + .'><notice> **IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], [ - 'name' => 'ShouldEncrypt', + 'name' => 'EndTime', 'in' => 'query', + 'schema' => ['description' => 'The end time, in the format of a 10-digit UNIX timestamp. Unit: seconds. Value range: 0 to 2147483647. The value must be greater than the value of **BeginTime**.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '9999999999999', 'minimum' => '0', 'example' => '2100000000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The status code of the call.'."\n" + ."\n" + .'- A value of 200 indicates that the call was successful.'."\n" + .'- Other values indicate that the call failed. For more information, see **Error codes** in this topic.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'Record not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned if the call was successful.', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'w2s******', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.RecordNotExist', 'errorMessage' => 'Record not exist.', 'description' => 'The video file does not exist.'], + ['errorCode' => 'iot.vision.DownloadJobError', 'errorMessage' => 'Download job error.', 'description' => 'An exception occurred on the download task.'], + ['errorCode' => 'iot.vision.ConcurrencyExceedLimit', 'errorMessage' => 'Concurrency exceed the limit.', 'description' => 'The number of concurrent threads exceeds the limit.'], + ], + 403 => [ + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'CreateRecordDownloadByTimeJob', + 'summary' => 'Creates a task to download cloud recordings by time.', + 'description' => '## Limits'."\n" + ."\n" + .'- Maximum duration per time-based download: 30 minutes.'."\n" + .'- Download time precision: The download time range is accurate to within 10 seconds. For example, if you select 20 seconds of data to download, up to 30 seconds of data may be downloaded.'."\n" + .'- Maximum number of recording files per time-based download: 100.'."\n" + .'- Download nodes and files are retained for up to 1 day. After the timeout, you can download them again.'."\n" + .'- Maximum number of concurrent downloads per instance: 10 (completed downloads are not counted).'."\n" + .'- If the audio or video encoding parameters change, the first half of the recording is downloaded by default.'."\n" + .'- If the download time ranges overlap, the cloud deduplicates the overlapping data.'."\n" + ."\n\n" + .'## QPS limit'."\n" + ."\n" + .'Each Alibaba Cloud account can invoke this operation up to 50 times per second (QPS).'."\n" + ."\n" + .'> The quota is shared among all Resource Access Management (RAM) users under a single Alibaba Cloud account.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For the metric description of common request parameters, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRecordDownloadByTimeJob'], + ], + ], + 'ramActions' => [ [ - 'name' => 'UrlValidDuration', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateRecordDownloadByTimeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateRecordPlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PlayUnLimited', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ [ - 'name' => 'EncryptType', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '0', - ], + 'schema' => ['description' => 'The name of the recording plan.'."\n" + ."\n" + .'The name must be fewer than 48 characters in length and can contain letters, digits, and the following special characters: hyphens (-), underscores (_), at signs (@), periods (.), and colons (:).', 'type' => 'string', 'required' => true, 'example' => 'plan1', 'title' => ''], ], [ - 'name' => 'ForceIFrame', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the time template associated with the recording plan. You can call [CreateTimeTemplate](~~107888~~) to query the template ID.', 'type' => 'string', 'required' => true, 'example' => '36f06322442e4e3f85a5ae8862c9****', 'title' => ''], ], ], 'responses' => [ @@ -2779,119 +2172,101 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'stream push failed', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtmp://47.100.***.***:8000/live?token=dc1****120ce394ef94974/Eb****6RBe8l4_0', - ], - 'RelayDecryptKey' => [ - 'type' => 'string', - ], - 'StunInfo' => [ - 'type' => 'string', - ], - ], - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the recording plan.', 'type' => 'string', 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"5b60bf0dd55944c19d7817442bc9****\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create a recording plan', + 'summary' => 'Creates a recording plan based on a time template.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryVoiceIntercom' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRecordPlan'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:CreateRecordPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateRtmpDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Scheme', + 'name' => 'PullKeyExpireTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'default' => 'rtmp', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '3600', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y*****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'IotId', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PushKeyExpireTime', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '3600', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PushAuthKey', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PullAuthKey', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'SubStreamName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -2899,72 +2274,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tenant auth error', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtmp://106.15.xxx.xxx:8000/talk?token=xxxxxxx', - ], - 'CryptoKey' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'bPvz6tnfonP1E+********v2Q==', - ], - 'Iv' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MDEyMzQ1Njc4********0+Pw==', - ], - ], - ], + 'DeviceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StreamName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryVoiceIntercom', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RemoveFaceDeviceFromDeviceGroup' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.RequestParameterError', 'errorMessage' => 'Request parameter error:%s', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.vision.DeviceNameDuplicate', 'errorMessage' => 'Device name duplicate.', 'description' => 'The DeviceName already exists.'], + ['errorCode' => 'iot.vision.StreamNameDuplicate', 'errorMessage' => 'Stream name duplicate.', 'description' => 'The stream name already exists.'], + ['errorCode' => 'iot.vision.RequestError', 'errorMessage' => 'Request error.', 'description' => 'The request failed.'], + ], + 403 => [ + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRtmpDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateRtmpDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"DeviceName\\": \\"\\",\\n \\"StreamName\\": \\"\\",\\n \\"IotId\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'CreateStreamPushJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2973,129 +2344,54 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the device belongs.'."\n" + .'You can view it on the **Products** page of the IoT Platform console, or call [QueryProductList](~~69271~~) to view information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestIotInstanceId', - ], + 'schema' => ['description' => 'The name of the device.'."\n" + .'You can view **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'ProductKey', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestProductKey', - ], + 'schema' => ['description' => 'The ID of the device. This is the ID issued by IoT Platform for the device, serving as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> As the unique identifier of a device, **IotId** has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'd7XmBoJhAr88C6PelXDF00****', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestDeviceName', - ], + 'schema' => ['description' => 'The ID of the instance. You can view the ID of the current instance on the **Overview** tab of the IoT Platform console.', 'type' => 'string', 'required' => true, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ - 'name' => 'DeviceGroupId', + 'name' => 'StreamType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestDeviceGroupId', - ], + 'schema' => ['description' => 'The type of stream.'."\n" + ."\n" + .'- **0** (default): main stream.'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - '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' => 'RemoveFaceDeviceFromDeviceGroup', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'AddFaceUserGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'PushUrl', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ZheJiangHZ', - ], + 'schema' => ['description' => 'The push streaming URL. The maximum length is 500 bytes.', 'type' => 'string', 'required' => true, 'example' => 'rtmp://****', 'title' => ''], ], [ - 'name' => 'UserGroupName', + 'name' => 'JobType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestUserGroup', - ], + 'schema' => ['description' => 'The type of the stream push job.'."\n" + ."\n" + .'- **1** (default): continuous job.'."\n" + .'- **2**: triggered job, which ends after interruption.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -3103,104 +2399,130 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'group already exist', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '403', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request forbidden.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The result returned if the call is successful.', 'type' => 'object', 'properties' => [ - 'UserGroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestUserGroup', - ], - 'ModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-11-20 18:59:01', - ], - 'UserGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'kvjy****', - ], + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '23***********', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'AddFaceUserGroup', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.StreamPushFailed', 'errorMessage' => 'Stream push failed.', 'description' => 'The stream ingest failed.'], + ['errorCode' => 'iot.vision.DeviceOffline', 'errorMessage' => 'Device is offline.', 'description' => 'The device is offline.'], + ['errorCode' => 'iot.vision.DeviceNotStreaming', 'errorMessage' => 'Device is not streaming.', 'description' => 'The device does not ingest streams.'], + ['errorCode' => 'iot.vision.ConcurrencyExceedLimit', 'errorMessage' => 'Concurrency exceed the limit.', 'description' => 'The number of concurrent threads exceeds the limit.'], + ], + 403 => [ + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'CreateStreamPushJob', + 'summary' => 'Creates a video stream push job.', + 'description' => '## QPS limit'."\n" + ."\n" + .'The maximum number of queries per second (QPS) for a single Alibaba Cloud account calling this operation is 50.'."\n" + ."\n" + .'> All RAM users under a single Alibaba Cloud account share this quota.', + 'requestParamsDescription' => 'When you call this API operation, in addition to the operation-specific request parameters described in this topic, you must also include common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddFaceUserToUserGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamPushJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateStreamPushJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateStreamSnapshotJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ZheJiangHZ', - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console or call [QueryProductList](~~69271~~) to query the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'UserId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3mtjaqebeq4d****', - ], + 'schema' => ['description' => 'The name of the device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'UserGroupId', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'kvjy****', - ], + 'schema' => ['description' => 'The ID of the device. This is a unique identifier issued by IoT Platform for the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> **IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'd7XmBoJhAr88C6PelXDF00****', 'title' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can view the ID of the current instance on the **Overview** tab of the IoT Platform console.', 'type' => 'string', 'required' => true, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => ['description' => 'The stream type.'."\n" + ."\n" + .'- **0** (default): main stream.'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'SnapshotInterval', + 'in' => 'query', + 'schema' => ['description' => 'The interval between snapshots. Valid values: 60 to 1800. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1800', 'minimum' => '60', 'example' => '600', 'title' => ''], ], ], 'responses' => [ @@ -3208,73 +2530,117 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '403', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request auth failed.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'AddFaceUserToUserGroup', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.NoStorageQuota', 'errorMessage' => 'No storage quota.', 'description' => 'The storage quota is exceeded.'], + ['errorCode' => 'iot.vision.RequestError', 'errorMessage' => 'Request error.', 'description' => 'The request failed.'], + ], + 403 => [ + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"403\\",\\n \\"ErrorMessage\\": \\"Request auth failed.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateStreamSnapshotJob', + 'summary' => 'Creates a cloud snapshot task by calling the CreateStreamSnapshotJob operation.', + 'description' => '## QPS limit'."\n" + ."\n" + .'You can invoke this operation up to 50 times per second per Alibaba Cloud account.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users within an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For the metric description of common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteFaceUserGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamSnapshotJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateStreamSnapshotJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateTimeTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'TimeSections', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ZheJiangHZ', + 'description' => 'The list of time ranges.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DayOfWeek' => ['description' => 'The day of the week. Valid values: 0 to 6, which represent Sunday through Saturday.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Begin' => ['description' => 'The start time of each day. Valid values: 0 to 86399. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20000', 'title' => ''], + 'End' => ['description' => 'The end time of each day. Valid values: 1 to 86399. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60000', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 1000, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UserGroupId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'kvjy****', - ], + 'schema' => ['description' => 'The name of the time template.'."\n" + ."\n" + .'The name must be fewer than 48 characters in length and can contain letters, digits, and the following special characters: hyphens (-), underscores (_), at signs (@), periods (.), and colons (:).', 'type' => 'string', 'required' => true, 'example' => 'example', 'title' => ''], + ], + [ + 'name' => 'AllDay', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable 24/7 recording. Valid values:'."\n" + .'- 1: Yes.'."\n" + .'- 0: No. You must configure the TimeSections.N.DayOfWeek, TimeSections.N.Begin, and TimeSections.N.End parameters.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -3282,83 +2648,96 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the time template.', 'type' => 'string', 'example' => '38c94f874f2e4ce3b4b6da36****5213', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"38c94f874f2e4ce3b4b6da36****5213\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateTimeTemplate', + 'summary' => 'Creates a time template.', + 'requestParamsDescription' => 'When you call this API operation, in addition to the operation-specific request parameters described in this topic, you must also include common request parameters. For metric description of common request parameters, see [Common parameters](~~141505~~).'."\n" + ."\n" + .'**Time template configuration examples**.'."\n" + ."\n" + .' Example 1: A continuous time range within a week. For example, record from Saturday 08:00 to Sunday 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" + .' &<Common request parameters>'."\n" + .' ```.'."\n" + ."\n" + .'Example 2: 24/7 recording throughout the week.'."\n" + ."\n" + .' ```'."\n" + .' http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=CreateTimeTemplate'."\n" + .' &Name=example'."\n" + .' &AllDay=1'."\n" + .' &<Common request parameters>'."\n" + .' ```.'."\n" + ."\n" + .'Example 3: Multiple time ranges within a single day of the week. For example, record every Monday from 08:00 to 11:00 and from 13:00 to 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" + .' &<Common request parameters>'."\n" + .' ```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateFaceUserGroupAndDeviceGroupRelation' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTimeTemplate'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:CreateTimeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteEventRecordPlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'IsolationId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ZheJiangHZ', - ], - ], - [ - 'name' => 'ControlId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'qcb2yea4ha4d****', - ], - ], - [ - 'name' => 'Relation', + 'name' => 'PlanId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'SYNC_INFO_PICTURE', - ], + 'schema' => ['description' => 'The ID of the intelligent alert event recording plan. You can call [QueryEventRecordPlans](~~107907~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '2e34a1989aa54debac22358aca7f****', 'title' => ''], ], ], 'responses' => [ @@ -3366,129 +2745,94 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ControlId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qcb2yea4ha4d****', - ], - 'ModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-04-25 19:29:30', - ], - ], - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '438A20F2-AFF2-4CAC-89F9-3378EAA133BD', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'UpdateFaceUserGroupAndDeviceGroupRelation', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"438A20F2-AFF2-4CAC-89F9-3378EAA133BD\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete an event-triggered recording plan', + 'summary' => 'Deletes an intelligent event recording plan.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when calling this operation. For more information, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateFaceUser' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventRecordPlan'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteEventRecordPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteEventRecordPlanDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'IsolationId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolati****', - ], - ], - [ - 'name' => 'UserId', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'tibce3fsgqel****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Instance Overview** page in the IoT Platform console. If an ID value exists, you must specify this ID value. Otherwise, the call will fail.'."\n" + ."\n" + .'> If the public instance does not have an ID value, see [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ZhangSan', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to view information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'Params', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"age":28, "sex":"male"}', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'FacePicUrl', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'https://test.com/test.jpg', - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform to the device and serves as the unique identifier of the device.'."\n" + ."\n" + .'You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], ], [ - 'name' => 'CustomUserId', + 'name' => 'StreamType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '52242819650301xxxx', - ], + 'schema' => ['description' => 'The stream type:'."\n" + .'- **0** (default): main stream.'."\n" + .'- **1**: sub stream.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -3496,86 +2840,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: indicates success.'."\n" + .'- Other values: indicate error codes. For more information about error codes, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'UpdateFaceUser', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete event-triggered recording plan device', + 'summary' => 'Deletes the IPC device associated with a smart alarm event recording plan.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common request parameters when you call the API operation. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryFaceAllUserGroupAndDeviceGroupRelation' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventRecordPlanDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteEventRecordPlanDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteFaceDeviceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Isolati***', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'DeviceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The device group ID.', 'type' => 'string', 'required' => true, 'example' => 'qaf2tihq', 'title' => ''], ], ], 'responses' => [ @@ -3583,132 +2909,63 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'TestDeviceGro****', - ], - 'ControlId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'TestUserGro****', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryFaceAllUserGroupAndDeviceGroupRelation', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete a device group', + 'summary' => 'Deletes a device group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryFaceUserGroupAndDeviceGroupRelation' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaceDeviceGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteFaceDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteFaceUser' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', - ], + 'schema' => ['description' => 'The business isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHzXiHu', 'title' => ''], ], [ - 'name' => 'ControlId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ni1iyxqry0j03plv', - ], + 'schema' => ['description' => 'The unique internal user ID in the face service.', 'type' => 'string', 'required' => true, 'example' => '3mtjaqebeq4dulcy', 'title' => ''], ], ], 'responses' => [ @@ -3716,219 +2973,63 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'TestDeviceGroupId', - ], - 'ControlId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'TestUserGroupId', - ], - ], - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryFaceUserGroupAndDeviceGroupRelation', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete a user from the face management service', + 'summary' => 'Deletes a user from the face management service.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryFaceUserIdByCustomUserId' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaceUser'], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'IsolationId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', - ], - ], - [ - 'name' => 'CustomUserId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestCustomUserId', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'TestCustomUserId', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestName', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestUserId', - ], - ], - ], + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteFaceUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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' => 'QueryFaceUserIdByCustomUserId', ], - 'QueryFaceAllUserGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteFaceUserGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', - ], + 'schema' => ['description' => 'The business isolation ID, used to isolate data between different business applications under the same Alibaba Cloud account. This value must be consistent with the **IsolationId** set when adding a user by calling the [AddFaceUserGroup](~~288341~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHZ', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'UserGroupId', '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', - ], + 'schema' => ['description' => 'The user group ID. Set this parameter to the user group ID that was obtained and saved locally after you called the [AddFaceUserGroup](~~288341~~) operation to add a user group.', 'type' => 'string', 'required' => true, 'example' => 'kvjy****', 'title' => ''], ], ], 'responses' => [ @@ -3936,144 +3037,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'dmjpxfdk', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + .'- **200**: The request was successful.'."\n" + .'- Other codes: An error occurred. For more information about error codes, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'face group not exist', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + .'- **true**: The request was successful.'."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryFaceAllUserGroup', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"face group not exist\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteFaceUserGroup', + 'summary' => 'Deletes a specified user group.', + 'description' => '## Limits'."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account for calling this operation is 100.'."\n" + .' > RAM users share the quota of the Alibaba Cloud account.', + 'requestParamsDescription' => 'When you call this operation, you must include common request parameters in addition to the request parameters described in this topic. For more information about common request parameters, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryFaceAllUserIdsByGroupId' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaceUserGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteFaceUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteFaceUserGroupAndDeviceGroupRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', - ], - ], - [ - 'name' => 'UserGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestUserGroupId', - ], + 'schema' => ['description' => 'The business isolation ID that isolates data between different business applications under the same Alibaba Cloud account. Set this parameter to the same value of **IsolationId** that you specified when you called the [AddFaceUserGroupAndDeviceGroupRelation](~~288342~~) operation to add the facial recognition synchronization relationship between the user group and the device group.', 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHZ', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '20', - ], - ], - [ - 'name' => 'PageNo', + 'name' => 'ControlId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The control ID of the synchronization relationship between the user group and the device group. Set this parameter to the value of **ControlId** that you obtained and saved locally when you called the [AddFaceUserGroupAndDeviceGroupRelation](~~288342~~) operation to add the facial recognition synchronization relationship between the user group and the device group.', 'type' => 'string', 'required' => true, 'example' => 'qcb2yea4ha4d****', 'title' => ''], ], ], 'responses' => [ @@ -4081,204 +3108,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'TestCustomUserId', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestName', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestUserId', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'access control not exist', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryFaceAllUserIdsByGroupId', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"access control not exist\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete face sync relationship between user group and device group', + 'summary' => 'Deletes the facial recognition synchronization relationship between a user group and a device group.', + 'description' => '## Before you begin'."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account for this operation is 100.'."\n" + .' > Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.', + 'requestParamsDescription' => ' When you invoke this operation, you must specify common request parameters in addition to the operation-specific request parameters described in this topic. For more information about common request parameters, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryFaceCustomUserIdByUserId' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaceUserGroupAndDeviceGroupRelation'], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'IsolationId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', - ], - ], + 'ramActions' => [ [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestUserId', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestCustomUserId', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteFaceUserGroupAndDeviceGroupRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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' => 'QueryFaceCustomUserIdByUserId', ], - 'QueryFaceUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteFaceUserPicture' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', - ], + 'schema' => ['description' => 'The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set this parameter to the same value of **IsolationId** that you specified when you called the [AddFaceUser](~~288338~~) operation to add the user.', 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHZ', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestUserId', - ], + 'schema' => ['description' => 'The user ID. Set this parameter to the **UserId** value that you obtained and saved locally after calling the [AddFaceUser](~~288338~~) operation to add the user.', 'type' => 'string', 'required' => true, 'example' => '3mtjaqebeq4d****', 'title' => ''], + ], + [ + 'name' => 'FacePicMd5', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the user\'s face image. Set this parameter to the **Data** value that you obtained and saved locally after calling the [AddFaceUserPicutre](~~312040~~) operation to add a face image for the user.', 'type' => 'string', 'required' => true, 'example' => '1bb580ef7****', 'title' => ''], ], ], 'responses' => [ @@ -4286,184 +3184,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'TestCustomUserId', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestName', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestUserId', - ], - 'FacePicList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FaceUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://test.com/xxx.jpg', - ], - 'FaceMd5' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'TestFaceMd5', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '4de2c367-c1db-417c-aa15-8c585e595d92', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'face user not exist', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryFaceUser', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"4de2c367-c1db-417c-aa15-8c585e595d92\\",\\n \\"ErrorMessage\\": \\"face user not exist\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteFaceUserPicture', + 'summary' => 'Deletes a specified face image from a user in the face database.', + 'description' => '## Before you begin'."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account for invoking this operation is 100.'."\n" + .' > Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryFaceUserGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaceUserPicture'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteFaceUserPicture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteGbDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'UserId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestUserId', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -4471,94 +3265,52 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'TestUserGroupId', - ], - ], - ], - ], - ], - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryFaceUserGroup', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RemoveFaceUserFromUserGroup' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'The RAM user does not have permissions to access the resource.'], + ], + 403 => [ + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGbDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteGbDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + ], + 'DeleteLocalFileUploadJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4567,34 +3319,18 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IsolationId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestIsolationId', - ], - ], - [ - 'name' => 'UserId', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestUserId', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console. If the ID value exists, you must specify this ID. Otherwise, the call fails.'."\n" + ."\n" + .'> If no ID value is available for the public instance, see [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ - 'name' => 'UserGroupId', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestUserGroupId', - ], + 'schema' => ['description' => 'The ID of the local recording upload task, which is generated by calling [CreateLocalFileUploadJob](~~363002~~).', 'type' => 'string', 'required' => true, 'example' => '1ec1a2****d0435fbc0****34f6f139d', 'title' => ''], ], ], 'responses' => [ @@ -4602,104 +3338,113 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: The request was successful.'."\n" + .'- Other values: An error occurred. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'This response parameter is empty.', 'type' => 'object', 'example' => ' {}', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'RemoveFaceUserFromUserGroup', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {},\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Stop a local recording upload task', + 'summary' => 'Stops a local recording upload task.', + 'description' => 'After you stop a local recording upload task, the recording files that are already created are not deleted.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must specify common request parameters when you invoke this API operation. For more information about common request metric description, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddFaceUser' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLocalFileUploadJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteLocalFileUploadJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeletePicture' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'PictureIdList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The list of image IDs. Image IDs are generated when you call [TriggerCapturePicture](~~107914~~).'."\n" + ."\n" + .'> A maximum of 50 image IDs can be specified in a single call.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, - 'example' => 'ZheJiangHZ', + 'example' => 'cFc5MzZ****npYT1***TDFzX1hrVzA0Z****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'FacePicUrl', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'https://example.com/test.jpeg', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console, or call [QueryProductList](~~69271~~) to query the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'CustomUserId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1234567890', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Tony', - ], + 'schema' => ['description' => 'The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** is the globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => '1CJ0****e7qiq8VkQi1000000', 'title' => ''], ], [ - 'name' => 'Params', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"key1":"value1", "key2":"value2"}', - ], + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Overview** page of the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value exists, you must specify this parameter. Otherwise, the call fails.'."\n" + .'- If <props="intl"><ph>the **Overview** page or </ph></props>no ID value is available, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y******', 'title' => ''], ], ], 'responses' => [ @@ -4707,129 +3452,128 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'request forbidden', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'Params' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"key1":"value1", "key2":"value2"}', - ], - 'CustomUserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1234567890', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Tony', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3mtjaqebeq4d****', - ], + 'DeletedCount' => ['description' => 'The number of cloud images that were successfully deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'AddFaceUser', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.lv.requestError', 'errorMessage' => 'Request error', 'description' => 'Request error'], + ], + 403 => [ + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'DeletePicture', + 'summary' => 'Deletes cloud images in a batch by specifying image IDs for a specified IPC device.', + 'requestParamsDescription' => 'When you call this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For the metric description of common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddFaceUserGroupAndDeviceGroupRelation' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePicture'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeletePicture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteRecord' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'FileNameList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The list of recording file names to be deleted. You can call [QueryRecord](~~107922~~) to obtain the recording file names.'."\n" + ."\n" + .'> A maximum of 50 recording files can be deleted at a time.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, - 'example' => 'TestIsolationId', + 'example' => 'file1', + 'maxItems' => 50, + 'title' => '', ], ], [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestInstanceId', - ], + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Instance Overview** page of the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value is available, you must specify this ID value. Otherwise, the call will fail.'."\n" + .'- If no <props="intl"><ph>**Instance Overview** page or </ph></props>ID value is available, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Instance overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-060a****', 'title' => ''], ], [ - 'name' => 'UserGroupId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'avjyxurd', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console, or call [QueryProductList](~~69271~~) to view the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'DeviceGroupId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'kvjyhurc', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'Relation', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'SYNC_INFO_PICTURE', - ], + 'schema' => ['description' => 'The ID of the IPC device. This is the ID issued by IoT Platform to the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** and **DeviceName**. **IotId** is the unique identifier of a device, and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'd7XmBoJhAr88C6PelXDF00****', 'title' => ''], ], ], 'responses' => [ @@ -4837,99 +3581,73 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other codes: Error codes. For more information about error codes, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'ControlId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qcb2yea4ha4dxmly', - ], - 'ModifiedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-11-20 18:59:01', - ], + 'DeletedCount' => ['description' => 'The number of recording files that were successfully deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'AddFaceUserGroupAndDeviceGroupRelation', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Delete cloud-stored recording files', + 'summary' => 'Deletes cloud-stored recording files.', + 'requestParamsDescription' => ' When you call this API operation, in addition to the request parameters described in this topic, you must also specify common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddFaceUserPicture' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRecord'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteRecordPlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'IsolationId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ZheJiangHZ', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3mtjaqebeq4d****', - ], - ], - [ - 'name' => 'FacePicUrl', + 'name' => 'PlanId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'https://example.com/test.jpeg', - ], + 'schema' => ['description' => 'The ID of the recording plan. You can call [QueryRecordPlans](~~107896~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '6c5a397bc17c4b48ace86f0f0c30****', 'title' => ''], ], ], 'responses' => [ @@ -4937,78 +3655,96 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'request forbidden.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"request forbidden.\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete a recording plan', + 'summary' => 'Deletes a recording plan.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteFaceUser' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRecordPlan'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteRecordPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteRecordPlanDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ZheJiangHzXiHu', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Instance Overview** page in the IoT Platform console. If an ID value exists, you must specify this ID value. Otherwise, the call fails.'."\n" + ."\n" + .'> If no ID value exists for the public instance, refer to [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ - 'name' => 'UserId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3mtjaqebeq4dulcy', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to query information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => ['description' => 'The device name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. IotId, as the unique identifier of a device, has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify **IotId** together with the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => ['description' => 'The stream type. Valid values:'."\n" + ."\n" + .'- **0**: main stream.'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -5016,74 +3752,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, refer to [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'DeleteFaceUser', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete recording plan execution device', + 'summary' => 'Deletes the recording plan associated with an IPC device.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify common request parameters in addition to the operation-specific request parameters described in this topic. For the metric description of common request parameters, refer to [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteFaceUserGroupAndDeviceGroupRelation' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRecordPlanDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteRecordPlanDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteRtmpDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ZheJiangHZ', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ControlId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'qcb2yea4ha4d****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -5091,83 +3828,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'DeleteFaceUserGroupAndDeviceGroupRelation', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteFaceUserPicture' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.RequestParameterError', 'errorMessage' => 'Request parameter error:%s', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.vision.RequestError', 'errorMessage' => 'Request error.', 'description' => 'The request failed.'], + ], + 403 => [ + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRtmpDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteRtmpDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + ], + 'DeleteRtmpKey' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ZheJiangHZ', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'UserId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3mtjaqebeq4d****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'FacePicMd5', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1bb580ef7****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -5175,45 +3915,54 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CheckFaceUserDoExistOnDevice' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.RequestParameterError', 'errorMessage' => 'Request parameter error:%s', 'description' => 'The request parameter is invalid.'], + ], + 403 => [ + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRtmpKey'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteRtmpKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + ], + 'DeleteStreamPushJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5222,54 +3971,38 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a103lZ86ovStDMnU', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the device belongs.'."\n" + .'You can view it on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to view the information of all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestIotInstanceId', - ], + 'schema' => ['description' => 'The name of the device.'."\n" + .'You can view **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'UserId', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'tibce3fsgqelezk8', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'example' => '23******', 'title' => ''], ], [ - 'name' => 'ProductKey', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a1654Sr4Y3f', - ], + 'schema' => ['description' => 'The device ID of the device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) on IoT Platform to query it.'."\n" + ."\n" + .'><notice> **IotId** as the unique device identifier has a one-to-one mapping with the **ProductKey** and **DeviceName** combination. If you specify this parameter, you do not need to specify **ProductKey** and **DeviceName**. If you specify both **IotId** and the **ProductKey** and **DeviceName** combination, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'd7XmBoJhAr88C6PelXDF00****', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestDeviceName', - ], + 'schema' => ['description' => 'The instance ID. You can view the ID of the current instance on the **Instance Overview** tab in the IoT Platform console.', 'type' => 'string', 'required' => true, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], ], 'responses' => [ @@ -5277,57 +4010,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - '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', - ], - ], - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request parameter error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'CheckFaceUserDoExistOnDevice', - 'requestParamsDescription' => ' ', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.RequestError', 'errorMessage' => 'Request error.', 'description' => 'The request failed.'], + ['errorCode' => 'iot.vision.JobNotExist', 'errorMessage' => 'Job not exist or expired.', 'description' => 'The task does not exist or has expired.'], + ], + 403 => [ + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteStreamPushJob', + 'summary' => 'Deletes a video stream push job by calling the DeleteStreamPushJob API.', + 'description' => '## QPS Limit'."\n" + ."\n" + .'The maximum number of queries per second (QPS) for a single Alibaba Cloud account calling this API is 50.'."\n" + ."\n" + .'> All RAM users under a single Alibaba Cloud account share the quota of that Alibaba Cloud account.', + 'requestParamsDescription' => 'When you call this API operation, in addition to the request parameters described in this topic, you must also include common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ClearFaceDeviceDB' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamPushJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteStreamPushJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteStreamSnapshotJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5336,44 +4083,41 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IsolationId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ZheJiangHZ', - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console or call [QueryProductList](~~69271~~) to query the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot_instc_pu****_c*-v64********', - ], + 'schema' => ['description' => 'The name of the device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'ProductKey', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a1Wmy******', - ], + 'schema' => ['description' => 'The ID of the device. This is a unique identifier issued by IoT Platform for the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> **IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'd7XmBoJhAr88C6PelXDF00****', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'TestDevice_1', - ], + 'schema' => ['description' => 'The instance ID. You can view the ID of the current instance on the **Overview** tab of the IoT Platform console.', 'type' => 'string', 'required' => true, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => ['description' => 'The stream type.'."\n" + ."\n" + .'- **0** (default): main stream.'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -5381,88 +4125,82 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'example' => '""', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'device not found', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request parameter error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'ClearFaceDeviceDB', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.RequestError', 'errorMessage' => 'Request error.', 'description' => 'The request failed.'], + ['errorCode' => 'iot.vision.JobNotExist', 'errorMessage' => 'Job not exist or expired.', 'description' => 'The task does not exist or has expired.'], + ], + 403 => [ + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteStreamSnapshotJob', + 'summary' => 'Deletes a video snapshot task.', + 'description' => '## QPS limit'."\n" + ."\n" + .'You can invoke this API operation up to 50 times per second per Alibaba Cloud account.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For more information about common request parameters, see the [Common parameters](~~141505~~) metric description.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreatePictureSearchApp' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamSnapshotJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteStreamSnapshotJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteTimeTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'Desc', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'IotInstanceId', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot_instc_pu****_c*-v64********', - ], + 'schema' => ['description' => 'The ID of the time template. You can call [QueryTimeTemplate](~~107890~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '36f06322442e4e3f85a5ae8862c9****', 'title' => ''], ], ], 'responses' => [ @@ -5470,142 +4208,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'RAM system auth error.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"RAM system auth error.\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete a time template', + 'summary' => 'Deletes a time template.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when calling this operation. For more information, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreatePictureSearchJob' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTimeTemplate'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteTimeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'EnableGbSubDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AppInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3e429560124b44b685095df81a27****', - ], - ], - [ - 'name' => 'SearchPicUrl', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'http://xxx.xxx/1.jpg', - ], - ], - [ - 'name' => 'StartTime', + 'name' => 'SubDeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9999999999999', - 'minimum' => '0', - 'example' => '1614227915000', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9999999999999', - 'minimum' => '0', - 'example' => '1614327915000', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'Threshold', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'example' => '0.5', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'BodyThreshold', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'maximum' => '1', - 'minimum' => '0', - 'example' => '0.9', - 'default' => '0.8', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'PictureSearchType', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -5613,95 +4289,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProductKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => '71632df011294a85910c566e7181****', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The request has failed due to a temporary failure of the server.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FAEBE068-07DE-4B88-AC2A-51FC2B556211', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RiskControl', - 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', - ], + ['errorCode' => 'iot.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'The RAM user does not have permissions to access the resource.'], + ['errorCode' => 'iot.vision.GbServiceNotEnabled', 'errorMessage' => 'The GB28181 service has not been enabled.', 'description' => 'The standard service is not started.'], + ['errorCode' => 'iot.vision.GbIdDuplicate', 'errorMessage' => 'The GB28181 deviceId is duplicated.', 'description' => 'The standard ID already exists.'], + ], + 403 => [ + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], ], ], - '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' => 'CreatePictureSearchJob', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdatePictureSearchApp' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableGbSubDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:EnableGbSubDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"DeviceName\\": \\"\\",\\n \\"ProductKey\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetPictureSearchJobStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'AppInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3e429560124b44b685095df81a27****', - ], + 'schema' => ['description' => 'Instance ID of the image search application instance. You can call [QueryPictureSearchApps](~~206608~~) to query instance ID.', 'type' => 'string', 'required' => true, 'example' => '892f97c9518548469d319d955d98****', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The ID of the image search task. You can call [QueryPictureSearchJob](~~206778~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => 'b3786935a71442efae014c7b2212****', 'title' => ''], ], ], 'responses' => [ @@ -5709,106 +4370,133 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Specified access key is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '2c7def10-7cce-11eb-8e79-959f4f722f76', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time of the search range.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614850763692', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the search range. The value is a 13-digit UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614814763692', 'title' => ''], + 'JobStatus' => ['description' => 'The task status. Valid values:'."\n" + .'- 0: init'."\n" + .'- 1: no data'."\n" + .'- 2: running'."\n" + .'- 3: succeeded'."\n" + .'- 4: failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'SearchPicUrl' => ['description' => 'The URL of the search image.', 'type' => 'string', 'example' => 'http://XXX.XXX.com/1.jpg', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the image search task was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614850763000', 'title' => ''], + 'JobId' => ['description' => 'The ID of the image search task.', 'type' => 'string', 'example' => 'b3786935a71442efae014c7b2212****', 'title' => ''], + 'Threshold' => ['description' => 'The search similarity threshold.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RiskControl', - 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', - ], + ['errorCode' => 'Forbidden.RiskControl', 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', 'description' => ''], ], ], - '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' => 'UpdatePictureSearchApp', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve image search task status', + 'summary' => 'Retrieves the status of an integrated image search task.', + 'description' => 'Integrated image search indicates that both face and body features are retrieved simultaneously during the image search.'."\n" + ."\n" + .'> This feature requires the deployment of face and body detection algorithms on V-series edge devices.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common request parameters when calling this API operation. For more information, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryPictureSearchAiboxes' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPictureSearchJobStatus'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:GetPictureSearchJobStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'PictureSearchPicture' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'AppInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5a502d3fbab8410e8fd4be9037c7****', - ], + 'schema' => ['description' => 'Instance ID of the image search application instance. You can call [QueryPictureSearchApps](~~206608~~) to query instance ID.', 'type' => 'string', 'required' => true, 'example' => '5a502d3fbab8410e8fd4be9037c7****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Maximum value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '20', 'example' => '10', 'title' => ''], ], [ 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The page number to return. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'SearchPicUrl', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot_instc_pu****_c*-v64********', - ], + 'schema' => ['description' => 'The URL of the image to search.', 'type' => 'string', 'required' => true, 'example' => ' http://***.***/2393.jpg', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the search range. The value is a 13-digit UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1614297000000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the search range. The value is a 13-digit UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1614850651299', 'title' => ''], + ], + [ + 'name' => 'Threshold', + 'in' => 'query', + 'schema' => ['description' => 'The search threshold. Valid values: 0 to 1.'."\n" + ."\n" + .'> Set the search threshold to 0.3 or higher to ensure that the results match the detection object.', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '0.5', 'title' => ''], + ], + [ + 'name' => 'ContainPicUrl', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the response contains photo URLs.'."\n" + ."\n" + .'> The response is returned regardless of whether this parameter is set to true or false.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'PictureSearchType', + 'in' => 'query', + 'schema' => ['description' => 'The search type. Valid values:'."\n" + .'- **1** (default): face'."\n" + .'- **0**: body.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -5816,145 +4504,167 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Specified parameter CurrentPage is not valid.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3ddd5f30-7ccd-11eb-b164-bfd389491534', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response data.', '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', - ], + 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageData' => [ - 'description' => '', + 'description' => 'The list of results.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'NickName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'box015', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', - ], + 'PicUrl' => ['description' => 'The URL of the image.', 'type' => 'string', 'example' => 'https://XXX.XXX/XXX', 'title' => ''], + 'EventTime' => ['description' => 'The time when the event was created. The value is a 13-digit UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614500317482', 'title' => ''], + 'GatewayIotId' => ['description' => 'The IotId of the V-series edge all-in-one device.', 'type' => 'string', 'example' => 'pZJUqijOyfpFOOGNPF7S00****', 'title' => ''], + 'VectorId' => ['description' => 'The feature ID of the image.', 'type' => 'string', 'example' => 'vectorId86d9a5c32b9947278e526c2eef8a****', 'title' => ''], + 'Threshold' => ['description' => 'The face similarity score.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], + 'VectorType' => ['description' => 'The feature type of the image. Valid values:'."\n" + .'- 0: body.'."\n" + .'- 1: face.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'IotId' => ['description' => 'The IotId of the queried device.', 'type' => 'string', 'example' => '5RUngwC1RknD4lPiHgH300****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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\\": \\"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' => 'QueryPictureSearchAiboxes', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Image search', + 'summary' => 'Starts an image search application instance to perform image retrieval.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common parameters when you call this operation. For more information, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryPictureSearchApps' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PictureSearchPicture'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:PictureSearchPicture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryCarProcessEvents' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '20', - 'minimum' => '1', - 'example' => '20', - ], + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value is available, you must specify this parameter. Otherwise, the call fails.'."\n" + .'- If no<props="intl"><ph> **Overview** page or</ph></props> ID value is available, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iotx-oxsshare****', 'title' => ''], + ], + [ + 'name' => 'SubIotId', + 'in' => 'query', + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call the [QueryDeviceDetail](~~69594~~) operation of IoT Platform to query this ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** serves as the unique identifier of the device and has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'ImP6ECd1aQ****CAfWTO000101', 'title' => ''], + ], + [ + 'name' => 'SubProductKey', + 'in' => 'query', + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console or call the [QueryProductList](~~69271~~) operation to view the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1Duh0F****', 'title' => ''], + ], + [ + 'name' => 'SubDeviceName', + 'in' => 'query', + 'schema' => ['description' => 'The device name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'car_test', 'title' => ''], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the query range. The value is a 13-digit UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '10000000000000', 'minimum' => '0', 'example' => '1646288487368', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the query range. The value is a 13-digit UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '10000000000000', 'minimum' => '0', 'example' => '1646288488368', 'title' => ''], ], [ 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The page number to return. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot_instc_pu****_c*-v64********', - ], + 'schema' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 20. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PlateNo', + 'in' => 'query', + 'schema' => ['description' => 'The license plate number. The value can contain up to 15 characters.', 'type' => 'string', 'required' => false, 'example' => '浙AM****', 'title' => ''], + ], + [ + 'name' => 'ActionType', + 'in' => 'query', + 'schema' => ['description' => 'The action type of the vehicle. Valid values:'."\n" + ."\n" + .'- **1**: entering'."\n" + .'- **2**: staying'."\n" + .'- **3**: leaving.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'AreaIndex', + 'in' => 'query', + 'schema' => ['description' => 'The detection box of the IPC device. You can call the [InvokeThingService](~~69584~~) operation to query the number of detection boxes. Set **identifier** to **QueryAlgoTaskDetails**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -5962,170 +4672,182 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Specified access key is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '8B8E77F0-7713-0139-A3D6-93482A025D45', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The data returned if the call is successful.', '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', - ], + 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of vehicle recognition events.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageData' => [ - 'description' => '', + 'description' => 'The list of intelligent alert events returned.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'AppInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3e429560124b44b685095df81a27****', - ], - 'ModifiedTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1614328081000', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1.0.0', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1614327915000', - ], - 'AppTemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '7b50e7acb2574a789226099300cc****', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'EventPicUrl' => ['description' => 'The URL of the intelligent alert event photo.', 'type' => 'string', 'example' => 'https://example.com/test.jpg', 'title' => ''], + 'EventTime' => ['description' => 'The timestamp when the event occurred. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646288428361', 'title' => ''], + 'ActionType' => ['description' => 'The action type of the vehicle.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Confidence' => ['description' => 'The confidence level that the detected object is a vehicle.', 'type' => 'integer', 'format' => 'int32', 'example' => '63', 'title' => ''], + 'SubProductKey' => ['description' => 'The ProductKey of the IPC device.', 'type' => 'string', 'example' => 'a1Duh0F****', 'title' => ''], + 'EventId' => ['description' => 'The ID of the intelligent alert event.', 'type' => 'string', 'example' => 'dailyb3d6658d9****', 'title' => ''], + 'SubIotId' => ['description' => 'The device ID of the IPC device.', 'type' => 'string', 'example' => 'ImP6ECd1aQxio9CAfWTO****', 'title' => ''], + 'AreaIndex' => ['description' => 'The number of detection boxes for the IPC device.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'EventType' => ['description' => 'The type of the intelligent alert event.'."\n" + ."\n" + .'- To query all intelligent alert event types, set this parameter to 0.'."\n" + .'- To query multiple intelligent alert event types, enter the serial numbers of the event types separated by commas (,), such as `10001,10002`.'."\n" + .'>You can specify up to 10 intelligent alert event types at a time.'."\n" + ."\n" + .'You can view all intelligent alert event types on the **Feature Definition** tab of the **Product Details** page in the IoT Platform console. For more information, see [View intelligent alert event types](~~207701~~).', 'type' => 'integer', 'format' => 'int32', 'example' => '10005', 'title' => ''], + 'EventPicId' => ['description' => 'The photo ID of the intelligent alert event.', 'type' => 'string', 'example' => 'SU5LT2pXaUM4MV****Nzg', 'title' => ''], + 'TaskId' => ['description' => 'The task ID of the vehicle detection event.', 'type' => 'string', 'example' => 'daily55617e7653354490938d****', 'title' => ''], + 'SubDeviceName' => ['description' => 'The DeviceName of the IPC device.', 'type' => 'string', 'example' => 'car_test', 'title' => ''], + 'IotId' => ['description' => 'The IotId of the V-series edge gateway device.', 'type' => 'string', 'example' => 'gl9kLgp0UsPSCcIM8EAY00****', 'title' => ''], + 'SubDeviceNickName' => ['description' => 'The DeviceNickName of the IPC device.', 'type' => 'string', 'example' => '测试车辆', 'title' => ''], + 'PlateNo' => ['description' => 'The license plate number.', 'type' => 'string', 'example' => '浙A6****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Forbidden.RiskControl', - 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', - ], + ['errorCode' => 'iot.lv.requestError', 'errorMessage' => 'Request error', 'description' => 'Request error'], + ], + 403 => [ + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ['errorCode' => 'iot.lv.requestTimeError', 'errorMessage' => 'Request time error.', 'description' => ''], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryCarProcessEvents', + 'summary' => 'Queries the list of intelligent alert events for vehicle operations.', + 'description' => '## Operation description'."\n" + .'The maximum number of queries per second (QPS) for a single Alibaba Cloud account that can invoke this operation is 10. '."\n" + .'> Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.', + 'requestParamsDescription' => ' When you invoke this operation, you must specify the request parameters described in this topic and the common request parameters. For the metric description of common request parameters, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryPictureSearchDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCarProcessEvents'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryCarProcessEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryDeviceEvent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AppInstanceId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5a502d3fbab8410e8fd4be9037c7****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to view information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '20', - 'example' => '10', - ], + 'schema' => ['description' => 'The device name of the IPC device.'."\n" + .'You can view **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => ['description' => 'The device ID of the IPC device. The ID is issued by IoT Platform and is the unique identity of the device. You can invoke [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** is the globally unique identity of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], + ], + [ + 'name' => 'EventType', + 'in' => 'query', + 'schema' => ['description' => 'The type of intelligent alerting event:'."\n" + .'- Settings for all intelligent alerting events: 0.'."\n" + .'- Settings for a specific intelligent alerting event: enter the ordinal number of the intelligent alerting event, such as 10001.'."\n" + ."\n" + .'In the IoT Platform console, view all intelligent alerting event types on the **Feature Definition** tab of the **Product Details** page. For more information, see [View intelligent alerting event types](~~207701~~).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the query range. The value is a 13-digit UNIX timestamp in the format of milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1539507310000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the query range. The value is a 13-digit UNIX timestamp in the format of milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1539607310000', 'title' => ''], ], [ 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The page number to start displaying from in the returned results. Pages start sorting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'<props="china">You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console. If an ID value exists, you must specify this parameter. Otherwise, the invocation is failed.</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> If the public instance does not have an ID value, see [How to obtain an instance ID](~~267533~~).</props>'."\n" + ."\n" + .'<props="intl">You do not need to specify this parameter.</props>', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y****', 'title' => ''], ], ], 'responses' => [ @@ -6133,151 +4855,132 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The return code of the operation.'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: fault codes. For details, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identity generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the invocation failed.', 'type' => 'string', 'example' => 'request forbidden', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation is successful.'."\n" + .'- **true**: The invocation is successful.'."\n" + .'- **false**: The invocation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The query result.', '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' => '', + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'List' => [ + 'description' => 'The list of intelligent alerting events.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'NickName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'camera1', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', - ], + 'EventId' => ['description' => 'The intelligent alerting event ID.', 'type' => 'string', 'example' => 'ae6b74f1dc7d****85d32c210185967f_16080****9471', 'title' => ''], + 'EventTime' => ['description' => 'The time when the intelligent alerting event occurred.', 'type' => 'string', 'example' => '2020-12-15 20:40:49', 'title' => ''], + 'EventType' => ['description' => 'The event type of the intelligent alerting event.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'EventPicId' => ['description' => 'The ID of the image associated with the intelligent alerting event.', 'type' => 'string', 'example' => 'aEtMSm9****ORTFxcGpTbDZ****6eTk0', 'title' => ''], + 'EventDesc' => ['description' => 'The description of the intelligent alerting event.', 'type' => 'string', 'example' => '移动侦测', 'title' => ''], + 'EventData' => ['description' => 'The additional information of the intelligent alerting event.', 'type' => 'string', 'example' => '{}', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryPictureSearchDevices', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query device event list', + 'summary' => 'Queries the list of intelligent alert events for an IPC device.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify common request parameters in addition to the operation-specific request parameters described in this topic. For the metric description of common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryPictureSearchJob' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceEvent'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryDeviceEventPicture' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AppInstanceId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fdc576d03c094faea9fa10fbf48c****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console, or call [QueryProductList](~~69271~~) to view information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'JobStatus', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10', - 'minimum' => '0', - 'example' => '3', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the DeviceName on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '20', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the IPC device. This ID is issued by IoT Platform and is the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) on IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** is the unique identifier of the device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'EventId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the smart alarm event. You can call [QueryDeviceEvent](~~107916~~) to obtain the ID.', 'type' => 'string', 'required' => true, 'example' => 'ae6b74f1dc7d402****32c21018****f1608036****71', 'title' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Overview** page of the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value is available, you must specify this parameter. Otherwise, the call fails.'."\n" + .'- If no <props="intl"><ph>**Overview** page or </ph></props>ID value is available, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y*****', 'title' => ''], ], ], 'responses' => [ @@ -6285,185 +4988,100 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1614850763692', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1614814763692', - ], - 'JobStatus' => [ - 'description' => '', - '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' => '', - '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.', + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: The request was successful.'."\n" + .'- Other codes: An error occurred. For more information about error codes, see [Error codes](~~145071~~).', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The URL of the image.', 'type' => 'string', 'example' => 'oss://***/***.jpg', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'product is not active', 'title' => ''], + 'RequestId' => ['description' => 'The request ID that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryPictureSearchJob', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query device event picture', + 'summary' => 'Queries images that are captured and uploaded by an IPC device when a smart alarm event is triggered.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryPictureSearchJobResult' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceEventPicture'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceEventPicture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryDeviceEventRecord' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AppInstanceId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fdc576d03c094faea9fa10fbf48c****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view this on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to view information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'b7e501d0d2524a4caeb50df3282a****', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '20', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) on IoT Platform to query this ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. As the unique identifier of a device, **IotId** corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'EventId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the smart alert event. You can obtain this by calling the [QueryDeviceEvent](~~107916~~) operation.', 'type' => 'string', 'required' => true, 'example' => '907084996e1d44788d0*****43906_160803*****37', 'title' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'<props="china">You can view the **ID** of the current instance on the **Instance Overview** page in the IoT Platform console. If an ID value is available, you must specify this ID value. Otherwise, the call will fail.</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> If the public instance has no ID value, see [How do I obtain an instance ID?](~~267533~~).</props>'."\n" + ."\n" + .'<props="intl">You do not need to specify this parameter.</props>', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1****z0t', 'title' => ''], ], ], 'responses' => [ @@ -6471,155 +5089,148 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1614333155075', - ], - 'GatewayIotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pZJUqijOyfpFOOGNPF7S00****', - ], - 'VectorId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vectorId86d9a5c32b9947278e526c2eef8a****', - ], - 'DeviceNickName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'camera1', - ], - 'Threshold' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5RUngwC1RknD4lPiHgH300****', - ], - ], - ], + 'description' => 'The query result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time of the recording.', 'type' => 'string', 'example' => '2021-09-08 15:56:32', 'title' => ''], + 'FileName' => ['description' => 'The name of the recording file.', 'type' => 'string', 'example' => 'file1', 'title' => ''], + 'VodUrl' => ['description' => 'The URL of the recording file.'."\n" + ."\n" + .'> The URL contains authentication information and is valid for a single use only. It cannot be reused.', 'type' => 'string', 'example' => 'rtmp://****/****.mp4', 'title' => ''], + 'BeginTime' => ['description' => 'The start time of the recording.', 'type' => 'string', 'example' => '2021-09-08 15:55:35', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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\\": \\"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' => 'QueryPictureSearchJobResult', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query event recordings', + 'summary' => 'Queries the URL of the recording file that corresponds to a specified smart alert event of an IPC device.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetPictureSearchJobStatus' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceEventRecord'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceEventRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryDevicePictureByList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'AppInstanceId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '892f97c9518548469d319d955d98****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to view information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the DeviceName on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the IPC device. The ID is issued by IoT Platform and is the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) on IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** is the unique identifier of the device and has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => '1CJ0****e7qiq8VkQi1000000', 'title' => ''], + ], + [ + 'name' => 'ThumbWidth', + 'in' => 'query', + 'schema' => ['description' => 'The width of the target thumbnail. Unit: pixels. Valid values: 1 to 4096.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => ['description' => 'The expiration time of the picture URL. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'PictureType', 'in' => 'query', + 'schema' => ['description' => 'The type of the picture.'."\n" + ."\n" + .'- **0**: thumbnail.'."\n" + .'- **1**: original picture.'."\n" + .'- **2** (default): all.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '2', 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'<props="china">You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console. If an ID value is available, you must specify this parameter. Otherwise, the call fails.</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> If the public instance does not have an ID value, see [How to obtain an instance ID](~~267533~~).</props>'."\n" + ."\n" + .'<props="intl">You do not need to specify this parameter.</props>', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y******', 'title' => ''], + ], + [ + 'name' => 'PictureIdList', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The list of picture IDs. The picture IDs are generated when you call [TriggerCapturePicture](~~107914~~).'."\n" + ."\n" + .'> A maximum of 50 picture IDs can be specified in a single call.'."\n", + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, - 'example' => 'b3786935a71442efae014c7b2212****', + 'example' => 'cFc5MzZ****npYT1***TDFzX1hrVzA0Z****', + 'maxItems' => 50, + 'title' => '', ], ], ], @@ -6628,212 +5239,149 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'request forbidden', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', 'type' => 'object', + 'itemNode' => true, 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1614850763692', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1614814763692', - ], - 'JobStatus' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'b3786935a71442efae014c7b2212****', - ], - 'Threshold' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', + 'picData' => [ + 'description' => 'The response data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PicId' => ['description' => 'The picture ID.', 'type' => 'string', 'example' => 'RW****HFRO****jUyMjIy', 'title' => ''], + 'PicUrl' => ['description' => 'The picture URL.', 'type' => 'string', 'example' => 'https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEp****%3D', 'title' => ''], + 'PicCreateTime' => ['description' => 'The time when the picture was created. The value is a 13-digit timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1632453652222', 'title' => ''], + 'ThumbUrl' => ['description' => 'The thumbnail URL.', 'type' => 'string', 'example' => 'https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEpDE****%2Cq_90', 'title' => ''], + 'IotId' => ['description' => 'The ID of the IPC device.', 'type' => 'string', 'example' => '1CJ0****e7qiq8VkQi1000000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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 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' => 'GetPictureSearchJobStatus', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryDevicePictureByList', + 'summary' => 'Retrieves picture URLs based on a list of picture IDs.', + 'requestParamsDescription' => 'When you call this API operation, you must also include common request parameters in addition to the operation-specific request parameters described in this topic. For more information, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryPictureFiles' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDevicePictureByList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDevicePictureByList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryDevicePictureFile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view it on the **Products** page in the IoT Platform console or call [QueryProductList](~~69271~~) to view information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], - ], - [ - 'name' => 'BeginTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1615357669000', - ], + 'schema' => ['description' => 'The ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** serves as the unique identifier of the device and has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'CaptureId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1615444063000', - ], + 'schema' => ['description' => 'The ID of the picture generated when a capture event occurs:'."\n" + .'- For pictures captured by active triggering, see [TriggerCapturePicture](~~107914~~) for the picture ID.'."\n" + .'- For pictures captured by smart alert events, see [QueryDeviceEvent](~~107916~~) for the picture ID.', 'type' => 'string', 'required' => true, 'example' => 'fdc576d03c094faea9fa10fbf48c****', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'ThumbWidth', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The width of the target thumbnail, in px. Valid values: 1 to 4096.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '100', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ExpireTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The validity period of the picture URL, in minutes. Valid values: 1 to 43200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '60', 'title' => ''], ], [ 'name' => 'PictureType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - ], - [ - 'name' => 'PictureSource', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The type of the picture:'."\n" + ."\n" + .'- **0**: thumbnail'."\n" + .'- **1**: original picture'."\n" + .'- **2** (default): all'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '2', 'example' => '1', 'title' => ''], ], [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y****', - ], + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Instance Overview** page in the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value is available, you must specify this parameter. Otherwise, the call will fail.'."\n" + .'- If the <props="intl"><ph>**Instance Overview** page or the </ph></props>ID value is not available, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Instance Overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y******', 'title' => ''], ], ], 'responses' => [ @@ -6841,139 +5389,79 @@ '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' => 'product is not active.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code:'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'request forbidden', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response data.', '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' => '', - 'type' => 'string', - 'example' => 'pZJUqijOyfpFOOGNP******', - ], - 'PicUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://***_normal.jpg', - ], - 'PicCreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1543458157522', - ], - 'ThumbUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://***.jpg', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], - ], - ], - ], + 'PicId' => ['description' => 'The picture ID.', 'type' => 'string', 'example' => 'R****bVhsNCjMjIy', 'title' => ''], + 'PicUrl' => ['description' => 'The picture URL.', 'type' => 'string', 'example' => 'https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***3D', 'title' => ''], + 'PicCreateTime' => ['description' => 'The time when the picture was created, in the format of a 13-digit timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1632453652222', 'title' => ''], + 'ThumbUrl' => ['description' => 'The thumbnail URL.', 'type' => 'string', 'example' => 'https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***2Cq_90', 'title' => ''], + 'IotId' => ['description' => 'The ID of the IPC device.', 'type' => 'string', 'example' => '1CJ0***kQi1000000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryPictureFiles', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query Device Picture File Information', + 'summary' => 'Queries the picture information obtained by an IPC device.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common request parameters when you call the API operation. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'BindPictureSearchAppWithDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDevicePictureFile'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDevicePictureFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryDevicePictureLifeCycle' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AppInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5a502d3fbab8410e8fd4be9037c7****', - ], - ], - [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-060a****', - ], - ], - [ - 'name' => 'DeviceIotIds', + 'name' => 'IotId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The device ID of the IPC device. The ID issued by IoT Platform for the device, which is the unique identifier of the device.'."\n" + ."\n" + .'You can call the [QueryDeviceDetail](~~69594~~) operation of IoT Platform to query the device ID.', 'type' => 'string', 'required' => true, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], ], 'responses' => [ @@ -6981,85 +5469,85 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'iotIdList is error', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'B8A4153B-4F18-49B1-90C0-C9194866FF88', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The response code returned.'."\n" + ."\n" + .'- **200**: The request was successful.'."\n" + .'- Other codes: An error occurred. For more information about error codes, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0E2244FD-0AC9-4AB4-A8F0-729D78BE1D77', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'Day' => ['description' => 'The number of days that images are stored in the cloud.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'IotId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'BindPictureSearchAppWithDevices', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query the cloud storage image lifecycle of a device', + 'summary' => 'Queries the cloud storage image lifecycle of an IPC device.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common request parameters when you call this API operation. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UnbindPictureSearchAppWithDevices' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDevicePictureLifeCycle'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDevicePictureLifeCycle', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryDeviceRecordLifeCycle' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AppInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5a502d3fbab8410e8fd4be9037c7****', - ], - ], - [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-060a****', - ], - ], - [ - 'name' => 'DeviceIotIds', + 'name' => 'DeviceList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'The list of IotId values of IPC devices. An IotId is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.'."\n" + ."\n" + .'You can call the [QueryDeviceDetail](~~69594~~) operation of IoT Platform to query the IotId.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, - 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', - 'maxItems' => 20, + 'example' => '["C47T6xwp6ms4bNlkHRWCg4****", "d7XmBoJhAr88C6PelXDF00****"]', + 'maxItems' => 100, + 'title' => '', ], ], ], @@ -7068,152 +5556,162 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'iotIdList is error', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E779C673-E8E8-41F0-883E-7D9275DF733C', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The response code returned. Valid values:'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'InvalidParameters', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The query result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Day' => ['description' => 'The recording lifecycle of the IPC device.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'IotId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'UnbindPictureSearchAppWithDevices', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Get cloud storage recording lifecycle of a device', + 'summary' => 'Retrieves the retention period of recording files saved in the cloud for IPC devices, that is, the recording lifecycle.', + 'requestParamsDescription' => 'When you call this operation, you must include common request parameters in addition to the operation-specific request parameters described in this topic. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PictureSearchPicture' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceRecordLifeCycle'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceRecordLifeCycle', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryDeviceVodUrl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'AppInstanceId', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5a502d3fbab8410e8fd4be9037c7****', - ], + 'schema' => ['description' => 'The name of the recording file. You can call the [InvokeThingService](~~69584~~) operation provided by IoT Platform to query the file name. For examples of request parameters, see the **Supplementary description of request parameters** section below.'."\n" + ."\n" + .'> The length of the recording file name cannot exceed 180 characters.', 'type' => 'string', 'required' => true, 'example' => 'file1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Scheme', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '20', - 'example' => '10', - ], + 'schema' => ['description' => 'The protocol type:'."\n" + .'- **rtmp**: RTMP protocol.'."\n" + .'- **flv**: HTTP-FLV protocol.'."\n" + .'- **hls**: HLS protocol.'."\n" + .' > For more information about the usage limits of the HLS protocol, see [Cloud development](~~208584~~).', 'type' => 'string', 'required' => false, 'example' => 'rtmp', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'SeekTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The offset relative to the recording start time **BeginTime**. Unit: seconds. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], ], [ - 'name' => 'SearchPicUrl', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => ' http://***.***/2393.jpg', - ], + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value is available, you must specify this parameter. Otherwise, the call fails.'."\n" + .'- If no <props="intl"><ph>**Overview** page or </ph></props>ID value is available, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1614297000000', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console, or call the [QueryProductList](~~69271~~) operation to view the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1614850651299', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'Threshold', + 'name' => 'EnableStun', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => true, - 'example' => '0.5', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ContainPicUrl', + 'name' => 'ShouldEncrypt', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to enable encryption:'."\n" + .'- **true**: Enable encryption.'."\n" + .'- **false** (default): Disable encryption.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], ], [ - 'name' => 'PictureSearchType', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10', - 'minimum' => '0', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The ID of the IPC device. This ID is issued by IoT Platform and serves as the unique identifier of the device. You can call the [QueryDeviceDetail](~~69594~~) operation to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** and **DeviceName**. **IotId** is the unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], + ], + [ + 'name' => 'UrlValidDuration', + 'in' => 'query', + 'schema' => ['description' => 'The validity period of the URL. Valid values: 10 to 14400. Unit: seconds. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'PlayUnLimited', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the playback URL can be used an unlimited number of times:'."\n" + .'- **true**: The URL can be used an unlimited number of times within 10 seconds.'."\n" + .'- **false** (default): The URL can be used only once.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'EncryptType', + 'in' => 'query', + 'schema' => ['description' => 'The encryption type. Currently, only I-frame encryption is supported. Set the value to 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -7221,168 +5719,175 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code:'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information about error codes, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'product is not active.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The query result.', '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' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1614500317482', - ], - 'GatewayIotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pZJUqijOyfpFOOGNPF7S00****', - ], - 'VectorId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vectorId86d9a5c32b9947278e526c2eef8a****', - ], - 'Threshold' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'VectorType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5RUngwC1RknD4lPiHgH300****', - ], - ], - ], - ], + 'DecryptKey' => ['description' => 'The decryption key.'."\n" + .'The decryption key is generated when the **ShouldEncrypt** parameter is set to **true**.', 'type' => 'string', 'example' => '{"iv": "MDEy****OTo7PD0+Pw==","key": "eA2r****fHjOmnyBfQ=="}', 'title' => ''], + 'StunInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'VodUrl' => ['description' => 'The URL of the local recording.', 'type' => 'string', 'example' => 'rtmp://***/***.mp4', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'PictureSearchPicture', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"product is not active.\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DecryptKey\\": \\"{\\\\\\"iv\\\\\\": \\\\\\"MDEy****OTo7PD0+Pw==\\\\\\",\\\\\\"key\\\\\\": \\\\\\"eA2r****fHjOmnyBfQ==\\\\\\"}\\",\\n \\"StunInfo\\": \\"\\",\\n \\"VodUrl\\": \\"rtmp://***/***.mp4\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query local recording list', + 'summary' => 'Call this operation to obtain the URL of a recording file with a specified file name from the storage card of a local NVR device or IPC device.', + 'requestParamsDescription' => '## Supplementary description of request parameters'."\n" + .'The following example shows the request parameters of the InvokeThingService operation. For more information, see [Local recording playback](~~208584~~).'."\n" + .'```'."\n" + .'https://iot.cn-shanghai.aliyuncs.com/?Action=InvokeThingService'."\n" + .'&ProductKey=a1BwAGV****'."\n" + .'&DeviceName=device1'."\n" + .'&Identifier=QueryRecordList //The identifier of the service'."\n" + .'&Args={ //The input parameters of the service to be invoked, in JSON String format'."\n" + .' "BeginTime":10, //The start time of the recording file query range, in seconds. Valid values: 0 to 2147483647'."\n" + .' "Type":0, //The recording type. 0: scheduled recording, 1: alarm recording, 2: active recording, 99: all recordings'."\n" + .' "QuerySize":2, //The number of records to query. Valid values: 0 to 128'."\n" + .' "EndTime":1541662222 //The end time of the recording file query range, in seconds. Valid values: 0 to 2147483647'."\n" + .'}'."\n" + .'&<Common request parameters>'."\n" + .'```', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'TriggerCapturePicture' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceVodUrl'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceVodUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryDeviceVodUrlByTime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'Scheme', + 'in' => 'query', + 'schema' => ['description' => 'The protocol type:'."\n" + .'- **rtmp**: RTMP protocol.'."\n" + .'- **flv**: HTTP-FLV protocol.'."\n" + .'- **hls**: HLS protocol.'."\n" + .' > For the usage limits of the HLS protocol, see [Cloud development](~~208584~~).', 'type' => 'string', 'required' => false, 'default' => 'rtmp', 'example' => 'rtmp', 'title' => ''], + ], + [ + 'name' => 'SeekTime', + 'in' => 'query', + 'schema' => ['description' => 'The offset from the recording start time **BeginTime**, in seconds. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483648', 'minimum' => '0', 'default' => '0', 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If the ID value exists, you must specify this parameter. Otherwise, the call fails.'."\n" + .'- If no<props="intl"><ph> **Overview** page or</ph></props> ID value exists, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y****', 'title' => ''], + ], + [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the information about all products under the current account on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to query the information.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], + ], + [ + 'name' => 'EnableStun', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ShouldEncrypt', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to encrypt the stream:'."\n" + .'- **true**: encrypts the stream.'."\n" + .'- **false** (default): does not encrypt the stream.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'BeginTime', + 'in' => 'query', + 'schema' => ['description' => 'The recording start time. The value is a 10-digit UNIX timestamp, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '2147483648', 'minimum' => '0', 'example' => '1508200012', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], + 'schema' => ['description' => 'The device ID of the IPC device. The ID is issued by IoT Platform to the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** and **DeviceName**. **IotId** is a globally unique identifier of a device that corresponds one-to-one to a combination of **ProductKey** and **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'UrlValidDuration', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'The validity period of the URL. Valid values: 10 to 14400. Unit: seconds. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'PlayUnLimited', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the playback URL can be used an unlimited number of times:'."\n" + ."\n" + .'- **true**: can be used an unlimited number of times within 10 seconds.'."\n" + .'- **false** (default): can be used only once.'."\n", 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The recording end time. The value is a 10-digit UNIX timestamp, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '2147483648', 'minimum' => '0', 'example' => '1582420940', 'title' => ''], + ], + [ + 'name' => 'EncryptType', + 'in' => 'query', + 'schema' => ['description' => 'The encryption type. Currently, only I-frame encryption is supported. Set the value to 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483648', 'minimum' => '0', 'default' => '0', 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -7390,79 +5895,79 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'Code' => ['description' => 'The response code:'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.'."\n", 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful:'."\n" + .'- **true**: the call was successful.'."\n" + .'- **false**: the call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'eventPicId_12****', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'request forbidden', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'DecryptKey' => ['description' => 'The decryption key.'."\n" + .'A decryption key is generated when the **ShouldEncrypt** parameter is set to **true**.', 'type' => 'string', 'example' => '{"iv": "MDEy****OTo7PD0+Pw==","key": "eA2r****fHjOmnyBfQ=="}', 'title' => ''], + 'StunInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'VodUrl' => ['description' => 'The playback URL for the local recording.', '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', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'TriggerCapturePicture', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DecryptKey\\": \\"{\\\\\\"iv\\\\\\": \\\\\\"MDEy****OTo7PD0+Pw==\\\\\\",\\\\\\"key\\\\\\": \\\\\\"eA2r****fHjOmnyBfQ==\\\\\\"}\\",\\n \\"StunInfo\\": \\"\\",\\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 }\\n}","type":"json"}]', + 'title' => 'Query device live streaming URL by time', + 'summary' => 'Queries the playback URL of a recording file within the specified time range from the storage card of a local NVR device or IPC device.', + 'description' => '## Usage notes'."\n" + ."\n" + .'Only the scenario in which an IPC device is directly connected to IoT Platform is supported.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateRecordPlan' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceVodUrlByTime'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceVodUrlByTime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryEventRecordPlanDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'PlanId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'plan1', - ], - ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '36f06322442e4e3f85a5ae8862c9****', - ], + 'schema' => ['description' => 'The ID of the intelligent alert event recording plan. You can call [QueryEventRecordPlans](~~107907~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], ], ], 'responses' => [ @@ -7470,119 +5975,142 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5b60bf0dd55944c19d7817442bc9****', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tenant auth error', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The details of the intelligent alert event recording plan.', + 'type' => 'object', + 'properties' => [ + 'PreRecordDuration' => ['description' => 'The pre-recording duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'Name' => ['description' => 'The name of the intelligent alert event recording.', 'type' => 'string', 'example' => 'record1', 'title' => ''], + 'PlanId' => ['description' => 'The ID of the intelligent alert event recording plan.', 'type' => 'string', 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the time template.', 'type' => 'string', 'example' => '36f06322442e4e3f85a5ae8862c9****', 'title' => ''], + 'RecordDuration' => ['description' => 'The recording duration, including the pre-recording duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'title' => ''], + 'TemplateInfo' => [ + 'description' => 'The details of the time template.', + 'type' => 'object', + 'properties' => [ + 'AllDay' => ['description' => 'Indicates whether 24/7 recording is enabled. Valid values:'."\n" + ."\n" + .'- 1: Enabled.'."\n" + .'- 0: Disabled. For detailed configurations, see the TimeSectionList parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Default' => ['description' => 'The templatetype. Valid values:'."\n" + .'- 1: default template'."\n" + .'- 0: custom template', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Name' => ['description' => 'The name of the time template.', 'type' => 'string', 'example' => 'temp1', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the time template.', 'type' => 'string', 'example' => '36f06322442e4e3f85a5ae8862c9****', 'title' => ''], + 'TimeSectionList' => [ + 'description' => 'The details of the time template when AllDay is set to 0.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'End' => ['description' => 'The end time of each day. Valid values: 1 to 86399. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '20000', 'title' => ''], + 'DayOfWeek' => ['description' => 'The day of the week. Valid values: 0 to 6, which represent Sunday through Saturday.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Begin' => ['description' => 'The start time of each day. Valid values: 0 to 86399. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '6000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'CreateRecordPlan', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query event-triggered recording plan details', + 'summary' => 'Queries the details of an intelligent alert event recording plan.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For the metric description of common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'AddRecordPlanDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryEventRecordPlanDetail'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryEventRecordPlanDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryEventRecordPlanDeviceByDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'Instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Instance Overview** page in the IoT Platform console. If an ID value exists, you must pass in this ID value, otherwise the call will fail.'."\n" + ."\n" + .'> If the public instance does not have an ID value, see [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view it on the **Products** page in the IoT Platform console or call [QueryProductList](~~69271~~) to view the information of all products under the current account.'."\n" + .'><notice> If you pass in this parameter, you must also pass in **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The device name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you pass in this parameter, you must also pass in **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device, serving as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) in IoT Platform to query it.'."\n" + ."\n" + .'><notice> If you pass in this parameter, you do not need to pass in **ProductKey** and **DeviceName**. As the unique identifier of the device, **IotId** has a one-to-one correspondence with the combination of **ProductKey** and **DeviceName**. If you pass in both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], ], [ 'name' => 'StreamType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'PlanId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5b60bf0dd55944c19d7817442bc9****', - ], + 'schema' => ['description' => 'Stream type:'."\n" + .'- **0** (default): Main stream.'."\n" + .'- **1**: Sub stream.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -7590,64 +6118,121 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The response code of the API:'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Others: Error codes. For details about error codes, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'PreRecordDuration' => ['description' => 'The pre-recording duration, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Name' => ['description' => 'The name of the smart alert event recording.', 'type' => 'string', 'example' => 'planAA', 'title' => ''], + 'PlanId' => ['description' => 'The ID of the smart alert event recording plan.', 'type' => 'string', 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], + 'TemplateId' => ['description' => 'The time template ID.', 'type' => 'string', 'example' => '36f06322442e4e3f85a5ae8862c9****', 'title' => ''], + 'RecordDuration' => ['description' => 'The recording duration, including the pre-recording duration, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'title' => ''], + 'TemplateInfo' => [ + 'description' => 'The details of the time template.', + 'type' => 'object', + 'properties' => [ + 'AllDay' => ['description' => 'Indicates whether to record 24/7:'."\n" + ."\n" + .'- **1**: Yes.'."\n" + .'- **0**: No. For detailed configuration, see the **TimeSectionList** parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Default' => ['description' => 'The time template type:'."\n" + .'- **1**: Default template.'."\n" + .'- **0**: Custom template.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Name' => ['description' => 'The name of the time template.', 'type' => 'string', 'example' => 'testtime1', 'title' => ''], + 'TemplateId' => ['description' => 'The time template ID.', 'type' => 'string', 'example' => '36f06322442e4e3f85a5ae8862c9****', 'title' => ''], + 'TimeSectionList' => [ + 'description' => 'The list of time sections.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'End' => ['description' => 'The end time of each day. Valid values: 1 to 86399. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '86399', 'title' => ''], + 'DayOfWeek' => ['description' => 'The day of the week. Valid values: 0 to 6, representing Sunday to Saturday.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Begin' => ['description' => 'The start time of each day. Valid values: 0 to 86399. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'AddRecordPlanDevice', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query Event-Linked Recording Plan by Device', + 'summary' => 'Queries the smart alert event recording plan based on the device ID of the IPC device.', + 'requestParamsDescription' => 'When calling the API, in addition to the request parameters described in this topic, you must also pass in common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteRecordPlan' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryEventRecordPlanDeviceByDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryEventRecordPlanDeviceByDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryEventRecordPlanDeviceByPlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PlanId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '6c5a397bc17c4b48ace86f0f0c30****', - ], + 'schema' => ['description' => 'The ID of the intelligent alert event recording plan. You can call [QueryEventRecordPlans](~~107907~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The page number to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -7655,104 +6240,96 @@ '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' => 'request forbidden.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'List' => [ + 'description' => 'The device information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StreamType' => ['description' => 'The stream type. Valid values:'."\n" + .'- **0**: main stream'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'IotId' => ['description' => 'The device ID of the camera.', 'type' => 'string', 'example' => 'P7WqhWvhplhHlWPO9Op5g4****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'DeleteRecordPlan', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query camera list of event-triggered recording plan', + 'summary' => 'Queries the list of cameras associated with an intelligent alert event recording plan.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common request parameters when calling this API operation. For more information, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteRecordPlanDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryEventRecordPlanDeviceByPlan'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryEventRecordPlanDeviceByPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryEventRecordPlans' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], - ], - [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], - ], - [ - 'name' => 'DeviceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], - ], - [ - 'name' => 'IotId', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], + 'schema' => ['description' => 'The page number to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StreamType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -7760,104 +6337,110 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'List' => [ + 'description' => 'The list of intelligent alert event recording plans.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventType' => ['description' => 'The intelligent alert event type. In the IoT Platform console, go to the **Product Details** page, click the **Feature Definition** tab, and find **Intelligent Alert** to view all intelligent alert event types.'."\n" + ."\n" + .'For more information, see [Intelligent alert events](~~207701~~).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RecordDuration' => ['description' => 'The recording duration, including the pre-recording duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'PreRecordDuration' => ['description' => 'The pre-recording duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'PlanId' => ['description' => 'The ID of the intelligent alert event recording plan.', 'type' => 'string', 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], + 'Name' => ['description' => 'The name of the intelligent alert event recording.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the time template.', 'type' => 'string', 'example' => '36f06322442e4e3f85a5ae8862c9****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'DeleteRecordPlanDevice', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query event recording plan list', + 'summary' => 'Queries the list of intelligent alert event recording plans.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common parameters when you call this operation. For more information, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SetDeviceRecordLifeCycle' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryEventRecordPlans'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryEventRecordPlans', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryFaceAllDeviceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], - ], - [ - 'name' => 'ProductKey', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'TestIotInstanceId', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd7XmBoJhAr88C6PelXDF00****', - ], + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'Day', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '7', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -7865,103 +6448,96 @@ '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' => 'InvalidParameter', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of device groups.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'DeviceGroupList' => [ + 'description' => 'The list of device groups.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceGroupId' => ['description' => 'The device group ID.', 'type' => 'string', 'example' => 'wy250q0m', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the device group was last modified.', 'type' => 'string', 'example' => '2020-05-12 17:19:29', 'title' => ''], + 'DeviceGroupName' => ['description' => 'The device group name.', 'type' => 'string', 'example' => 'TestDeviceGroupName', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'SetDeviceRecordLifeCycle', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query all device groups', + 'summary' => 'Queries all device groups.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'StopTriggeredRecord' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceAllDeviceGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceAllDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryFaceAllUserGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], - ], - [ - 'name' => 'ProductKey', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], ], [ - 'name' => 'DeviceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], - ], - [ - 'name' => 'RecordId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fc82774fa749485bad7d719f9670****', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -7969,118 +6545,96 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of user groups.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'UserGroupList' => [ + 'description' => 'The list of user groups.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserGroupName' => ['description' => 'The name of the user group.', 'type' => 'string', 'example' => 'TestUserGroupName', 'title' => ''], + 'ModifiedTime' => ['description' => 'The last modification time.', 'type' => 'string', 'example' => '2020-05-12 17:12:37', 'title' => ''], + 'UserGroupId' => ['description' => 'The user group ID.', 'type' => 'string', 'example' => 'dmjpxfdk', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'StopTriggeredRecord', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryFaceAllUserGroup', + 'summary' => 'Queries all user groups.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateEventRecordPlan' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceAllUserGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceAllUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryFaceAllUserGroupAndDeviceGroupRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'PlanId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5b60bf0dd55944c19d7817442bc9****', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'record1', - ], - ], - [ - 'name' => 'EventTypes', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PreRecordDuration', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '0', - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'Isolati***', 'title' => ''], ], [ - 'name' => 'RecordDuration', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '30', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'TemplateId', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '36f06322442e4e3f85a5ae8862c9****', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -8088,84 +6642,103 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Page' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'List' => [ + 'description' => 'The list of face synchronization relationships between user groups and device groups.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceGroupId' => ['description' => 'The device group ID.', 'type' => 'string', 'example' => 'TestDeviceGro****', 'title' => ''], + 'ControlId' => ['description' => 'The control ID of the synchronization relationship between the user group and the device group.', 'type' => 'string', 'example' => 'ni1iyxqry0j0****', 'title' => ''], + 'ModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2020-05-12 17:12:37', 'title' => ''], + 'ControlType' => ['description' => 'The face synchronization relationship, which synchronizes user photos and user information.', 'type' => 'string', 'example' => 'SYNC_INFO_PICTURE', 'title' => ''], + 'UserGroupId' => ['description' => 'The user group ID.', 'type' => 'string', 'example' => 'TestUserGro****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'UpdateEventRecordPlan', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query user groups and device groups with face synchronization relationships', + 'summary' => 'Queries the user groups and device groups that have face synchronization relationships.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateRecordPlan' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceAllUserGroupAndDeviceGroupRelation'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceAllUserGroupAndDeviceGroupRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryFaceAllUserIdsByGroupId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'PlanId', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '6c5a397bc17c4b48ace86f0f0c30****', - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'UserGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The user group ID.', 'type' => 'string', 'required' => true, 'example' => 'TestUserGroupId', 'title' => ''], ], [ - 'name' => 'TemplateId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '36f06322442e4e3f85a5ae8862c9****', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -8173,171 +6746,174 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of users.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Page' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'List' => [ + 'description' => 'The list of user information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Params' => ['description' => 'The user parameters.', 'type' => 'string', 'example' => '{"age":28, "sex":"male"}', 'title' => ''], + 'CustomUserId' => ['description' => 'The user ID in the caller\'s service.', 'type' => 'string', 'example' => 'TestCustomUserId', 'title' => ''], + 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'TestName', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'TestUserId', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'UpdateRecordPlan', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryFaceAllUserIdsByGroupId', + 'summary' => 'Queries all users in a user group.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRecord' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceAllUserIdsByGroupId'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceAllUserIdsByGroupId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryFaceCustomUserIdByUserId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProductKey', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'TestUserId', 'title' => ''], ], - [ - 'name' => 'IotId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The user ID in the caller\'s system.', 'type' => 'string', 'example' => 'TestCustomUserId', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"TestCustomUserId\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query user ID in the caller\'s service', + 'summary' => 'Queries the user ID in the caller\'s service based on the user ID from the face image library synchronization service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceCustomUserIdByUserId'], + ], + ], + 'ramActions' => [ [ - 'name' => 'StreamType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '0', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceCustomUserIdByUserId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryFaceDeviceGroupsByDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'BeginTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1508200012', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'EndTime', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1582420940', - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], ], [ - 'name' => 'RecordType', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIotInstanceId', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The product key.', 'type' => 'string', 'required' => true, 'example' => 'TestProductKey', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The device name.', 'type' => 'string', 'required' => true, 'example' => 'TestDeviceName', 'title' => ''], ], [ - 'name' => 'NeedSnapshot', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-060a****', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -8345,178 +6921,91 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The description of the error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'Page' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'List' => [ - 'description' => '', + 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of device groups.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'DeviceGroupList' => [ + 'description' => 'The list of device groups.', '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' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RecordType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'StreamType' => [ - 'description' => '', - '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', - ], + 'DeviceGroupId' => ['description' => 'The device group ID.', 'type' => 'string', 'example' => 'TestDeviceGroupId', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the device group was last modified.', 'type' => 'string', 'example' => '2020-05-12 17:12:37', 'title' => ''], + 'DeviceGroupName' => ['description' => 'The device group name.', 'type' => 'string', 'example' => 'TestDeviceGroupName', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryRecord', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query device groups of a device', + 'summary' => 'Queries the device groups to which a device belongs.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRecordByRecordId' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceDeviceGroupsByDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceDeviceGroupsByDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryFaceUser' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], - ], - [ - 'name' => 'DeviceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], - ], - [ - 'name' => 'IotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], - ], - [ - 'name' => 'RecordId', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2c5bf5b6a8704bd3a6a1517fd125****', - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-060a01****', - ], + 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'TestUserId', 'title' => ''], ], ], 'responses' => [ @@ -8524,274 +7013,276 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], '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' => '', - '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' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'Params' => ['description' => 'The user parameters.', 'type' => 'string', 'example' => '{"age":28, "sex":"male"}', 'title' => ''], + 'CustomUserId' => ['description' => 'The user ID in the caller\'s system.', 'type' => 'string', 'example' => 'TestCustomUserId', 'title' => ''], + 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'TestName', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'TestUserId', 'title' => ''], + 'FacePicList' => [ + 'description' => 'The list of face photo information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceUrl' => ['description' => 'The photo URL.', 'type' => 'string', 'example' => 'https://test.com/xxx.jpg', 'title' => ''], + 'FaceMd5' => ['description' => 'The MD5 value of the photo.', 'type' => 'string', 'example' => 'TestFaceMd5', 'title' => ''], + 'FeatureDTOList' => [ + 'description' => 'The list of face feature values.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AlgorithmName' => ['description' => 'The algorithm name.', 'type' => 'string', 'example' => 'TestAlgorithmName', 'title' => ''], + 'AlgorithmVersion' => ['description' => 'The algorithm version.', 'type' => 'string', 'example' => 'TestAlgorithmVersion', 'title' => ''], + 'AlgorithmProvider' => ['description' => 'The algorithm provider.', 'type' => 'string', 'example' => 'TestAlgorithmProvider', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'FaceMd5' => ['description' => 'The face MD5 value.', 'type' => 'string', 'example' => 'TestFaceMd5', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => '2020-10-12 14:07:20', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryRecordByRecordId', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query user details', + 'summary' => 'Queries the details of a user.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRecordPlanDetail' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceUser'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryFaceUserBatch' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'PlanId', + 'name' => 'UserIdList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The list of user IDs. Specify the user IDs that were obtained and saved locally after users were added by calling the [AddFaceUser](~~288338~~) operation.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, - 'example' => '5b60bf0dd55944c19d7817442bc9****', + 'example' => '["xqymlby****4whye","6qyyb69zqara****","64nbfx8****hzmy4"]', + 'maxItems' => 50, + 'title' => '', ], ], + [ + 'name' => 'IsolationId', + 'in' => 'query', + 'schema' => ['description' => 'The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. This value must be the same as the **IsolationId** specified when you called the [AddFaceUser](~~288338~~) operation to add users.', 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHZ', 'title' => ''], + ], ], '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: The request was successful.'."\n" + .'- Other codes: An error occurred. For more information about error codes, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'face user not exist', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + .'- **true**: The request was successful.'."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PlanId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5b60bf0dd55944c19d7817442bc9****', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '693e244a038f4255bb2f5db32874****', - ], - 'TemplateInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AllDay' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Default' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '693e244a038f4255bb2f5db32874****', - ], - 'TimeSectionList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'End' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], - 'DayOfWeek' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Begin' => [ + 'description' => 'The data returned if the request was successful.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Params' => ['description' => 'The custom user parameters.', 'type' => 'string', 'example' => '{"key1":"value1", "key2":"value2"}', 'title' => ''], + 'CustomUserId' => ['description' => 'The custom user ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], + 'CreateTime' => ['description' => 'The 13-digit timestamp when the user created the face data, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1636427314000', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '3mtjaqebeq4d****', 'title' => ''], + 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'Tony', 'title' => ''], + 'ModifyTime' => ['description' => 'The 13-digit timestamp when the user last modified the face data, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1636436864000', 'title' => ''], + 'FacePicList' => [ + 'description' => 'The list of face image information for the user.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceUrl' => ['description' => 'The URL of the user\'s face image.', 'type' => 'string', 'example' => 'https://example.com/test.jpeg', 'title' => ''], + 'FaceMd5' => ['description' => 'The MD5 value of the user\'s face image.', 'type' => 'string', 'example' => 'TestFaceMd5', 'title' => ''], + 'FeatureDTOList' => [ + 'description' => 'The list of facial feature values.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AlgorithmName' => ['description' => 'The algorithm name.', 'type' => 'string', 'example' => 'TestAlgorithmName', 'title' => ''], + 'AlgorithmVersion' => ['description' => 'The algorithm version.', 'type' => 'string', 'example' => 'TestAlgorithmVersion', 'title' => ''], + 'AlgorithmProvider' => ['description' => 'The algorithm provider.', 'type' => 'string', 'example' => 'TestAlgorithmProvider', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned when the algorithm execution failed.', 'type' => 'string', 'example' => 'parameter error', 'title' => ''], + 'ErrorCode' => ['description' => 'The algorithm response code.'."\n" + ."\n" + .'- **200**: The operation was successful.'."\n" + .'- Other codes: An error occurred. For more information about error codes, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'FaceMd5' => ['description' => 'The MD5 value of the facial feature.', 'type' => 'string', 'example' => 'TestFaceMd5', 'title' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6000', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryRecordPlanDetail', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Forbidden.RiskControl', 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryFaceUserBatch', + 'summary' => 'Queries user information in batches based on a list of user IDs.', + 'description' => '## Usage notes'."\n" + ."\n" + .'- The maximum number of queries per second (QPS) per Alibaba Cloud account for this operation is 100.'."\n" + ."\n" + .' > RAM users share the quota of the Alibaba Cloud account.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information about common request parameters, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRecordPlanDeviceByDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceUserBatch'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceUserBatch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryFaceUserByName' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IotInstanceId', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set this parameter to the same value as the **IsolationId** specified when you called the [AddFaceUser](~~288338~~) operation to add a user.', 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHZ', 'title' => ''], ], [ - 'name' => 'ProductKey', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The username. The username can contain letters, digits, underscores (_), hyphens (-), and Chinese characters, and can be up to 64 characters in length.'."\n" + ."\n" + .'Fuzzy match is supported. If you leave this parameter empty, all records are matched.', 'type' => 'string', 'required' => false, 'example' => 'Tony', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'Params', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The custom user parameter.'."\n" + ."\n" + .'Exact match is supported, but fuzzy match is not supported.', 'type' => 'string', 'required' => false, 'example' => '{"key1":"value1", "key2":"value2"}', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], + 'schema' => ['description' => 'The number of records per page. Maximum value: 50. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ - 'name' => 'StreamType', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => 'The page number to return. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -8799,162 +7290,157 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'face user not exist', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The data returned if the call is successful.', 'type' => 'object', 'properties' => [ - 'PlanId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5b60bf0dd55944c19d7817442bc9****', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '693e244a038f4255bb2f5db32874****', - ], - 'TemplateInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AllDay' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Default' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '693e244a038f4255bb2f5db32874****', - ], - 'TimeSectionList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'End' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], - 'DayOfWeek' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Begin' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6000', + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'List' => [ + 'description' => 'The list of face information returned if the call is successful.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Params' => ['description' => 'The custom user parameter.', 'type' => 'string', 'example' => '{"key1":"value1", "key2":"value2"}', 'title' => ''], + 'CustomUserId' => ['description' => 'The custom user identity ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], + 'CreateTime' => ['description' => 'The 13-digit timestamp when the face data was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1636427314000', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '3mtjaqebeq4d****', 'title' => ''], + 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'Tony', 'title' => ''], + 'ModifyTime' => ['description' => 'The timestamp of the last modification to the face data. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1636436864000', 'title' => ''], + 'FacePicList' => [ + 'description' => 'The list of face image information for the user.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FaceUrl' => ['description' => 'The URL of the face image.', 'type' => 'string', 'example' => 'https://example.com/test.jpeg', 'title' => ''], + 'FaceMd5' => ['description' => 'The MD5 value of the face image.', 'type' => 'string', 'example' => 'TestFaceMd5', 'title' => ''], + 'FeatureDTOList' => [ + 'description' => 'The list of face feature values.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AlgorithmName' => ['description' => 'The algorithm name.', 'type' => 'string', 'example' => 'TestAlgorithmName', 'title' => ''], + 'AlgorithmVersion' => ['description' => 'The algorithm version.', 'type' => 'string', 'example' => 'TestAlgorithmVersion', 'title' => ''], + 'AlgorithmProvider' => ['description' => 'The algorithm provider.', 'type' => 'string', 'example' => 'TestAlgorithmProvider', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned when the algorithm execution fails.', 'type' => 'string', 'example' => 'parameter error', 'title' => ''], + 'ErrorCode' => ['description' => 'The algorithm response code.'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'FaceMd5' => ['description' => 'The MD5 value of the face feature.', 'type' => 'string', 'example' => 'TestFaceMd5', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryRecordPlanDeviceByDevice', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Forbidden.RiskControl', 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query face data by face name', + 'summary' => 'Queries face data by face name.', + 'description' => '## Usage notes'."\n" + ."\n" + .'- The maximum number of queries per second (QPS) for a single Alibaba Cloud account when you invoke this operation is 100.'."\n" + ."\n" + .' > Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify common request parameters in addition to the operation-specific request parameters described in this topic. For metric description of common request parameters, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRecordPlanDeviceByPlan' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceUserByName'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceUserByName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryFaceUserGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'PlanId', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5b60bf0dd55944c19d7817442bc9****', - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'TestUserId', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -8962,309 +7448,449 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response data.', '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' => '', + 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of user groups.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'UserGroupList' => [ + 'description' => 'The list of user groups.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'StreamType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], + 'UserGroupName' => ['description' => 'The name of the user group.', 'type' => 'string', 'example' => 'TestUserGroupName', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the user group was last modified.', 'type' => 'string', 'example' => '2020-05-12 17:12:37', 'title' => ''], + 'UserGroupId' => ['description' => 'The ID of the user group.', 'type' => 'string', 'example' => 'TestUserGroupId', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryRecordPlanDeviceByPlan', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryFaceUserGroup', + 'summary' => 'Queries the user groups to which a user belongs.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRecordPlans' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceUserGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryFaceUserGroupAndDeviceGroupRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'CurrentPage', + 'name' => 'IsolationId', 'in' => 'query', + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], + ], + [ + 'name' => 'ControlId', + 'in' => 'query', + 'schema' => ['description' => 'The control ID of the face synchronization relationship between the user group and the device group.', 'type' => 'string', 'required' => true, 'example' => 'ni1iyxqry0j03plv', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'DeviceGroupId' => ['description' => 'The device group ID.', 'type' => 'string', 'example' => 'TestDeviceGroupId', 'title' => ''], + 'ControlId' => ['description' => 'The control ID of the face synchronization relationship between the user group and the device group.', 'type' => 'string', 'example' => 'ni1iyxqry0j03plv', 'title' => ''], + 'ModifiedTime' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '2020-05-12 17:12:37', 'title' => ''], + 'ControlType' => ['description' => 'The face synchronization relationship.', 'type' => 'string', 'example' => 'SYNC_INFO_PICTURE', 'title' => ''], + 'UserGroupId' => ['description' => 'The user group ID.', 'type' => 'string', 'example' => 'TestUserGroupId', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query face synchronization relationship between user group and device group', + 'summary' => 'Queries the face synchronization relationship between a user group and a device group.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceUserGroupAndDeviceGroupRelation'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceUserGroupAndDeviceGroupRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'QueryFaceUserIdByCustomUserId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'IsolationId', 'in' => 'query', + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], + ], + [ + 'name' => 'CustomUserId', + 'in' => 'query', + 'schema' => ['description' => 'The user ID in the caller\'s system.', 'type' => 'string', 'required' => true, 'example' => 'TestCustomUserId', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'Params' => ['description' => 'The user parameters.', 'type' => 'string', 'example' => '{"age":28, "sex":"male"}', 'title' => ''], + 'CustomUserId' => ['description' => 'The user ID in the caller\'s system.', 'type' => 'string', 'example' => 'TestCustomUserId', 'title' => ''], + 'Name' => ['description' => 'The username.', 'type' => 'string', 'example' => 'TestName', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'TestUserId', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query user ID in face image library synchronization service', + 'summary' => 'Queries the user ID in the face image library synchronization service based on the user ID in the caller\'s system.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceUserIdByCustomUserId'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceUserIdByCustomUserId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + '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', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PageStart', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '512', 'minimum' => '1', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + ], '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], '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' => '', + 'Total' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'GbSubDeviceList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'PlanId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6c5a397bc17c4b48ace86f0f0c30****', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'plan1', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '693e244a038f4255bb2f5db32874****', - ], + 'ProductKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceEnable' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryRecordPlans', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryRecordUrl' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'The RAM user does not have permissions to access the resource.'], + ['errorCode' => 'iot.vision.GbServiceNotEnabled', 'errorMessage' => 'The GB28181 service has not been enabled.', 'description' => 'The standard service is not started.'], + ['errorCode' => 'iot.vision.GbIdDuplicate', 'errorMessage' => 'The GB28181 deviceId is duplicated.', 'description' => 'The standard ID already exists.'], + ], + 403 => [ + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryGbSubDeviceList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryGbSubDeviceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Total\\": 0,\\n \\"GbSubDeviceList\\": [\\n {\\n \\"ProductKey\\": \\"\\",\\n \\"DeviceName\\": \\"\\",\\n \\"DeviceId\\": \\"\\",\\n \\"DeviceEnable\\": 0,\\n \\"IotId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryLiveStreaming' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'FileName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'file1', - ], - ], - [ - 'name' => 'SeekTime', + 'name' => 'Scheme', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The type of streaming protocol:'."\n" + ."\n" + .'- **rtmp** (default): RTMP protocol.'."\n" + .'- **hls**: HLS protocol.'."\n" + .'- **flv**: HTTP-FLV protocol.', 'type' => 'string', 'required' => false, 'default' => 'rtmp', 'example' => 'rtmp', 'title' => ''], ], [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y****', - ], + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Instance Overview** page of the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value is available, you must specify this ID value. Otherwise, the call fails.'."\n" + .'- If <props="intl"><ph>the **Instance Overview** page or</ph></props>no ID value is available, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the information about all products under the current account on the **Products** page of the IoT Platform console or by calling [QueryProductList](~~69271~~).'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], + ], + [ + 'name' => 'EnableStun', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'StreamType', + 'in' => 'query', + 'schema' => ['description' => 'The stream type:'."\n" + .'- **0** (default): Main stream.'."\n" + .'- **1**: Sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'CacheDuration', + 'in' => 'query', + 'schema' => ['description' => 'The duration of cached video data. Valid values: 0 to 10000. Unit: milliseconds. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '0', 'default' => '0', 'example' => '0', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', - ], + 'schema' => ['description' => 'The device ID of the IPC device. The ID is issued by IoT Platform and is the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** and **DeviceName**. **IotId** is the unique identifier of the device and has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], + ], + [ + 'name' => 'ShouldEncrypt', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to encrypt the stream:'."\n" + ."\n" + .'- **true**: Encrypt.'."\n" + .'- **false** (default): Do not encrypt.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''], ], [ 'name' => 'UrlValidDuration', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '3600', - 'minimum' => '10', - 'example' => '10', - ], + 'schema' => ['description' => 'The validity period of the URL. Valid values: 10 to 14400. Unit: seconds. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], + ], + [ + 'name' => 'PlayUnLimited', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the playback URL can be used an unlimited number of times within the validity period:'."\n" + .'- **true**: Allowed.'."\n" + .'- **false** (default): Not allowed.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'EncryptType', + 'in' => 'query', + 'schema' => ['description' => 'The encryption type:'."\n" + .'- **1** (default): Key frame encryption.'."\n" + .'- **0**: No encryption.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ForceIFrame', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to send a force I-frame command to the device:'."\n" + ."\n" + .'- **true**: Send.'."\n" + .'- **false** (default): Do not send.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -9272,80 +7898,84 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'Code' => ['description' => 'The response code:'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'stream push failed', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The playback URL information.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The live streaming playback URL.'."\n" + .'>The playback URL is valid for 10 seconds.', 'type' => 'string', 'example' => 'rtmp://47.100.***.***:8000/live?token=dc1****120ce394ef94974/Eb****6RBe8l4_0', 'title' => ''], + 'RelayDecryptKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StunInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryRecordUrl', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryLiveStreaming', + 'summary' => 'Queries the live streaming playback URL of an IPC device.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common request parameters when you call this API operation. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryTimeTemplate' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryLiveStreaming'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryLiveStreaming', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryLocalFileUploadJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'CurrentPage', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console. If an ID value exists, you must specify this ID. Otherwise, the call fails.'."\n" + ."\n" + .'> If no ID value is available for the public instance, refer to [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the local video upload task. The task is created by calling [CreateLocalFileUploadJob](~~363002~~).', 'type' => 'string', 'required' => true, 'example' => '1ec1a****5d0435fbc0****34f6f139d', 'title' => ''], ], ], 'responses' => [ @@ -9353,191 +7983,161 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '449ECE75-A36A-4ACE-B253-147C78C440C5', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: success.'."\n" + .'- **false**: failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The query result.', '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' => '', + 'Status' => ['description' => 'The status of the video upload task. Valid values:'."\n" + ."\n" + .'- 0: the task is being initialized.'."\n" + .'- 1: the task is running.'."\n" + .'- 2: the task is complete.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'ResultList' => [ + 'description' => 'The task list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'AllDay' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Default' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'exampleName', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'adxxx', - ], - 'TimeSectionList' => [ - 'description' => '', + 'SlotEndTime' => ['description' => 'The end time of the video upload task.', 'type' => 'integer', 'format' => 'int32', 'example' => '1634746054', 'title' => ''], + 'ProductKey' => ['description' => 'The ProductKey of the product to which the video device belongs.', 'type' => 'string', 'example' => 'g2****Q6ggK', 'title' => ''], + 'DeviceName' => ['description' => 'The name of the video device.', 'type' => 'string', 'example' => 'gb_hik_IPC', 'title' => ''], + 'SlotStartTime' => ['description' => 'The start time of the video upload task.', 'type' => 'integer', 'format' => 'int32', 'example' => '1634745754', 'title' => ''], + 'Code' => ['description' => 'The status code of the video upload task. Valid values:'."\n" + ."\n" + .'- 200: normal.'."\n" + .'- 9201: the device is offline. Bring the device online and try again.'."\n" + .'- 9409: no cloud storage quota is available. Check the cloud storage quota and try again.'."\n" + .'- 9417: a device, network, or other exception occurred. Try again, or check the device and network status.'."\n" + .'- 9435: the video file does not exist. Make sure the video file exists on the local device, and then try again.', 'type' => 'integer', 'format' => 'int32', 'example' => '9201', 'title' => ''], + 'SlotStatus' => ['description' => 'The execution status of the video upload task within the time range specified by SlotStartTime and SlotEndTime. Valid values:'."\n" + .'- 0: the task is being initialized.'."\n" + .'- 1: the task is running.'."\n" + .'- 2: the task is complete.'."\n" + .'- 3: the task encountered an exception.'."\n" + .'- 4: the task was manually terminated.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'IotId' => ['description' => 'The device ID of the video device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.', 'type' => 'string', 'example' => 'IQ9mO4tvMnAj****QUdcg2n400', 'title' => ''], + 'FileList' => [ + 'description' => 'The list of video files.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'End' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60000', - ], - 'DayOfWeek' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Begin' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], + 'FileName' => ['description' => 'The name of the video file.', 'type' => 'string', 'example' => 'video1', 'title' => ''], + 'FileStartTime' => ['description' => 'The start time of the video file.', 'type' => 'integer', 'format' => 'int32', 'example' => '1634747054', 'title' => ''], + 'FileEndTime' => ['description' => 'The end time of the video file.', 'type' => 'integer', 'format' => 'int32', 'example' => '1634746054', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryTimeTemplate', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query local video upload task result', + 'summary' => 'Queries the task result of a local video upload node.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryDeviceEventRecord' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryLocalFileUploadJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryLocalFileUploadJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryMonthRecord' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console or call [QueryProductList](~~69271~~) to view information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], + 'schema' => ['description' => 'The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', 'title' => ''], ], [ - 'name' => 'EventId', + 'name' => 'Month', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '907084996e1d44788d0*****43906_160803*****37', - ], + 'schema' => ['description' => 'The month to query, in the format of YYYYMM.', 'type' => 'string', 'required' => true, 'example' => '201901', 'title' => ''], ], [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1****z0t', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'<props="china">You can view the **ID** of the current instance on the **Overview** page of the IoT Platform console. If an ID value exists, you must specify this parameter. Otherwise, the call fails.</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> If the public instance does not have an ID value, refer to [How to obtain an instance ID](~~267533~~).</props>'."\n" + ."\n" + .'<props="intl">You do not need to specify this parameter.</props>.', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y****', 'title' => ''], ], ], 'responses' => [ @@ -9545,209 +8145,139 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'rtmp://****/****.mp4', - ], - 'BeginTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-08 15:55:35', - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The returned data. The length equals the number of days in the specified month. Each digit indicates whether a recording exists for that day. Valid values:'."\n" + ."\n" + .'- **1**: a recording exists.'."\n" + .'- **0**: no recording exists.', 'type' => 'string', 'example' => '110111111011111001111100111110', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: the call was successful.'."\n" + .'- **false**: the call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryDeviceEventRecord', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"110111111011111001111100111110\\",\\n \\"ErrorMessage\\": \\"tenant auth error.\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query monthly recordings', + 'summary' => 'Queries whether video recordings exist for each day of a specified month on an IPC device.', + 'requestParamsDescription' => 'When you invoke this operation, you must also specify common request parameters in addition to the operation-specific request parameters described in this topic. For the metric description of common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryDeviceVodUrl' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMonthRecord'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryMonthRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryPictureFiles' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'FileName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'file1', - ], - ], - [ - 'name' => 'Scheme', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rtmp', - ], - ], - [ - 'name' => 'SeekTime', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console, or call [QueryProductList](~~69271~~) to query information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'ProductKey', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** is a globally unique identifier for the device and corresponds one-to-one with the combination of **ProductKey** and **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'BeginTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The start time of the query range. The value is a 13-digit UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615357669000', 'title' => ''], ], [ - 'name' => 'EnableStun', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['description' => 'The end time of the query range. The value is a 13-digit UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1615444063000', 'title' => ''], ], [ - 'name' => 'ShouldEncrypt', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'The page number to return. Pages start from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'UrlValidDuration', + 'name' => 'PictureType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => 'The image type. Valid values:'."\n" + ."\n" + .'- **0**: thumbnail. '."\n" + .'- **1**: original image.'."\n" + .'- **2** (default): all.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ - 'name' => 'PlayUnLimited', + 'name' => 'PictureSource', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'The image source. Valid values:'."\n" + ."\n" + .'- **0** (default): all events.'."\n" + .'- **1**: alert event capture.'."\n" + .'- **2**: active capture.'."\n" + .'- **3**: other.'."\n" + .'- **4**: cloud screenshot.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'EncryptType', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Instance Overview** page of the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value exists, you must specify this parameter. Otherwise, the call fails.'."\n" + .'- If <props="intl"><ph>the **Instance Overview** page or </ph></props>no ID value exists, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Instance overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y****', 'title' => ''], ], ], 'responses' => [ @@ -9755,122 +8285,120 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'product is not active.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'DecryptKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"iv": "MDEy****OTo7PD0+Pw==","key": "eA2r****fHjOmnyBfQ=="}', - ], - 'StunInfo' => [ - 'type' => 'string', - ], - 'VodUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtmp://***/***.mp4', + 'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'List' => [ + 'description' => 'The list of images returned.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PicId' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'pZJUqijOyfpFOOGNP******', 'title' => ''], + 'PicUrl' => ['description' => 'The image URL.'."\n" + ."\n" + .'> The URL is valid for 1 hour.', 'type' => 'string', 'example' => 'http://***_normal.jpg', 'title' => ''], + 'PicCreateTime' => ['description' => 'The time when the image was created. The value is a 13-digit UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1543458157522', 'title' => ''], + 'ThumbUrl' => ['description' => 'The thumbnail URL.'."\n" + ."\n" + .'> The URL is valid for 1 hour.', 'type' => 'string', 'example' => 'http://***.jpg', 'title' => ''], + 'IotId' => ['description' => 'The device ID of the IPC device.', 'type' => 'string', 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryDeviceVodUrl', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve image list', + 'summary' => 'Retrieves a list of images.', + 'description' => '## QPS limit'."\n" + ."\n" + .'The maximum queries per second (QPS) per Alibaba Cloud account for this operation is 500.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under a single Alibaba Cloud account share this quota.', + 'requestParamsDescription' => 'When you invoke this operation, you must also specify common request parameters in addition to the operation-specific request parameters described in this topic. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryMonthRecord' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPictureFiles'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryPictureFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryPictureSearchAiboxes' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], - ], - [ - 'name' => 'DeviceName', + 'name' => 'AppInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The ID of the image search application instance. You can call the [QueryPictureSearchApps](~~206608~~) operation to query the ID.', 'type' => 'string', 'required' => true, 'example' => '5a502d3fbab8410e8fd4be9037c7****', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', - ], + 'schema' => ['description' => 'The number of entries per page. Maximum value: 30. Minimum value: 1. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ - 'name' => 'Month', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '201901', - ], + 'schema' => ['description' => 'The page number to return. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view your instance ID on the **Overview** page in the IoT Platform console.'."\n" + ."\n" + .'> If no ID is available for the public instance, see [How do I obtain an instance ID?](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot_instc_pu****_c*-v64********', 'title' => ''], ], ], 'responses' => [ @@ -9878,160 +8406,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'Code' => ['description' => 'The response code.'."\n" + .'- **200**: The request was successful.'."\n" + .'- Other codes: An error occurred. For more information about error codes, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'Specified parameter CurrentPage is not valid.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => 'DF7DC571-FE48-4C25-8BE0-B13C3038C85B', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + .'- **true**: The request was successful.'."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '110111111011111001111100111110', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tenant auth error.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The data returned if the request was successful.', + 'type' => 'object', + 'properties' => [ + 'CurrentPage' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageData' => [ + 'description' => 'The list of V-series edge all-in-one devices.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NickName' => ['description' => 'The alias of the device that corresponds to the V-series edge all-in-one device.', 'type' => 'string', 'example' => 'box015', 'title' => ''], + 'IotId' => ['description' => 'The device ID that corresponds to the V-series edge all-in-one device.', 'type' => 'string', 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryMonthRecord', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Forbidden.RiskControl', 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryPictureSearchAiboxes', + 'summary' => 'Queries the list of V-series edge all-in-one devices that are bound to an image search application instance.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryDeviceRecordLifeCycle' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPictureSearchAiboxes'], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'DeviceList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'example' => '["C47T6xwp6ms4bNlkHRWCg4****", "d7XmBoJhAr88C6PelXDF00****"]', - 'maxItems' => 100, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidParameters', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Day' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], - ], - ], - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryPictureSearchAiboxes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - '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' => 'QueryDeviceRecordLifeCycle', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'QueryEventRecordPlanDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryPictureSearchApps' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'PlanId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5b60bf0dd55944c19d7817442bc9****', - ], + 'schema' => ['description' => 'The number of records per page in the response. Maximum value: 50. Minimum value: 1. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '20', 'minimum' => '1', 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The page number to start displaying from in the response. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Instance Overview** page in the IoT Platform console. If an ID value exists, you must specify this ID value. Otherwise, the call fails.'."\n" + ."\n" + .'> If no ID value is available for the public instance, see [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot_instc_pu****_c*-v64********', 'title' => ''], ], ], 'responses' => [ @@ -10039,193 +8515,112 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + .'- **200**: Success.'."\n" + .'- Other codes: Error codes. For more information, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Specified parameter CurrentPage is not valid.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '2C794BB1-0494-4E4E-AACF-174F04CD1F10', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The data returned if the call is successful.', 'type' => 'object', 'properties' => [ - 'PreRecordDuration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'record1', - ], - 'PlanId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5b60bf0dd55944c19d7817442bc9****', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '36f06322442e4e3f85a5ae8862c9****', - ], - 'RecordDuration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120', - ], - 'TemplateInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AllDay' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Default' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'temp1', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '36f06322442e4e3f85a5ae8862c9****', - ], - 'TimeSectionList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'End' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], - 'DayOfWeek' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Begin' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6000', - ], - ], - ], + 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page in the response.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of created image search application instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageData' => [ + 'description' => 'The list of image search application instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppInstanceId' => ['description' => 'The instance ID of the image search application.', 'type' => 'string', 'example' => '3e429560124b44b685095df81a27****', 'title' => ''], + 'ModifiedTime' => ['description' => 'The 13-digit timestamp when the image search application instance was modified, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614328081000', 'title' => ''], + 'Description' => ['description' => 'The description of the image search application instance.', 'type' => 'string', 'example' => '以图搜图Demo2', 'title' => ''], + 'Version' => ['description' => 'The version number of the image search application instance template.', 'type' => 'string', 'example' => '1.0.0', 'title' => ''], + 'CreateTime' => ['description' => 'The 13-digit timestamp when the image search application instance was created, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614327915000', 'title' => ''], + 'AppTemplateId' => ['description' => 'The template ID of the image search application instance.', 'type' => 'string', 'example' => '7b50e7acb2574a789226099300cc****', 'title' => ''], + 'Name' => ['description' => 'The name of the image search application instance.', 'type' => 'string', 'example' => '新以图搜图', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryEventRecordPlanDetail', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Forbidden.RiskControl', 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryPictureSearchApps', + 'summary' => 'Queries the list of created image search application instances.', + 'description' => '## Before you begin'."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account for this operation is 100.'."\n" + .' > Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information, see [Common parameters](~~288312~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryEventRecordPlanDeviceByDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPictureSearchApps'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryPictureSearchApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryPictureSearchDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], - ], - [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], - ], - [ - 'name' => 'DeviceName', + 'name' => 'AppInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'Instance ID of the image search application instance. You can call [QueryPictureSearchApps](~~206608~~) to query instance ID.', 'type' => 'string', 'required' => true, 'example' => '5a502d3fbab8410e8fd4be9037c7****', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', - ], + 'schema' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '20', 'example' => '10', 'title' => ''], ], [ - 'name' => 'StreamType', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The page number to return. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -10233,174 +8628,112 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Specified parameter CurrentPage is not valid.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'DF7DC571-FE48-4C25-8BE0-B13C3038C85B', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'PreRecordDuration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'planAA', - ], - 'PlanId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5b60bf0dd55944c19d7817442bc9****', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '36f06322442e4e3f85a5ae8862c9****', - ], - 'RecordDuration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120', - ], - 'TemplateInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AllDay' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Default' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testtime1', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '36f06322442e4e3f85a5ae8862c9****', - ], - 'TimeSectionList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'End' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '86399', - ], - 'DayOfWeek' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Begin' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], + 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page in the response.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageData' => [ + 'description' => 'The list of applications.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NickName' => ['description' => 'The device alias.'."\n" + ."\n" + .'> This parameter is returned only for IPC devices.', 'type' => 'string', 'example' => 'camera1', 'title' => ''], + 'IotId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryEventRecordPlanDeviceByDevice', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query image search devices', + 'summary' => 'Queries the list of devices bound to an image search application instance.', + 'requestParamsDescription' => 'When you invoke this API operation, you must specify common request parameters in addition to the operation-specific request parameters described in this topic. For the metric description of common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryEventRecordPlanDeviceByPlan' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPictureSearchDevices'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryPictureSearchDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryPictureSearchJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'PlanId', + 'name' => 'AppInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5b60bf0dd55944c19d7817442bc9****', - ], + 'schema' => ['description' => 'Instance ID of the image search application instance. You can call [QueryPictureSearchApps](~~206608~~) to query instance ID.', 'type' => 'string', 'required' => true, 'example' => 'fdc576d03c094faea9fa10fbf48c****', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'JobStatus', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The task status. Valid values:'."\n" + .'- 0: init'."\n" + .'- 1: no data'."\n" + .'- 2: running'."\n" + .'- 3: succeeded'."\n" + .'- 4: failed'."\n" + ."\n" + .'If this parameter is not specified, all statuses are selected.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'example' => '3', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '20', 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The page number to start displaying from in the returned results. Pages start from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -10408,126 +8741,119 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Specified access key is not found.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '8FAF4001-2A53-46DF-B83E-306B8070E131', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response data.', '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' => '', + 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageData' => [ + 'description' => 'The list of applications.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'StreamType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'P7WqhWvhplhHlWPO9Op5g4****', - ], + 'EndTime' => ['description' => 'The end time of the search range. The value is a 13-digit UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614850763692', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the search range. The value is a 13-digit UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614814763692', 'title' => ''], + 'JobStatus' => ['description' => 'The task status. Valid values:'."\n" + .'- 0: init'."\n" + .'- 1: no data'."\n" + .'- 2: running'."\n" + .'- 3: succeeded'."\n" + .'- 4: failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'SearchPicUrl' => ['description' => 'The URL of the search image.', 'type' => 'string', 'example' => 'http://xxx.xxx.com/1.jpg', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the image search task was created. The value is a 13-digit UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614850763000', 'title' => ''], + 'JobId' => ['description' => 'The ID of the image search task.', 'type' => 'string', 'example' => 'b3786935a71442efae014c7b2212****', 'title' => ''], + 'Threshold' => ['description' => 'The search similarity threshold.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryEventRecordPlanDeviceByPlan', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Forbidden.RiskControl', 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query image search jobs', + 'summary' => 'Queries the list of integrated image search tasks.', + 'description' => 'Integrated image search indicates that both face and body are retrieved simultaneously during image search.'."\n" + .'> This feature requires the deployment of face and body detection algorithms on V-series edge devices.', + 'requestParamsDescription' => 'When you invoke this API operation, you must also specify common request parameters in addition to the operation-specific request parameters described in this topic. For metric description of common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryEventRecordPlans' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPictureSearchJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryPictureSearchJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryPictureSearchJobResult' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'CurrentPage', + 'name' => 'AppInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Instance ID of the image search application instance. You can call [QueryPictureSearchApps](~~206608~~) to query instance ID.', 'type' => 'string', 'required' => true, 'example' => 'fdc576d03c094faea9fa10fbf48c****', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the integrated image search task. You can call [QueryPictureSearchJob](~~206778~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => 'b7e501d0d2524a4caeb50df3282a****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '20', 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The page number to return. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -10535,196 +8861,179 @@ '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'AppInstanceId is mandatory for this action.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'a06c4750-7cce-11eb-8010-557d50136505', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The response result.', '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' => '', + 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageData' => [ + 'description' => 'The query results.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'EventType' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'RecordDuration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'PreRecordDuration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'PlanId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5b60bf0dd55944c19d7817442bc9****', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '36f06322442e4e3f85a5ae8862c9****', - ], + 'PicUrl' => ['description' => 'The URL of the image to be searched.', 'type' => 'string', 'example' => 'https://xxx.xxx.xxx.com/xxx', 'title' => ''], + 'EventTime' => ['description' => 'The time when the event was created. The value is a 13-digit UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614333155075', 'title' => ''], + 'GatewayIotId' => ['description' => 'The IotId of the V-series edge all-in-one device.', 'type' => 'string', 'example' => 'pZJUqijOyfpFOOGNPF7S00****', 'title' => ''], + 'VectorId' => ['description' => 'The feature ID of the image.', 'type' => 'string', 'example' => 'vectorId86d9a5c32b9947278e526c2eef8a****', 'title' => ''], + 'DeviceNickName' => ['description' => 'The alias of the device.'."\n" + ."\n" + .'> If no alias is set for the device, this parameter is not returned.', 'type' => 'string', 'example' => 'camera1', 'title' => ''], + 'Threshold' => ['description' => 'The face similarity score.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], + 'IotId' => ['description' => 'The IotId of the queried device.', 'type' => 'string', 'example' => '5RUngwC1RknD4lPiHgH300****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'QueryEventRecordPlans', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Forbidden.RiskControl', 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query image search job results', + 'summary' => 'Queries the image search results of an integrated image search task.', + 'requestParamsDescription' => 'When you invoke this API operation, you must specify not only the operation-specific request parameters described in this topic but also common request parameters. For metric description of common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'TriggerRecord' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPictureSearchJobResult'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryPictureSearchJobResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRecord' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console, or call [QueryProductList](~~69271~~) to view information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'zLZyi6aOLyOSHa****yD000100', - ], + 'schema' => ['description' => 'The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call [QueryDeviceDetail](~~69594~~) on IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** is a globally unique identifier of a device, and corresponds to a combination of **ProductKey** and **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], [ 'name' => 'StreamType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The stream type:'."\n" + .'- **0** (default): Main stream.'."\n" + .'- **1**: Sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '1', 'title' => ''], ], [ - 'name' => 'PreRecordDuration', + 'name' => 'BeginTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => 'The start time of the query range. The value is a 10-digit UNIX timestamp, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1508200012', 'title' => ''], ], [ - 'name' => 'RecordDuration', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '60', - ], + 'schema' => ['description' => 'The end time of the query range. The value is a 10-digit UNIX timestamp, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1582420940', 'title' => ''], + ], + [ + 'name' => 'RecordType', + 'in' => 'query', + 'schema' => ['description' => 'The recording type:'."\n" + ."\n" + .'- **0**: Continuous recording.'."\n" + .'- **1**: Smart alert event recording.'."\n" + .'- **2** (default): Manual recording.'."\n" + ."\n" + .'If this parameter is left empty, recordings of all types are returned.'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The page number to start displaying from in the returned results. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NeedSnapshot', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether thumbnails are required:'."\n" + ."\n" + .'- **true**: Required.'."\n" + .'- **false** (default): Not required.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''], ], [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y5****0t', - ], + 'schema' => ['description' => 'The instance ID. You can view the ID of the current instance on the **Overview** tab of the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If the instance has an ID, you must specify this **ID**. Otherwise, the call will fail.'."\n" + .'- If no ID exists, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-060a****', 'title' => ''], ], ], 'responses' => [ @@ -10732,147 +9041,232 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'Code' => ['description' => 'The response code:'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for this request.'."\n", 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fc82774fa749485bad7d719f9670****', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tenant auth error', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'List' => [ + 'description' => 'The list of recordings returned.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SnapshotUrl' => ['description' => 'The thumbnail URL.', 'type' => 'string', 'example' => 'https://lin****/****2Cq_90', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the recording.', 'type' => 'string', 'example' => '2018-09-10 00:00:30', 'title' => ''], + 'EventType' => ['description' => 'This parameter is returned when the recording type (**RecordType**) is **Smart alert event recording**, indicating the event type corresponding to the recording.'."\n" + ."\n" + .'For example, **1** indicates a motion detection event.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RecordType' => ['description' => 'The recording type:'."\n" + ."\n" + .'- **0**: Continuous recording.'."\n" + .'- **1**: Smart alert event recording.'."\n" + .'- **2**: Manual recording.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'StreamType' => ['description' => 'The stream type:'."\n" + .'- **0**: Main stream.'."\n" + .'- **1**: Sub stream.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BeginTime' => ['description' => 'The start time of the recording.', 'type' => 'string', 'example' => '2018-09-10 00:00:00', 'title' => ''], + 'FileName' => ['description' => 'The name of the recording file.', 'type' => 'string', 'example' => 'file1', 'title' => ''], + 'VideoFrameNumber' => ['description' => 'The number of video frames in the recording file.', 'type' => 'integer', 'format' => 'int32', 'example' => '1352', 'title' => ''], + 'FileSize' => ['description' => 'The size of the recording file, in bytes.', 'type' => 'integer', 'format' => 'int32', 'example' => '204800', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'TriggerRecord', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query recording list', + 'summary' => 'Queries the list of cloud recordings.', + 'description' => '## QPS limit'."\n" + ."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account for this operation is 250.'."\n" + ."\n" + .'> All RAM users under a single Alibaba Cloud account share the quota of that account.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also include common request parameters when calling this API. For more information about common request parameters, see [Common parameters](~~141505~~).'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryDevicePictureByList' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecord'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRecordByRecordId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view it on the **Products** page of the IoT Platform console, or call [QueryProductList](~~69271~~) to view information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1CJ0****e7qiq8VkQi1000000', - ], + 'schema' => ['description' => 'The ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** and **DeviceName**. **IotId** serves as the unique identifier of the device and has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], ], [ - 'name' => 'ThumbWidth', + 'name' => 'RecordId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - 'default' => '0', - ], + 'schema' => ['description' => 'The ID of the recording file. You can call [QueryRecord](~~107922~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '2c5bf5b6a8704bd3a6a1517fd125****', 'title' => ''], ], [ - 'name' => 'ExpireTime', + 'name' => 'IotInstanceId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.'."\n" + ."\n" + .'<props="china">You can view the **ID** of the current instance on the **Overview** page of the IoT Platform console. If an ID value exists, you must specify this ID value. Otherwise, the call fails.</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> If the public instance does not have an ID value, see [How to obtain an instance ID](~~267533~~).</props>'."\n" + ."\n" + .'<props="intl">You do not need to specify this parameter.</props>', 'type' => 'string', 'required' => false, 'example' => 'iot-060a01****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code of the API:'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information about error codes, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'F46E12A5-633D-4761-80F2-285752A052D5', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'RecordId is mandatory for this action.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time of the recording.', 'type' => 'string', 'example' => '2020-10-12 14:07:31', 'title' => ''], + 'FileName' => ['description' => 'The name of the recording file.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'VodUrl' => ['description' => 'The URL of the recording file.', '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', 'title' => ''], + 'BeginTime' => ['description' => 'The start time of the recording.', 'type' => 'string', 'example' => '2020-10-12 14:07:20', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - 'default' => '0', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query recording information by device and recording ID', + 'summary' => 'Queries the URL of a recording file by the recording file ID.', + 'requestParamsDescription' => 'When you call the API, in addition to the request parameters described in this topic, you must also include common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordByRecordId'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PictureType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - 'default' => '2', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordByRecordId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryRecordDownloadJobById' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y******', - ], + 'schema' => ['description' => 'The instance ID. You can view the ID of the current instance on the **Overview** tab of the IoT Platform console.', 'type' => 'string', 'required' => true, 'example' => 'Iot-r******', 'title' => ''], ], [ - 'name' => 'PictureIdList', + 'name' => 'JobId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'example' => 'cFc5MzZ****npYT1***TDFzX1hrVzA0Z****', - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The ID of the cloud recording download task.', 'type' => 'string', 'required' => true, 'example' => 'w2s******', 'title' => ''], ], ], 'responses' => [ @@ -10880,86 +9274,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'request forbidden', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code of the call result:'."\n" + ."\n" + .'- If the call is successful, **200** is returned.'."\n" + .'- If the call fails, an error code is returned. For more information, see **Error codes** below.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request failed.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ + 'description' => 'The data returned if the call is successful.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'picData' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PicId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RW****HFRO****jUyMjIy', - ], - 'PicUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEp****%3D', - ], - 'PicCreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632453652222', - ], - 'ThumbUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEpDE****%2Cq_90', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1CJ0****e7qiq8VkQi1000000', - ], - ], - ], - ], + 'Status' => ['description' => 'The generation status of the recording file.'."\n" + ."\n" + .'- **-1**: An exception occurred during recording file generation.'."\n" + .'- **0**: The recording file has been generated.'."\n" + .'- **1**: The recording file is being generated.', 'type' => 'integer', 'format' => 'int32', 'example' => '-1', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the query range. The value is a 10-digit UNIX timestamp. Unit: seconds. Valid values: 0 to 2147483647.', 'type' => 'integer', 'format' => 'int32', 'example' => '2100000000', 'title' => ''], + 'Type' => ['description' => 'The download type.'."\n" + ."\n" + .'- **1**: Download by file.'."\n" + .'- **2**: Download cloud recordings of the device by time range.'."\n" + .'- **3**: Download local recordings of the device by time range.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Progress' => ['description' => 'The progress of recording file generation. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '90', 'title' => ''], + 'RecordType' => ['description' => 'The recording type.'."\n" + ."\n" + .'- **0**: Continuous recording.'."\n" + .'- **1**: Event-triggered recording.'."\n" + .'- **2**: Active recording.'."\n" + .'- **4**: Local-to-cloud recording.'."\n" + .'- **99**: Mixed type.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'StreamType' => ['description' => 'The stream type.'."\n" + ."\n" + .'- **0**: Main stream.'."\n" + .'- **1**: Sub stream.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BeginTime' => ['description' => 'The start time of the query range. The value is a 10-digit UNIX timestamp. Unit: seconds. Valid values: 0 to 2147483647.', 'type' => 'integer', 'format' => 'int32', 'example' => '1900000000', 'title' => ''], + 'Url' => ['description' => 'The download URL of the cloud recording. The URL is valid for 1 hour.', 'type' => 'string', 'example' => 'http://*********', 'title' => ''], + 'JobErrorCode' => ['description' => 'The error code of the task. This parameter is returned when **Status** is **-1**:'."\n" + ."\n" + .'- **9441**: Network exception.'."\n" + .'- **9442**: Audio/video data error.', 'type' => 'integer', 'format' => 'int32', 'example' => '9441', 'title' => ''], + 'FileName' => ['description' => 'The file name. This parameter is displayed when **Type** is **1**.', 'type' => 'string', 'example' => 'testfile', 'title' => ''], + 'IotId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.JobNotExist', 'errorMessage' => 'Job not exist or expired.', 'description' => 'The task does not exist or has expired.'], + ], + 403 => [ + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryRecordDownloadJobById', + 'summary' => 'Queries the details of a cloud recording download task by task ID, including the start time, recording progress, recording type, and download URL.', + 'description' => '## Usage notes'."\n" + ."\n" + .'The obtained recording download URL is valid for 1 hour.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account for this operation is 50.'."\n" + ."\n" + .'> All RAM users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this API operation. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'TransferDeviceInstance' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordDownloadJobById'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordDownloadJobById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRecordDownloadJobList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10968,49 +9384,45 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'DeviceNameList', + 'name' => 'IotInstanceId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'example' => 'RepeatList', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The instance ID. You can view the ID of the current instance on the **Instance Overview** tab of the IoT Platform console.', 'type' => 'string', 'required' => true, 'example' => 'iot-2w******', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of devices to display on each page of the returned results. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the video device belongs.'."\n" + ."\n" + .'You can view information about all products under the current instance on the **Products** page of the [IoT Platform console](https://iot.console.aliyun.com/product) or by calling the [QueryProductList](~~69271~~) operation.'."\n" + ."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1Bw******', 'title' => ''], ], [ - 'name' => 'SourceInstanceId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iotx-oxssharez200', - ], + 'schema' => ['description' => 'The name of the video device. You can view the **DeviceName** of devices under a specified product on the **Devices** page of the [IoT Platform console](https://iot.console.aliyun.com/devices) or by calling the [QueryDevice](~~69905~~) operation.'."\n" + ."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'Device01', 'title' => ''], ], [ - 'name' => 'TargetInstanceId', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'iot-060***', - ], + 'schema' => ['description' => 'The ID of the video device. You can call the [QueryDeviceDetail](~~69594~~) operation to query the device ID.'."\n" + ."\n" + .'><notice> **IotId** is a globally unique identifier of a device that corresponds one-to-one with the combination of **ProductKey** and **DeviceName**. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The page number from which to start displaying the returned results. Pages start from page 1 by default.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -11018,89 +9430,124 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '27AF2E38-12ED-4F67-BD20-36E812CD7A42', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code of the call result.'."\n" + ."\n" + .'- If the call is successful, **200** is returned.'."\n" + .'- If the call fails, an error code is returned. For more information, see **Error codes** below.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'iot.vision.RequestFailed', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The task list returned after a successful call.', 'type' => 'object', 'properties' => [ - 'SuccessList' => [ - 'description' => '', + 'Total' => ['description' => 'The total number of tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'JobList' => [ + 'description' => 'The details of cloud recording download tasks.', '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' => '', - ], + 'Status' => ['description' => 'The generation status of the recording file.'."\n" + ."\n" + .'- **-1**: The recording file failed to be generated.'."\n" + .'- **0**: The recording file has been generated.'."\n" + .'- **1**: The recording file is being generated.', 'type' => 'integer', 'format' => 'int32', 'example' => '-1', 'title' => ''], + 'Type' => ['description' => 'The download type.'."\n" + ."\n" + .'- **1**: Download by file.'."\n" + .'- **2**: Download device cloud recordings by time range.'."\n" + .'- **3**: Download device local recordings by time range.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Progress' => ['description' => 'The progress of recording file generation. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '90', 'title' => ''], + 'RecordType' => ['description' => 'The recording type.'."\n" + ."\n" + .'- **0**: Continuous recording.'."\n" + .'- **1**: Event-triggered recording.'."\n" + .'- **2**: Active recording.'."\n" + .'- **4**: Local-to-cloud recording.'."\n" + .'- **99**: Mixed type.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'BeginTime' => ['description' => 'The start time of the query range. The value is a 10-digit timestamp in seconds. Valid values: 0 to 2147483647.', 'type' => 'integer', 'format' => 'int32', 'example' => '1900000000', 'title' => ''], + 'Url' => ['description' => 'The download URL of the cloud recording. The URL is valid for 1 hour.', 'type' => 'string', 'example' => 'http://*********', 'title' => ''], + 'FileName' => ['description' => 'The file name. This parameter is returned when **Type** is set to 1.', 'type' => 'string', 'example' => 'testfile', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the query range. The value is a 10-digit timestamp in seconds. Valid values: 0 to 2147483647.', 'type' => 'integer', 'format' => 'int32', 'example' => '2100000000', 'title' => ''], + 'StreamType' => ['description' => 'The stream type.'."\n" + ."\n" + .'- **0**: Main stream.'."\n" + .'- **1**: Sub stream.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'JobId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'w2s******', 'title' => ''], + 'JobErrorCode' => ['description' => 'The error code of the task. This parameter is returned when **Status** is **-1**.'."\n" + ."\n" + .'- **9441**: Network error.'."\n" + .'- **9442**: Audio/video data error.', 'type' => 'integer', 'format' => 'int32', 'example' => '9441', 'title' => ''], + 'IotId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ], + 403 => [ + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryRecordDownloadJobList', + 'summary' => 'Queries the list of cloud recording download tasks.', + 'description' => '## Usage notes'."\n" + ."\n" + .'The obtained recording download URL is valid for 1 hour.'."\n" + ."\n" + .'## QPS limit'."\n" + ."\n" + .'A single Alibaba Cloud account can call this operation up to 50 times per second (QPS).'."\n" + ."\n" + .'> All RAM users under a single Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => ' When calling this operation, in addition to the operation-specific request parameters described in this topic, you must also include common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRecordDownloadUrl' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordDownloadJobList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordDownloadJobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRecordDownloadUrl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11111,52 +9558,43 @@ [ 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1623999491_LYPsmZGeEN8GdKzMtYNiBXXXXXXXXX_0/c0064411-2065-400a-a13e-********', - ], + 'schema' => ['description' => 'The name of the recording file. You can call [QueryRecord](~~107922~~) to query the file name.', 'type' => 'string', 'required' => true, 'example' => '1623999491_LYPsmZGeEN8GdKzMtYNiBXXXXXXXXX_0/c0064411-2065-400a-a13e-********', 'title' => ''], ], [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'<props="china">You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console. If the ID value exists, you must specify this parameter. Otherwise, the call fails.</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> If the public instance does not have an ID value, refer to [How to obtain an instance ID](~~267533~~).</props>'."\n" + ."\n" + .'<props="intl">You do not need to specify this parameter.</props>.', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to query the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWR****', - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. IotId is the globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWR****', 'title' => ''], ], ], 'responses' => [ @@ -11164,133 +9602,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'XXX is mandatory for this action', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The query result.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Url' => [ - 'description' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'Status' => ['description' => 'The generation status of the recording file. Valid values:'."\n" + ."\n" + .'- **-1**: The recording file failed to be generated.'."\n" + .'- **0**: The recording file has been generated.'."\n" + .'- **1**: The recording file is being generated.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Url' => ['description' => 'The download URL of the recording file.'."\n" + ."\n" + .'This field is valid only when **Status** is 0 and **Progress** is 100.', 'type' => 'string', 'example' => 'https://link-vision-storage-online.oss-cn-shanghai.aliyuncs.com/transcode%2Fgk-********.mp4?OSSAccessKeyId=LTA*****TTTTTTTT&Expires=16****804&Signature=****', 'title' => ''], + 'Progress' => ['description' => 'The generation progress of the recording file. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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":""}]', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'QueryRecordDownloadUrl', + 'summary' => 'Requests the download URL of a cloud recording file.', + 'description' => '## Operation description'."\n" + .'Generating a cloud recording file takes a long time. Poll this operation to obtain the progress. The download URL is generated only after the progress is complete.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~). For the metric description of each parameter, refer to the preceding parameter descriptions.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateLocalFileUploadJob' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordDownloadUrl'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordDownloadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRecordPlanDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'TimeSlot', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1631019775', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1631019675', - ], - 'ProductKey' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], - 'DeviceName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd7XmBoJhAr88C6PelXDF00****', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 200, - ], - ], - [ - 'name' => 'IotInstanceId', + 'name' => 'PlanId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'The recording plan ID. You can call [QueryRecordPlans](~~107896~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], ], ], 'responses' => [ @@ -11298,159 +9686,140 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidParameter', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The details of the recording plan.', 'type' => 'object', 'properties' => [ - 'JobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1ec1a2****d0435fbc0****34f6f139d', + 'PlanId' => ['description' => 'The recording plan ID.', 'type' => 'string', 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], + 'Name' => ['description' => 'The name of the recording plan template.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TemplateId' => ['description' => 'The time template ID of the recording plan.', 'type' => 'string', 'example' => '693e244a038f4255bb2f5db32874****', 'title' => ''], + 'TemplateInfo' => [ + 'description' => 'The time template information.', + 'type' => 'object', + 'properties' => [ + 'AllDay' => ['description' => 'Indicates whether 24/7 recording is enabled.'."\n" + ."\n" + .'- 1: 24/7 recording is enabled.'."\n" + .'- 0: 24/7 recording is disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Default' => ['description' => 'The template type.'."\n" + .'- **1**: Default template.'."\n" + .'- **0**: Custom template.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the time template.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TemplateId' => ['description' => 'The time template ID.', 'type' => 'string', 'example' => '693e244a038f4255bb2f5db32874****', 'title' => ''], + 'TimeSectionList' => [ + 'description' => 'The time section list of the template.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'End' => ['description' => 'The end time of each day. Valid values: 1 to 86399. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '20000', 'title' => ''], + 'DayOfWeek' => ['description' => 'The day of the week. Valid values: 0 to 6, representing Sunday to Saturday.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Begin' => ['description' => 'The start time of each day. Valid values: 0 to 86399. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '6000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryRecordPlanDetail', + 'summary' => 'Queries the details of a recording plan.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common request parameters when you call this API operation. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteLocalFileUploadJob' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordPlanDetail'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordPlanDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRecordPlanDeviceByDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console. If an ID value exists, you must specify this ID value. Otherwise, the call fails.'."\n" + ."\n" + .'> If no ID value exists for the public instance, see [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1ec1a2****d0435fbc0****34f6f139d', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to query information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - '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' => 'DeleteLocalFileUploadJob', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryLocalFileUploadJob' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], - ], - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'IotInstanceId', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** is the globally unique identifier of a device and corresponds one-to-one with the combination of **ProductKey** and **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'StreamType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1ec1a****5d0435fbc0****34f6f139d', - ], + 'schema' => ['description' => 'The stream type. Valid values:'."\n" + .'- **0**: main stream'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -11458,163 +9827,117 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tenant auth error', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '449ECE75-A36A-4ACE-B253-147C78C440C5', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The recording plan information.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ResultList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SlotEndTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1634746054', - ], - 'ProductKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'g2****Q6ggK', - ], - 'DeviceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gb_hik_IPC', - ], - 'SlotStartTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1634745754', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9201', - ], - 'SlotStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'IotId' => [ - 'description' => '', - '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', - ], - ], + 'PlanId' => ['description' => 'The ID of the recording plan.', 'type' => 'string', 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], + 'Name' => ['description' => 'The name of the recording plan template.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the time template associated with the recording plan.', 'type' => 'string', 'example' => '693e244a038f4255bb2f5db32874****', 'title' => ''], + 'TemplateInfo' => [ + 'description' => 'The time template information.', + 'type' => 'object', + 'properties' => [ + 'AllDay' => ['description' => 'Indicates whether recording is enabled 24/7. Valid values:'."\n" + ."\n" + .'- 1: Yes.'."\n" + .'- 0: No. For detailed configurations, see the TimeSectionList parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Default' => ['description' => 'The templatetype. Valid values:'."\n" + .'- **1**: default template'."\n" + .'- **0**: custom template.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Name' => ['description' => 'The name of the time template.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the time template.', 'type' => 'string', 'example' => '693e244a038f4255bb2f5db32874****', 'title' => ''], + 'TimeSectionList' => [ + 'description' => 'The time template information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'End' => ['description' => 'The end time of each day. Valid values: 1 to 86399. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '20000', 'title' => ''], + 'DayOfWeek' => ['description' => 'The day of the week. Valid values: 0 to 6, which represent Sunday through Saturday.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Begin' => ['description' => 'The start time of each day. Valid values: 0 to 86399. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '6000', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'QueryLocalFileUploadJob', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query recording plan by device', + 'summary' => 'Queries the recording plan of a video device based on the device ID of an IPC.', + 'requestParamsDescription' => 'When you invoke this API operation, you must specify the request parameters described in this topic and the common request parameters. For the metric description of common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryFaceUserBatch' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordPlanDeviceByDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordPlanDeviceByDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'QueryRecordPlanDeviceByPlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'UserIdList', + 'name' => 'PlanId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'example' => '["xqymlby****4whye","6qyyb69zqara****","64nbfx8****hzmy4"]', - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The ID of the recording plan. You can call [QueryRecordPlans](~~107896~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], ], [ - 'name' => 'IsolationId', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ZheJiangHZ', - ], + 'schema' => ['description' => 'The page number to return. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -11622,213 +9945,96 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Params' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"key1":"value1", "key2":"value2"}', - ], - 'CustomUserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1234567890', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1636427314000', - ], - 'UserId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'https://example.com/test.jpeg', - ], - 'FaceMd5' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '200', - ], - 'FaceMd5' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestFaceMd5', - ], - ], - ], - ], - ], + 'description' => 'The query result.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'List' => [ + 'description' => 'The list of returned templates.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StreamType' => ['description' => 'The stream type. Valid values:'."\n" + .'- **0**: main stream'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'IotId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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 \\"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', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query devices associated with a recording plan', + 'summary' => 'Queries the devices associated with a recording plan.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common request parameters when calling this API operation. For more information, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryFaceUserByName' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordPlanDeviceByPlan'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordPlanDeviceByPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRecordPlans' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'IsolationId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ZheJiangHZ', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Tony', - ], - ], - [ - 'name' => 'Params', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"key1":"value1", "key2":"value2"}', - ], + 'schema' => ['description' => 'The page number to start displaying from the returned results. Pages are numbered starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '1000000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries to display per page. Minimum value: 1. Maximum value: 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -11836,236 +10042,135 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned when the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The query result.', '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', - ], + 'PageSize' => ['description' => 'The number of records displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of recording plans queried.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'List' => [ - 'description' => '', + 'description' => 'The list of recording plan templates returned.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Params' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"key1":"value1", "key2":"value2"}', - ], - 'CustomUserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1234567890', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1636427314000', - ], - 'UserId' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => 'https://example.com/test.jpeg', - ], - 'FaceMd5' => [ - 'description' => '', - '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' => '', - 'type' => 'string', - 'example' => '200', - ], - 'FaceMd5' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TestFaceMd5', - ], - ], - ], - ], - ], - ], - ], + 'PlanId' => ['description' => 'The recording plan ID.', 'type' => 'string', 'example' => '6c5a397bc17c4b48ace86f0f0c30****', 'title' => ''], + 'Name' => ['description' => 'The name of the recording plan.', 'type' => 'string', 'example' => 'plan1', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the time template associated with the recording plan.', 'type' => 'string', 'example' => '693e244a038f4255bb2f5db32874****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + '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 \\"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' => 'QueryFaceUserByName', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query the list of recording plans', + 'summary' => 'Queries the list of recording plans.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also include common request parameters when you call this API operation. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteRecord' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordPlans'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordPlans', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRecordUrl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'FileNameList', + 'name' => 'FileName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'example' => 'file1', - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The name of the cloud recording file. You can call [QueryRecord](~~107922~~) to query the file name.', 'type' => 'string', 'required' => true, 'example' => 'file1', 'title' => ''], + ], + [ + 'name' => 'SeekTime', + 'in' => 'query', + 'schema' => ['description' => 'The offset time for recording playback, in seconds. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], ], [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-060a****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'<props="china">You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console. If the ID value exists, you must specify this parameter. Otherwise, the call fails.</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> If the public instance does not have an ID value, see [How to obtain an instance ID](~~267533~~).</props>'."\n" + ."\n" + .'<props="intl">You do not need to specify this parameter.</props>', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y****', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the information on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to query the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd7XmBoJhAr88C6PelXDF00****', - ], + 'schema' => ['description' => 'The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** and **DeviceName**. **IotId** is the globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', 'title' => ''], + ], + [ + 'name' => 'UrlValidDuration', + 'in' => 'query', + 'schema' => ['description' => 'The validity period of the URL, in seconds. Valid values: 10 to 3600.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -12073,57 +10178,53 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'tenant auth error.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DeletedCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - ], - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: The call was successful.'."\n" + .'- Other values: An error code was returned. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The URL of the recording file. The URL contains authentication information and cannot be reused.', 'type' => 'string', 'example' => 'https://linkvisual.aliyun.com/ddsffa****.m3u8', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'DeleteRecord', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query record playback URL', + 'summary' => 'Queries the playback URL of a cloud recording file.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must specify common request parameters when you call the API. For more information about common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRecordUrlByTime' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordUrl'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRecordUrlByTime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12134,93 +10235,62 @@ [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-060a****', - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console. If an ID value exists, you must specify this ID value. Otherwise, the call fails.'."\n" + ."\n" + .'> If no ID value exists for the public instance, refer to [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-060a****', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to view the information of all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd7XmBoJhAr88C6PelXDF00****', - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** serves as the unique identifier of the device and has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify **IotId** together with the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'd7XmBoJhAr88C6PelXDF00****', 'title' => ''], ], [ 'name' => 'StreamType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The stream type. Valid values:'."\n" + ."\n" + .'- **0** (default): main stream'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], ], [ 'name' => 'BeginTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '2147483647', - 'minimum' => '0', - 'example' => '1638675381', - ], + 'schema' => ['description' => 'The start time of the query range. The value is a 10-digit UNIX timestamp, in seconds.'."\n" + ."\n" + .'Minimum value: 0. Maximum value: 2147483647.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1638675381', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '2147483647', - 'minimum' => '0', - 'example' => '1638866820', - ], + 'schema' => ['description' => 'The end time of the query range. The value is a 10-digit UNIX timestamp, in seconds.'."\n" + ."\n" + .'Minimum value: 0. Maximum value: 2147483647.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1638866820', 'title' => ''], ], [ 'name' => 'UrlValidDuration', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '3600', - 'minimum' => '10', - 'example' => '200', - ], + 'schema' => ['description' => 'The validity period of the URL. Valid values: 10 to 3600. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '10', 'example' => '200', 'title' => ''], ], ], 'responses' => [ @@ -12228,50 +10298,55 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The URL of the recording file. The URL contains authentication information and cannot be reused.'."\n" + ."\n" + .'The URL corresponds to all recording files within the specified time range. All recording files are merged for playback.', 'type' => 'string', 'example' => 'https://linkvisual.aliyun.com/ddsffa****.m3u8', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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":""}]', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'QueryRecordUrlByTime', + 'summary' => 'Retrieves the playback URL of recording files within a specified time range.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~). For the metric description of each parameter, see the preceding parameter description.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryCarProcessEvents' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordUrlByTime'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordUrlByTime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRtmpKey' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12280,132 +10355,134 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IotInstanceId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iotx-oxsshare****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'SubIotId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ImP6ECd1aQ****CAfWTO000101', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'SubProductKey', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1Duh0F****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'SubDeviceName', + 'name' => 'IotInstanceId', 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'PullAuthKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PullKeyExpireTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PushKeyExpireTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'StreamName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PushAuthKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'car_test', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.RequestParameterError', 'errorMessage' => 'Request parameter error:%s', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.vision.RtmpKeyNotSet', 'errorMessage' => 'Rtmp key not set.', 'description' => 'No authentication key is specified.'], + ['errorCode' => 'iot.vision.RequestError', 'errorMessage' => 'Request error.', 'description' => 'The request failed.'], + ], + 403 => [ + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRtmpKey'], + ], + ], + 'ramActions' => [ [ - 'name' => 'BeginTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '10000000000000', - 'minimum' => '0', - 'example' => '1646288487368', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRtmpKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"PullAuthKey\\": \\"\\",\\n \\"PullKeyExpireTime\\": 0,\\n \\"PushKeyExpireTime\\": 0,\\n \\"StreamName\\": \\"\\",\\n \\"PushAuthKey\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'QueryStreamPushJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '10000000000000', - 'minimum' => '0', - 'example' => '1646288488368', - ], + 'AK' => [], ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'CurrentPage', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console or call [QueryProductList](~~69271~~) to query the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'PlateNo', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'example' => '23*********', 'title' => ''], ], [ - 'name' => 'ActionType', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '2', - ], + 'schema' => ['description' => 'The ID of the device. This is a unique identifier issued by IoT Platform for the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> **IotId** uniquely identifies a device and corresponds one-to-one with the combination of **ProductKey** and **DeviceName**. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'd7XmBoJhAr88C6PelXDF00****', 'title' => ''], ], [ - 'name' => 'AreaIndex', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => 'The instance ID. You can view the ID of the current instance on the **Overview** tab of the IoT Platform console.', 'type' => 'string', 'required' => true, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], ], 'responses' => [ @@ -12413,185 +10490,94 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: The request was successful.'."\n" + .'- Other codes: An error occurred. For more information about error codes, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request parameter error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The result returned if the call was successful.', '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' => '', - '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' => '', - 'type' => 'string', - 'example' => 'a1Duh0F****', - ], - 'EventId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dailyb3d6658d9****', - ], - 'SubIotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ImP6ECd1aQxio9CAfWTO****', - ], - 'AreaIndex' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'EventType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10005', - ], - 'EventPicId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SU5LT2pXaUM4MV****Nzg', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'daily55617e7653354490938d****', - ], - 'SubDeviceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'car_test', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gl9kLgp0UsPSCcIM8EAY00****', - ], - 'SubDeviceNickName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'PlateNo' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], + 'JobType' => ['description' => 'The type of the stream push job. Valid values:'."\n" + ."\n" + .'- **1**: continuous job.'."\n" + .'- **2**: triggered job that ends after an interruption.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PushUrl' => ['description' => 'The push URL.', 'type' => 'string', 'example' => 'rtmp://****', 'title' => ''], + 'StreamType' => ['description' => 'The stream type. Valid values:'."\n" + ."\n" + .'- **0**: main stream.'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the job was created. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1581595942', 'title' => ''], + 'PushStatus' => ['description' => 'The current push status. Valid values:'."\n" + ."\n" + .'- **1**: pushing.'."\n" + .'- **2**: waiting to push.'."\n" + .'- **3**: push ended.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.lv.requestError', - 'errorMessage' => 'Request error', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.RequestError', 'errorMessage' => 'Request error.', 'description' => 'The request failed.'], + ['errorCode' => 'iot.vision.JobNotExist', 'errorMessage' => 'Job not exist or expired.', 'description' => 'The task does not exist or has expired.'], ], 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.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryStreamPushJob', + 'summary' => 'Queries the details of a video stream push job, including the creation time, current push status, job type, and push URL.', + 'description' => '## QPS limit'."\n" + ."\n" + .'Each Alibaba Cloud account can invoke this operation up to 50 times per second (QPS).'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify common request parameters in addition to the operation-specific request parameters described in this topic. For the metric description of common request parameters, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeletePicture' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStreamPushJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryStreamPushJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryStreamPushJobList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12600,59 +10586,51 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'PictureIdList', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'example' => 'cFc5MzZ****npYT1***TDFzX1hrVzA0Z****', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The number of records to display on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console or call [QueryProductList](~~69271~~) to view the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['description' => 'The name of the device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1CJ0****e7qiq8VkQi1000000', - ], + 'schema' => ['description' => 'The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> **IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'd7XmBoJhAr88C6PelXDF00****', 'title' => ''], ], [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'iot-cn-n6w1y******', - ], + 'schema' => ['description' => 'The instance ID. You can view the ID of the current instance on the **Overview** tab of the IoT Platform console.', 'type' => 'string', 'required' => true, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'JobType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the stream push job.'."\n" + ."\n" + .'- **1** (default): continuous job.'."\n" + .'- **2**: trigger-based job that ends after an interruption.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -12660,74 +10638,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'request forbidden', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other codes: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request parameter error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The result returned if the call is successful.', 'type' => 'object', 'properties' => [ - 'DeletedCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', + 'Total' => ['description' => 'The total number of jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'JobList' => [ + 'description' => 'The job list information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PushUrl' => ['description' => 'The push URL.', 'type' => 'string', 'example' => 'rtmp://****', 'title' => ''], + 'StreamType' => ['description' => 'The stream type.'."\n" + ."\n" + .'- **0**: main stream.'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => '23********', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the job was created, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1581595942', 'title' => ''], + 'PushStatus' => ['description' => 'The current push status.'."\n" + ."\n" + .'- **1**: pushing.'."\n" + .'- **2**: waiting to push.'."\n" + .'- **3**: push ended.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'JobType' => ['description' => 'The type of the stream push job.'."\n" + ."\n" + .'- **1**: continuous job.'."\n" + .'- **2**: trigger-based job that ends after an interruption.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.lv.requestError', - 'errorMessage' => 'Request error', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.RequestError', 'errorMessage' => 'Request error.', 'description' => 'The request failed.'], ], 403 => [ - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryStreamPushJobList', + 'summary' => 'Queries the list and details of video stream push jobs, including the creation time, current push status, job type, and push URL.', + 'description' => '## QPS limit'."\n" + ."\n" + .'Each Alibaba Cloud account can invoke this operation up to 50 times per second (QPS).'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~). For the metric description of each parameter, see the preceding parameter description.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateInstanceInternetProtocol' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStreamPushJobList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryStreamPushJobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryStreamSnapshotJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12736,24 +10749,33 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IotInstanceId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT Platform console, or call [QueryProductList](~~69271~~) to query the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'IpVersion', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'IPv4', - ], + 'schema' => ['description' => 'The name of the device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> **IotId** is the globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'd7XmBoJhAr88C6PelXDF00****', 'title' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can view the ID of the current instance on the **Overview** tab of the IoT Platform console.', 'type' => 'string', 'required' => true, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], ], 'responses' => [ @@ -12761,162 +10783,228 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other codes: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '403', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request forbidden.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The result returned if the call is successful.', 'type' => 'object', + 'properties' => [ + 'JobList' => [ + 'description' => 'The task information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StreamType' => ['description' => 'The stream type.'."\n" + ."\n" + .'- **0**: main stream.'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'SnapshotInterval' => ['description' => 'The snapshot interval.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', 'example' => '', ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'InvalidParameter', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.lv.requestError', - 'errorMessage' => 'Request error', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.RequestError', 'errorMessage' => 'Request error.', 'description' => 'The request failed.'], ], 403 => [ - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - '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', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryStreamSnapshotJob', + 'summary' => 'Queries the list and details of cloud snapshot tasks, including the snapshot interval and stream type.', + 'description' => '## Rate limit'."\n" + ."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account is 50.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the request parameters described in this topic and the common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~). For the metric description of each parameter, see the preceding parameter description.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateRecordDownloadByTimeJob' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStreamSnapshotJob'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryStreamSnapshotJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryTimeTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'iot-******', - ], - ], - [ - 'name' => 'ProductKey', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1Bw******', - ], + 'schema' => ['description' => 'The page number to return. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Device01', - ], + 'schema' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], - [ - 'name' => 'StreamType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The time template information returned if the call was successful.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'List' => [ + 'description' => 'The list of templates returned.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AllDay' => ['description' => 'Indicates whether recording is enabled 24/7. Valid values:'."\n" + ."\n" + .'- 1: yes.'."\n" + .'- 0: no. For detailed configuration, see the TimeSectionList parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Default' => ['description' => 'Indicates whether this is the default template. Valid values:'."\n" + ."\n" + .'- **1**: default template.'."\n" + .'- **0**: custom template.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the time template.', 'type' => 'string', 'example' => 'exampleName', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the time template.', 'type' => 'string', 'example' => 'adxxx', 'title' => ''], + 'TimeSectionList' => [ + 'description' => 'The time template information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'End' => ['description' => 'The end time of each day, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60000', 'title' => ''], + 'DayOfWeek' => ['description' => 'The day of the week. Valid values: 0 to 6, which represent Sunday through Saturday.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Begin' => ['description' => 'The start time of each day, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '20000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'BeginTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '2147483648', - 'minimum' => '0', - 'example' => '1900000000', - ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query the storage lifecycle of device recordings in the cloud', + 'summary' => 'Queries the time template information of a device.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For the metric description of common request parameters, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTimeTemplate'], ], + ], + 'ramActions' => [ [ - 'name' => 'RecordType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryTimeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryTimeTemplateDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'EndTime', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '9999999999999', - 'minimum' => '0', - 'example' => '2100000000', - ], + 'schema' => ['description' => 'The ID of the time template. You can call [QueryTimeTemplate](~~107890~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '36f06322442e4e3f85a5ae8862c9****', 'title' => ''], ], ], 'responses' => [ @@ -12924,81 +11012,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code of the operation.'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'template owner error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The time template information returned if the call was successful.', 'type' => 'object', 'properties' => [ - 'JobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'w2s******', + 'AllDay' => ['description' => 'Indicates whether 24/7 recording is enabled.'."\n" + ."\n" + .'- **1**: Enabled.'."\n" + .'- **0**: Disabled. For detailed configurations, see the **TimeSectionList** parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Default' => ['description' => 'Indicates whether the template is a default template.'."\n" + ."\n" + .'- **1**: Default template.'."\n" + .'- **0**: Custom template.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Name' => ['description' => 'The name of the time template.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the time template.', 'type' => 'string', 'example' => '36f06322442e4e3f85a5ae8862c9****', 'title' => ''], + 'TimeSectionList' => [ + 'description' => 'The time template information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'End' => ['description' => 'The end time of each day, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60000', 'title' => ''], + 'DayOfWeek' => ['description' => 'The day of the week. Valid values: 0 to 6, which represent Sunday through Saturday.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Begin' => ['description' => 'The start time of each day, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '20000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query time template details', + 'summary' => 'Queries the details of a specified time template.', + 'requestParamsDescription' => 'When you invoke this operation, in addition to the operation-specific request parameters described in this topic, you must also specify common request parameters. For the metric description of common request parameters, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTimeTemplateDetail'], ], - 403 => [ - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryTimeTemplateDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'QueryRecordDownloadJobById' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryVisionDeviceInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13007,24 +11101,24 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IotInstanceId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Iot-r******', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'JobId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'w2s******', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -13032,203 +11126,145 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - ], - 'EndTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2100000000', - ], - 'Type' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Progress' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'RecordType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'StreamType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BeginTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1900000000', - ], - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://*********', - ], - 'JobErrorCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9441', - ], - 'FileName' => [ + 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'GbDeviceInfo' => [ + 'type' => 'object', + 'properties' => [ + 'GbId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Password' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'NickName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SubProductKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceProtocol' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'NetProtocol' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => 'testfile', + 'title' => '', + 'example' => '', ], - 'IotId' => [ + 'RtmpDeviceInfo' => [ + 'type' => 'object', + 'properties' => [ + 'StreamStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PushKeyExpireTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'StreamName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PushAuthKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PullAuthKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PullKeyExpireTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PushUrlSample' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.JobNotExist', - 'errorMessage' => 'Job not exist or expired.', - ], + ['errorCode' => 'iot.vision.RequestParameterError', 'errorMessage' => 'Request parameter error:%s', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.vision.RequestError', 'errorMessage' => 'Request error.', 'description' => 'The request failed.'], ], 403 => [ - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', - ], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - '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', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryRecordDownloadJobList' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVisionDeviceInfo'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryVisionDeviceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Description\\": \\"\\",\\n \\"DeviceType\\": 0,\\n \\"GbDeviceInfo\\": {\\n \\"GbId\\": \\"\\",\\n \\"Password\\": \\"\\",\\n \\"NickName\\": \\"\\",\\n \\"SubProductKey\\": \\"\\",\\n \\"DeviceProtocol\\": 0,\\n \\"NetProtocol\\": 0\\n },\\n \\"RtmpDeviceInfo\\": {\\n \\"StreamStatus\\": 0,\\n \\"PushKeyExpireTime\\": 0,\\n \\"StreamName\\": \\"\\",\\n \\"PushAuthKey\\": \\"\\",\\n \\"PullAuthKey\\": \\"\\",\\n \\"PullKeyExpireTime\\": 0,\\n \\"PushUrlSample\\": \\"\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'QueryVoiceIntercom' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'IotInstanceId', + 'name' => 'Scheme', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'iot-2w******', - ], + 'schema' => ['description' => 'The connection protocol type for voice intercom. Valid values:'."\n" + ."\n" + .'- **ws**: WebSocket connection protocol. Call this operation to obtain the web voice call address when implementing voice intercom on the web. <props="china"><ph>For more information about implementing voice intercom between the web and the device, see [Web voice intercom integration](~~2545966~~).</ph></props>'."\n" + .'- **rtmp** (default): Call this operation to obtain the corresponding voice call address when implementing voice intercom on Android and iOS application players. For more information about implementing voice intercom between Android and iOS applications and the device, see [Android voice intercom](~~260925~~) and [iOS voice intercom](~~253953~~).', 'type' => 'string', 'required' => false, 'default' => 'rtmp', 'example' => 'rtmp', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Overview** page in the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value exists, you must specify this **ID** value. Otherwise, the call fails.'."\n" + .'- If the **Overview** page or **ID** value is not available, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y*****', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1Bw******', - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the IPC device belongs.'."\n" + .'You can view the information of all products under the current account on the **Products** page in the IoT Platform console or by calling the [QueryProductList](~~69271~~) operation.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Device01', - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], - ], - [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call the [QueryDeviceDetail](~~69594~~) operation to query the device ID.'."\n" + ."\n" + .'><notice> **IotId** is the unique identifier of a device and has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], ], 'responses' => [ @@ -13236,151 +11272,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The voice intercom address information.', 'type' => 'object', 'properties' => [ - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'JobList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '-1', - ], - 'Type' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Progress' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'RecordType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'BeginTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1900000000', - ], - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://*********', - ], - 'FileName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testfile', - ], - 'EndTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2100000000', - ], - 'StreamType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'JobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'w2s******', - ], - 'JobErrorCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9441', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], - ], + 'Url' => ['description' => 'The voice intercom address.', 'type' => 'string', 'example' => 'rtmp://***.***.***.***:8000/talk?token=********', 'title' => ''], + 'CryptoKey' => [ + 'description' => 'The decryption parameters.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The decryption key.', 'type' => 'string', 'example' => 'bPvz6tnfonP1E+********v2Q==', 'title' => ''], + 'Iv' => ['description' => 'The decryption initialization vector.', 'type' => 'string', 'example' => 'MDEyMzQ1Njc4********0+Pw==', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Request voice intercom address', + 'summary' => 'Retrieves the voice intercom address of an IPC device.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For more information about common request parameters, see the [Common parameters](~~141505~~) metric description.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVoiceIntercom'], ], - 403 => [ - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryVoiceIntercom', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'CreateLocalRecordDownloadByTimeJob' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RefreshGbSubDeviceList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13389,82 +11345,24 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'iot-******', - ], - ], - [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1Bw******', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Device01', - ], - ], - [ - 'name' => 'Speed', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '1.0', - 'default' => '1.0', - ], - ], - [ - 'name' => 'BeginTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '2147483648', - 'minimum' => '0', - 'example' => '1900000000', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '9999999999999', - 'minimum' => '0', - 'example' => '2100000000', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -13472,85 +11370,56 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'w2s******', - ], - ], - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'iot.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'The RAM user does not have permissions to access the resource.'], + ['errorCode' => 'iot.vision.GbServiceNotEnabled', 'errorMessage' => 'The GB28181 service has not been enabled.', 'description' => 'The standard service is not started.'], + ['errorCode' => 'iot.vision.GbIdDuplicate', 'errorMessage' => 'The GB28181 deviceId is duplicated.', 'description' => 'The standard ID already exists.'], + ['errorCode' => 'iot.vision.RefreshTooFrequently', 'errorMessage' => 'Refresh too frequently.', 'description' => 'Refresh requests are submitted too frequently.'], + ['errorCode' => 'iot.vision.DeviceOffline', 'errorMessage' => 'Device is offline.', 'description' => 'The device is offline.'], ], 403 => [ - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', - ], + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], ], ], - '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', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BatchQueryVisionDeviceInfo' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshGbSubDeviceList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:RefreshGbSubDeviceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + ], + 'RemoveFaceDeviceFromDeviceGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13559,46 +11428,29 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProductKey', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], ], [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'TestIotInstanceId', 'title' => ''], ], [ - 'name' => 'DeviceNameList', + 'name' => 'ProductKey', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => false, - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The ProductKey of the product on IoT Platform.', 'type' => 'string', 'required' => true, 'example' => 'TestProductKey', 'title' => ''], ], [ - 'name' => 'IotIdList', + 'name' => 'DeviceName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => false, - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The device name.', 'type' => 'string', 'required' => true, 'example' => 'TestDeviceName', 'title' => ''], + ], + [ + 'name' => 'DeviceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The device group ID.', 'type' => 'string', 'required' => true, 'example' => 'TestDeviceGroupId', 'title' => ''], ], ], 'responses' => [ @@ -13606,133 +11458,47 @@ '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', - ], - ], - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Remove a device from a device group', + 'summary' => 'Removes a device from a device group.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveFaceDeviceFromDeviceGroup'], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:RemoveFaceDeviceFromDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], ], - 'CreateRtmpDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RemoveFaceUserFromUserGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13741,80 +11507,113 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'PullKeyExpireTime', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'default' => '3600', - ], + 'schema' => ['description' => 'The isolation ID.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolationId', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'TestUserId', 'title' => ''], ], [ - 'name' => 'ProductKey', + 'name' => 'UserGroupId', 'in' => 'query', + 'schema' => ['description' => 'The user group ID.', 'type' => 'string', 'required' => true, 'example' => 'TestUserGroupId', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', - 'required' => true, + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Remove a user from a user group', + 'summary' => 'Removes a user from a user group.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveFaceUserFromUserGroup'], + ], + ], + 'ramActions' => [ [ - 'name' => 'DeviceName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:RemoveFaceUserFromUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'SetDevicePictureLifeCycle' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Instance Overview** page in the IoT Platform console. If an ID value exists, you must pass in this ID value. Otherwise, the call will fail.'."\n" + ."\n" + .'> If the public instance does not have an ID value, see [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ - 'name' => 'PushKeyExpireTime', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'default' => '3600', - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + ."\n" + .'You can view the information of all products under the current account on the **Products** page of the IoT Platform console, or call [QueryProductList](~~69271~~) to query the information.'."\n" + ."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'PushAuthKey', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'PullAuthKey', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** and **DeviceName**. As the unique identifier of the device, **IotId** has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHR****c300', 'title' => ''], ], [ - 'name' => 'SubStreamName', + 'name' => 'Day', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The storage duration of pictures in the cloud, in days.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '7', 'title' => ''], ], ], 'responses' => [ @@ -13822,116 +11621,104 @@ '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', - ], - ], - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '449ECE75-A36A-4ACE-B253-147C78C440C5', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"449ECE75-A36A-4ACE-B253-147C78C440C5\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Set the lifecycle of device cloud storage pictures', + 'summary' => 'Sets the lifecycle of cloud storage pictures for an IPC device.', + 'description' => '> Before the lifecycle of cloud storage pictures is set, pictures are stored permanently in the cloud by default.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common request parameters when you call this API operation. For more information about common request parameters, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDevicePictureLifeCycle'], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:SetDevicePictureLifeCycle', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], ], - 'DeleteRtmpDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SetDeviceRecordLifeCycle' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. You can view the ID of the current instance on the **Overview** page in the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value is available, you must specify this parameter. Otherwise, the call fails.'."\n" + .'- If no<props="intl"><ph> **Overview** page or</ph></props> ID value is available, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information, see [Overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], + ], + [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console or call [QueryProductList](~~69271~~) to view the information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. IotId is the globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'd7XmBoJhAr88C6PelXDF00****', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'Day', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The recording lifecycle, which specifies the number of days that recording files are retained in the cloud.'."\n" + ."\n" + .'> You must set the recording lifecycle to a value greater than 0 to use other recording features provided by LinkVisual. The maximum recording lifecycle is 3650 days.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '7', 'title' => ''], ], ], 'responses' => [ @@ -13939,105 +11726,102 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"InvalidParameter\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Set the cloud storage lifecycle for device recordings', + 'summary' => 'Sets the recording lifecycle of an IPC device, which specifies the number of days that recording files are stored in the cloud.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~). For the metric description of each parameter, see the preceding parameter description.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDeviceRecordLifeCycle'], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:SetDeviceRecordLifeCycle', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], ], - 'DeleteRtmpKey' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopLiveStreaming' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Type', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '1', - 'minimum' => '0', - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the unique identifier issued by the IoT platform for the device. You can call the [QueryDeviceDetail](~~69594~~) operation of the IoT platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** is the globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page of the IoT platform console or call the [QueryProductList](~~69271~~) operation to query information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The device name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'StreamType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The stream type. Valid values:'."\n" + .'- **0** (default): main stream.'."\n" + .'- **1**: sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], ], [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Overview** page of the IoT platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value exists, you must specify this parameter. Otherwise, the call fails.'."\n" + .'- If the <props="intl"><ph>**Overview** page or the </ph></props>ID value does not exist, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Overview](~~356505~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], ], 'responses' => [ @@ -14045,90 +11829,103 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParameterError', - 'errorMessage' => 'Request parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'StopLiveStreaming', + 'summary' => 'Stops an IPC device from pushing streams.', + 'description' => '## Operation description'."\n" + ."\n" + .'- Before you invoke this operation, you must implement the Thing Specification Language (TSL) service identified by **StopPushStreaming** on the IPC device. If this service is not implemented on the IPC device, or the IPC device does not return a normal response after receiving the service invocation, the IPC device does not stop pushing streams. For more information about TSL, see [What is a TSL model?](~~73727~~).'."\n" + .'- When no one is watching the IPC device, you do not need to invoke this operation. The IoT platform automatically triggers the device to stop pushing streams.'."\n" + .'- If you invoke this operation during a recording event procedure, the recording file may be interrupted. Use this operation with caution.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopLiveStreaming'], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:StopLiveStreaming', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], ], - 'QueryRtmpKey' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopTriggeredRecord' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ + 'name' => 'IotInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'You can view the **ID** of the current instance on the **Instance Overview** page in the IoT Platform console. If an ID value exists, you must specify this ID value. Otherwise, the call fails.'."\n" + ."\n" + .'> If no ID value exists for the public instance, see [How to obtain an instance ID](~~267533~~).', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], + ], + [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console, or call [QueryProductList](~~69271~~) to query information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The device name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'RecordId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The recording ID. You can call [TriggerRecord](~~107915~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => 'fc82774fa749485bad7d719f9670****', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** serves as the unique identifier of the device and has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify **IotId** together with the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.'."\n" + ."\n" + .'You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the ID.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], ], 'responses' => [ @@ -14136,82 +11933,52 @@ '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', - ], - ], - ], - ], + 'Code' => ['description' => 'The response code of the operation.'."\n" + ."\n" + .'- **200**: The call was successful.'."\n" + .'- Other codes: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Stop actively triggered recording', + 'summary' => 'Stops an IPC device from actively triggering recording.', + 'requestParamsDescription' => 'When you invoke this operation, you must also specify common request parameters in addition to the operation-specific request parameters described in this topic. For the metric description of common request parameters, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopTriggeredRecord'], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:StopTriggeredRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], ], - 'QueryVisionDeviceInfo' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'TransferDeviceInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14220,36 +11987,40 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProductKey', + 'name' => 'DeviceNameList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', - 'required' => false, + 'description' => 'The list of device names to be migrated. A maximum of 100 device names can be specified.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => true, + 'example' => 'RepeatList', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'DeviceName', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ProductKey of the product to which the device belongs. This is the unique identifier generated by IoT Platform when the product is created.', 'type' => 'string', 'required' => true, 'example' => 'a1BwAGV****', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'SourceInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the source instance to which the device belongs.'."\n" + ."\n" + .'- Public instance ID: iotx-oxssharez200.'."\n" + .' > Currently, only the China (Shanghai) region is supported, and Enterprise instance ID is iotx-oxssharez200.'."\n" + ."\n" + .'- Enterprise Edition instance ID: Log on to the IoT Platform console. On the **Instance Overview** page, click Enterprise instance name. On the **Instance Details** page, view the **Instance ID** in the **Basic Information** section.', 'type' => 'string', 'required' => false, 'example' => 'iotx-oxssharez200', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'TargetInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The ID of the target instance to which the device is migrated. Only Enterprise instances are supported as the target instance.'."\n" + ."\n" + .'You can log on to the IoT Platform console. On the **Instance Overview** page, click the instance name. On the **Instance Details** page, view the **Instance ID** in the **Basic Information** section.', 'type' => 'string', 'required' => true, 'example' => 'iot-060***', 'title' => ''], ], ], 'responses' => [ @@ -14257,122 +12028,105 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '27AF2E38-12ED-4F67-BD20-36E812CD7A42', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => '来源实例和目标实例不能相同', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ + 'description' => 'The query result.', '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', + 'SuccessList' => [ + 'description' => 'The list of devices that were successfully migrated.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceName' => ['description' => 'The device name.', 'type' => 'string', 'example' => 'e598798j****', 'title' => ''], + 'Message' => ['description' => 'The description of the successful migration.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - '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', + 'FailedList' => [ + 'description' => 'The list of devices that failed to be migrated.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceName' => ['description' => 'The device name.', 'type' => 'string', 'example' => 'e5jdfalekj****', 'title' => ''], + 'Message' => ['description' => 'The description of the migration failure.', 'type' => 'string', 'example' => '设备已经转移或不属于来源实例', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'TransferDeviceInstance', + 'summary' => 'Migrates a device to a different instance.', + 'description' => 'Before you invoke this operation to migrate a device to a different instance, contact the helpdesk to evaluate the migration plan and prevent feature unavailability after migration.'."\n" + ."\n" + .'**Before you begin**.'."\n" + ."\n" + .'- The devices to be migrated have the video service feature enabled.'."\n" + .' - For devices in the Enterprise instance: Log on to the IoT Platform console and click **Enterprise instance**. In the left-side navigation pane, choose **Video Service** > **Access Service**. On the **Access Service** page, click the **Product Management** tab. Verify that the product containing the devices to be migrated has the **Enabled/Not Enabled** column set to **Enabled**.'."\n" + .' - For devices in Enterprise Edition instances: The video service is enabled.'."\n" + .'- The device distribution task is complete. For more information, see [CreateDeviceDistributeJob](~~199390~~) or [Device distribution](~~143450~~).'."\n" + .'- Make sure that the camera device has a picture lifecycle configured. If the camera device does not have a picture lifecycle configured, calling this operation automatically sets the picture lifecycle to 180 days. For more information, see [SetDevicePictureLifeCycle](~~107880~~).'."\n" + ."\n" + .'**Background information**'."\n" + .'- If the source instance and the target instance type are different, understand the billable methods of the instances before migration. For more information about billable methods, see [Billing overview](~~124250~~).'."\n" + .'- During the migration procedure, devices go offline. The more devices there are, the longer the migration takes. Data generated by devices during this period cannot be retained.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when calling this operation. For more information, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransferDeviceInstance'], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:TransferDeviceInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], ], - 'UpdateRtmpKey' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'TriggerCapturePicture' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14381,70 +12135,40 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'PullKeyExpireTime', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - ], - [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view the ProductKey on the **Products** page in the IoT Platform console or call [QueryProductList](~~69271~~) to view information about all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ '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, - ], + 'schema' => ['description' => 'The device name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page in the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the device ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. **IotId** is the globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa9hsPyD00****', 'title' => ''], ], [ - 'name' => 'PullAuthKey', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'<props="china">You can view the **ID** of the current instance on the **Instance Overview** page in the IoT Platform console. If an ID value exists, you must specify this parameter. Otherwise, the call fails.</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> If the public instance does not have an ID value, see [How to obtain an instance ID](~~267533~~).</props>'."\n" + ."\n" + .'<props="intl">You do not need to specify this parameter.</props>.', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], ], 'responses' => [ @@ -14452,52 +12176,55 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The image ID generated for the image after the IPC device captures it.'."\n" + ."\n" + .'>The image ID takes effect after the IPC device successfully uploads the image.', 'type' => 'string', 'example' => 'eventPicId_12****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'request forbidden', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParameterError', - 'errorMessage' => 'Request parameter error:%s', - ], - ], - 403 => [ - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"eventPicId_12****\\",\\n \\"ErrorMessage\\": \\"request forbidden\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Trigger image capture', + 'summary' => 'Triggers an IPC device to capture an image and upload it to the cloud.', + 'requestParamsDescription' => 'When you invoke this operation, you must also specify common request parameters in addition to the operation-specific request parameters described in this topic. For the metric description of common request parameters, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerCapturePicture'], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:TriggerCapturePicture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], ], - 'CreateGbDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'TriggerRecord' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14506,78 +12233,61 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The ProductKey of the product to which the IPC device belongs.'."\n" + .'You can view it on the **Products** page of the IoT Platform console, or call [QueryProductList](~~69271~~) to view the information of all products under the current account.'."\n" + .'><notice> If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'a1BwAGV****', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'GbId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The device name of the IPC device.'."\n" + .'You can view the **DeviceName** on the **Devices** page of the IoT Platform console.'."\n" + .'><notice> If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'camera1', 'title' => ''], ], [ - 'name' => 'Password', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can call [QueryDeviceDetail](~~69594~~) of IoT Platform to query the ID.'."\n" + ."\n" + .'><notice> If you specify this parameter, you do not need to specify **ProductKey** and **DeviceName**. **IotId** serves as the unique identifier of the device and has a one-to-one mapping with the combination of **ProductKey** and **DeviceName**. If you specify both **IotId** and the combination of **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>', 'type' => 'string', 'required' => false, 'example' => 'zLZyi6aOLyOSHa****yD000100', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'StreamType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The stream type:'."\n" + .'- **0** (default): Main stream.'."\n" + .'- **1**: Sub stream.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '0', 'title' => ''], ], [ - 'name' => 'DeviceType', + 'name' => 'PreRecordDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'default' => '1', - ], + 'schema' => ['description' => 'The pre-recording duration. Valid values: 0 to 10. Unit: seconds.'."\n" + ."\n" + .'>The pre-recording duration is generated only when the device supports the pre-recording feature. Otherwise, the pre-recording duration is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], ], [ - 'name' => 'SubProductKey', + 'name' => 'RecordDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The recording duration, including the pre-recording duration. Valid values: 10 to 7200. Unit: seconds.'."\n" + ."\n" + .'> The maximum length of a single recording file is 30 minutes. When the recording duration exceeds 30 minutes, the recording is automatically split into multiple recording files.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '60', 'title' => ''], ], [ - 'name' => 'MediaNetProtocol', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'<props="china">You can view the **ID** of the current instance on the **Instance Overview** page of the IoT Platform console. If an ID value exists, you must specify this ID value. Otherwise, the call will fail.</props>'."\n" + ."\n" + .'<props="china">'."\n" + .'> If the public instance does not have an ID value, see [How to obtain an instance ID](~~267533~~).</props>'."\n" + ."\n" + .'<props="intl">You do not need to specify this parameter.</props>', 'type' => 'string', 'required' => false, 'example' => 'iot-cn-n6w1y5****0t', 'title' => ''], ], ], 'responses' => [ @@ -14585,69 +12295,53 @@ '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', - ], - ], - ], - ], + 'Code' => ['description' => 'The response code:'."\n" + ."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the recording file generated after the recording obtained by the IPC device is uploaded.', 'type' => 'string', 'example' => 'fc82774fa749485bad7d719f9670****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for this request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"fc82774fa749485bad7d719f9670****\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'TriggerRecord', + 'summary' => 'Calls this operation to immediately trigger a specified IPC device to start recording and upload the recording file to the cloud.', + 'requestParamsDescription' => 'When you call this API operation, in addition to the request parameters described in this topic, you must also include common request parameters. For more information about common request parameters, see [Common parameters](~~141505~~).'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerRecord'], ], - 403 => [ - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', - ], - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:TriggerRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], ], - 'DeleteGbDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UnbindPictureSearchAppWithDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14656,35 +12350,34 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'DeviceName', + 'name' => 'AppInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Instance ID of the image search application instance. You can call [QueryPictureSearchApps](~~206608~~) to query instance ID.', 'type' => 'string', 'required' => true, 'example' => '5a502d3fbab8410e8fd4be9037c7****', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The instance ID.'."\n" + ."\n" + .'- Enterprise Enterprise instance: This parameter is required. You can view the ID of your Enterprise Enterprise instance on the **Instance Overview** page in the IoT Platform console.'."\n" + .'- Public instance: You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'iot-060a****', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'DeviceIotIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The list of device IotIds. You can specify the IotId of a V series edge server or a camera.'."\n" + ."\n" + .'The IotId is the unique identifier issued by IoT Platform for the device. You can call the [QueryDeviceDetail](~~69594~~) operation of IoT Platform to query the IotId.'."\n" + ."\n" + .'You can specify up to 20 device IotIds in a single request.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, + 'example' => 'VrJwPGjC1sJlqPjZA3cxg4****', + 'maxItems' => 20, + 'title' => '', ], ], ], @@ -14693,96 +12386,98 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'iotIdList is error', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E779C673-E8E8-41F0-883E-7D9275DF733C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'iot.common.RamActionPermissionDeny', - 'errorMessage' => 'You do not have the RAM permission.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"iotIdList is error\\",\\n \\"RequestId\\": \\"E779C673-E8E8-41F0-883E-7D9275DF733C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Unbind devices from an image search application', + 'summary' => 'Unbinds devices from an image search application instance in batches.', + 'description' => '## Limits'."\n" + .'If you invoke this operation on an Enterprise instance, you must specify the **IotInstanceId** request parameter. Otherwise, the invocation failed.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For the metric description of common request parameters, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindPictureSearchAppWithDevices'], ], - 403 => [ - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UnbindPictureSearchAppWithDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], ], - 'EnableGbSubDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateEventRecordPlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'SubDeviceId', + 'name' => 'PlanId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The ID of the intelligent alert event recording plan. You can call [QueryEventRecordPlans](~~107907~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '5b60bf0dd55944c19d7817442bc9****', 'title' => ''], ], [ - 'name' => 'ProductKey', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the intelligent alert event recording.'."\n" + ."\n" + .'The name must be fewer than 48 characters in length and can contain letters, digits, and the following special characters: hyphens (-), underscores (_), at signs (@), periods (.), and colons (:).', 'type' => 'string', 'required' => true, 'example' => 'record1', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'EventTypes', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The intelligent alert event types.'."\n" + ."\n" + .'- To specify all intelligent alert event types, set this parameter to 0.'."\n" + .'- To specify multiple intelligent alert event types, enter the serial numbers of the event types and separate them with commas (,). Example: `10001,10002`.'."\n" + .'>You can specify up to 10 intelligent alert event types at a time.'."\n" + ."\n" + .'To view all intelligent alert event types, go to the **Feature Definition** tab on the **Product Details** page in the IoT Platform console. For more information, see [View intelligent alert event types](~~207701~~).', 'type' => 'string', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'PreRecordDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The pre-recording duration. Valid values: 0 to 10. Unit: seconds.'."\n" + ."\n" + .'>The pre-recording duration is generated only when the device supports the pre-recording feature. Otherwise, the pre-recording duration is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '0', 'example' => '10', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'RecordDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The recording duration, including the pre-recording duration. Valid values: 10 to 60. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the time template. You can call [QueryTimeTemplate](~~107890~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '36f06322442e4e3f85a5ae8862c9****', 'title' => ''], ], ], 'responses' => [ @@ -14790,131 +12485,89 @@ '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', - ], - ], - ], - ], + 'Code' => ['description' => 'The response code. Valid values:'."\n" + ."\n" + .'- **200**: The request was successful.'."\n" + .'- Other values: An error occurred. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Update event-triggered recording plan', + 'summary' => 'Updates an event-triggered recording plan for intelligent alerts.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEventRecordPlan'], ], - 403 => [ - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', - ], - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateEventRecordPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], ], - 'QueryGbSubDeviceList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateFaceUser' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'default' => '10', - ], + 'schema' => ['description' => 'The isolation ID.'."\n" + .'<br>Used for data isolation between different applications under a tenant. For example, if a user has business operations in multiple regions, you can create separate isolation IDs for each region.', 'type' => 'string', 'required' => true, 'example' => 'TestIsolati****', 'title' => ''], ], [ - 'name' => 'ProductKey', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => 'tibce3fsgqel****', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'example' => 'ZhangSan', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'Params', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The user information.', 'type' => 'string', 'required' => false, 'example' => '{"age":28, "sex":"male"}', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'FacePicUrl', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The URL for downloading the image. Currently, images in JPG and JPEG formats are supported.', 'type' => 'string', 'required' => false, 'example' => 'https://test.com/test.jpg', 'title' => ''], ], [ - 'name' => 'PageStart', + 'name' => 'CustomUserId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '512', - 'minimum' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The unique ID of the user in the caller\'s business system, such as an ID card number or student ID.', 'type' => 'string', 'required' => false, 'example' => '52242819650301xxxx', 'title' => ''], ], ], 'responses' => [ @@ -14922,129 +12575,68 @@ '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', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Update user information', + 'summary' => 'Updates user information.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFaceUser'], ], - 403 => [ - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', - ], - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateFaceUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], ], - 'RefreshGbSubDeviceList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateFaceUserGroupAndDeviceGroupRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ProductKey', + 'name' => 'IsolationId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The business isolation ID, which is used to isolate data between different business applications within the same Alibaba Cloud account. Set this parameter to the same value as the **IsolationId** that you specified when you called the [AddFaceUserGroupAndDeviceGroupRelation](~~288342~~) operation to add the face synchronization relationship between the user group and the device group.', 'type' => 'string', 'required' => true, 'example' => 'ZheJiangHZ', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'ControlId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The control ID of the synchronization relationship between the user group and the device group. Set this parameter to the **ControlId** value that you obtained and saved locally when you called the [AddFaceUserGroupAndDeviceGroupRelation](~~288342~~) operation to add the face synchronization relationship between the user group and the device group.', 'type' => 'string', 'required' => true, 'example' => 'qcb2yea4ha4d****', 'title' => ''], ], [ - 'name' => 'IotId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'IotInstanceId', + 'name' => 'Relation', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The face synchronization relationship. Currently, only **SYNC_INFO_PICTURE** is supported, which indicates that user photos and user information are synchronized.', 'type' => 'string', 'required' => true, 'example' => 'SYNC_INFO_PICTURE', 'title' => ''], ], ], 'responses' => [ @@ -15052,66 +12644,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'Code' => ['description' => 'The response code.'."\n" + .'- **200**: Success.'."\n" + .'- Other values: Error codes. For more information, see [Error codes](~~288314~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '0A13279A-5640-45E7-87AA-83750541AD0E', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'access control not exist', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned if the call is successful.', + 'type' => 'object', + 'properties' => [ + 'ControlId' => ['description' => 'The control ID of the synchronization relationship between the user group and the device group.', 'type' => 'string', 'example' => 'qcb2yea4ha4d****', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the face synchronization relationship between the user group and the device group was last updated.', 'type' => 'string', 'example' => '2020-04-25 19:29:30', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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.', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Update face synchronization relationship between device group and user group', + 'summary' => 'Updates the face synchronization relationship between a user group and a device group.', + 'description' => '## Before you begin'."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account for this operation is 100.'."\n" + .' > Resource Access Management (RAM) users share the quota of the Alibaba Cloud account.', + 'requestParamsDescription' => ' When you call this operation, you must include common request parameters in addition to the operation-specific request parameters described in this topic. For more information about common parameters, see [Common parameters](~~288312~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFaceUserGroupAndDeviceGroupRelation'], ], - 403 => [ - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', - ], - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateFaceUserGroupAndDeviceGroupRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], ], 'UpdateGbDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15122,58 +12712,37 @@ [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'GbId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -15181,54 +12750,53 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.common.RamActionPermissionDeny', - 'errorMessage' => 'You do not have the RAM permission.', - ], - [ - 'errorCode' => 'iot.vision.GbIdDuplicate', - 'errorMessage' => 'The GB28181 deviceId is duplicated.', - ], + ['errorCode' => 'iot.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'The RAM user does not have permissions to access the resource.'], + ['errorCode' => 'iot.vision.GbIdDuplicate', 'errorMessage' => 'The GB28181 deviceId is duplicated.', 'description' => 'The standard ID already exists.'], ], 403 => [ - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', - ], + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], ], ], - ], - 'CreateStreamPushJob' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGbDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateGbDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + ], + 'UpdateInstanceInternetProtocol' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15237,78 +12805,113 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProductKey', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['description' => 'The instance ID. You can view the **ID** of the current instance on the **Instance Overview** page in the IoT Platform console.'."\n" + ."\n" + .'><notice>'."\n" + .'- If an ID value is available, you must specify this ID. Otherwise, the call fails.'."\n" + .'- If no <props="intl"><ph>**Instance Overview** page or </ph></props>ID value is available, you do not need to specify this parameter.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'For more information about instances, see [Overview](~~356505~~).', 'type' => 'string', 'required' => true, 'example' => 'iot-cn-n6w1y59****', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'IpVersion', 'in' => 'query', + 'schema' => ['description' => 'The IP protocol version. Valid values:'."\n" + .'- IPv4 (default)'."\n" + .'- IPv6'."\n" + ."\n" + .'> If the IP protocol version is set to IPv6, streaming media-related addresses are changed to IPv4/IPv6 dual-stack addresses. Make sure that your devices and applications have completed IPv6-related configurations. Otherwise, exceptions such as playback loading failures may occur.', 'type' => 'string', 'required' => true, 'example' => 'IPv4', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The response result.', 'type' => 'object', 'example' => '无', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'InvalidParameter', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.lv.requestError', 'errorMessage' => 'Request error', 'description' => 'Request error'], + ], + 403 => [ + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'UpdateInstanceInternetProtocol', + 'summary' => 'Sets the IP protocol version supported by an instance.', + 'requestParamsDescription' => 'When you invoke this operation, you must specify the operation-specific request parameters described in this topic and the common request parameters. For the metric description of common request parameters, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceInternetProtocol'], + ], + ], + 'ramActions' => [ [ - 'name' => 'IotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd7XmBoJhAr88C6PelXDF00****', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateInstanceInternetProtocol', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdatePictureSearchApp' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'iot-cn-n6w1y59****', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'StreamType', + 'name' => 'AppInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'Instance ID of the image search application instance. You can call [QueryPictureSearchApps](206608) to query instance ID.', 'type' => 'string', 'required' => true, 'example' => '3e429560124b44b685095df81a27****', 'title' => ''], ], [ - 'name' => 'PushUrl', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rtmp://****', - ], + 'schema' => ['description' => 'The name of the image search application instance. '."\n" + ."\n" + .'The name can contain Chinese characters, letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters in length (each Chinese character counts as 2 characters).', 'type' => 'string', 'required' => true, 'example' => '新以图搜图', 'title' => ''], ], [ - 'name' => 'JobType', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The description of the image search application instance.'."\n" + ."\n" + .'The description can contain Chinese characters, letters, digits, underscores (_), and hyphens (-), and cannot exceed 1024 characters in length (each Chinese character counts as 2 characters).', 'type' => 'string', 'required' => true, 'example' => '以图搜图Demo2', 'title' => ''], ], ], 'responses' => [ @@ -15316,99 +12919,127 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '23***********', - ], - ], - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Description is mandatory for this action.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'CC6B9D69-627C-4C9D-AEAA-0BC08AB6DBED', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'Forbidden.RiskControl', 'errorMessage' => 'Your account is at risk. Contact customer support for more details.', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Description is mandatory for this action.\\",\\n \\"RequestId\\": \\"CC6B9D69-627C-4C9D-AEAA-0BC08AB6DBED\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Update image search application', + 'summary' => 'Modifies the information of an image search application instance.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation. For more information, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePictureSearchApp'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:UpdatePictureSearchApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + ], + 'UpdateRecordPlan' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'PlanId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the recording plan. You can call [QueryRecordPlans](~~107896~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '6c5a397bc17c4b48ace86f0f0c30****', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the recording plan.'."\n" + ."\n" + .'The name must be fewer than 48 characters in length and can contain letters, digits, and the following special characters: hyphens (-), underscores (_), at signs (@), periods (.), and colons (:).', 'type' => 'string', 'required' => true, 'example' => 'test1', 'title' => ''], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the time template to associate with the recording plan. You can call [QueryTimeTemplate](~~107890~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => '36f06322442e4e3f85a5ae8862c9****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error.\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Update a recording plan', + 'summary' => 'Updates a recording plan.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when calling this operation. For more information, see [Common parameters](~~141505~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateStreamSnapshotJob' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRecordPlan'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateRecordPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateRtmpKey' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15417,69 +13048,44 @@ 'systemTags' => [], 'parameters' => [ [ + 'name' => 'PullKeyExpireTime', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'IotId', + 'name' => 'IotInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd7XmBoJhAr88C6PelXDF00****', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'PushKeyExpireTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'StreamType', + 'name' => 'PushAuthKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'SnapshotInterval', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '1800', - 'minimum' => '60', - 'example' => '600', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PullAuthKey', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -15487,136 +13093,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'iot.vision.RequestParameterError', 'errorMessage' => 'Request parameter error:%s', 'description' => 'The request parameter is invalid.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => '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', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteStreamPushJob' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRtmpKey'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateRtmpKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + ], + 'UpdateTimeTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', - ], - ], - [ - 'name' => 'DeviceName', + 'name' => 'TimeSections', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'List of time sections.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DayOfWeek' => ['description' => 'The day of the week. Valid values: 0 to 6, representing Sunday to Saturday.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Begin' => ['description' => 'The start time of each day. Valid values: 0 to 86399. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20000', 'title' => ''], + 'End' => ['description' => 'The end time of each day. Valid values: 1 to 86399. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60000', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'camera1', + 'maxItems' => 1000, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'JobId', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '23******', - ], + 'schema' => ['description' => 'The ID of the time template. You can call [QueryTimeTemplate](~~107890~~) to query the ID.', 'type' => 'string', 'required' => true, 'example' => 'fc82774fa749485bad7d719f9670****', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd7XmBoJhAr88C6PelXDF00****', - ], + 'schema' => ['description' => 'The name of the time template.'."\n" + ."\n" + .'The name must be less than 48 characters in length, and can contain letters, digits, and special characters: hyphens (-), underscores (_), at signs (@), periods (.), and colons (:).', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'IotInstanceId', + 'name' => 'AllDay', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'iot-cn-n6w1y59****', - ], + 'schema' => ['description' => 'Specifies whether to enable 24/7 recording.'."\n" + ."\n" + .'- 1: yes.'."\n" + .'- 0: no. For detailed configuration, see the TimeSections.N.DayOfWeek, TimeSections.N.Begin, and TimeSections.N.End parameters.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -15624,826 +13200,1985 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'- **200**: success.'."\n" + .'- Other values: error codes. For more information, see [Error codes](~~145071~~).', 'type' => 'string', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier that Alibaba Cloud generates for the request.'."\n", 'type' => 'string', 'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'tenant auth error', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateTimeTemplate', + 'summary' => 'Updates a time template.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common request parameters when you call this API operation. For more information, see [Common parameters](~~141505~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTimeTemplate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateTimeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.ap-northeast-1.aliyuncs.com', 'endpoint' => 'linkvisual.ap-northeast-1.aliyuncs.com', 'vpc' => 'linkvisual-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.cn-hangzhou.aliyuncs.com', 'endpoint' => 'linkvisual.cn-hangzhou.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.cn-shanghai.aliyuncs.com', 'endpoint' => 'linkvisual.cn-shanghai.aliyuncs.com', 'vpc' => 'linkvisual-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => '403', 'message' => 'tenant auth error', 'http_code' => 200, 'description' => 'The request was denied due to a failure in device or user authentication.'], + ['code' => '403', 'message' => 'request forbidden.', 'http_code' => 200, 'description' => 'The request was forbidden due to a failure in parameter authentication.'], + ['code' => '460', 'message' => 'picture type error.', 'http_code' => 200, 'description' => 'The specified image type is invalid.'], + ['code' => '460', 'message' => 'RAM system auth error.', 'http_code' => 200, 'description' => 'Failed to perform RAM authentication.'], + ['code' => '460', 'message' => 'beginTime can not bigger or equal endTime.', 'http_code' => 200, 'description' => 'The specified beginTime must not be later than the endTime.'], + ['code' => '460', 'message' => 'beginTime or endTime can not be null.', 'http_code' => 200, 'description' => 'Both beginTime and endTime must be specified.'], + ['code' => '460', 'message' => 'product is not active.', 'http_code' => 200, 'description' => 'The device has not activated the video service.'], + ['code' => '466', 'message' => 'request too frequently.', 'http_code' => 200, 'description' => 'The request was sent too frequently.'], + ['code' => '466', 'message' => 'alarm picture exist.', 'http_code' => 200, 'description' => 'The specified alert image was existed, couldn\'t upload again.'], + ['code' => '466', 'message' => 'device offline.', 'http_code' => 200, 'description' => 'The specified device is offline.'], + ['code' => '466', 'message' => 'deviceList lifecycle not exist.', 'http_code' => 200, 'description' => 'The device list life cycle does not exist.'], + ['code' => '466', 'message' => 'triggerPicture failed.', 'http_code' => 200, 'description' => 'The device failed to capture an image.'], + ['code' => '466', 'message' => 'push stream fail.', 'http_code' => 200, 'description' => 'Stream ingest failed.'], + ['code' => '466', 'message' => 'device status is disable.', 'http_code' => 200, 'description' => 'The IoT channel of the device is disabled.'], + ['code' => '466', 'message' => 'device status is initial.', 'http_code' => 200, 'description' => 'The IoT channel for the device has not been activated. It is activated when the device is brought online.'], + ['code' => '466', 'message' => 'device status is offline.', 'http_code' => 200, 'description' => 'The device is offline.'], + ['code' => 'Forbidden.RiskControl', 'message' => 'Your account is at risk. Contact customer support for more details.', 'http_code' => 400, 'description' => ''], + ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => 'An unknown error occurred on the server.'], + ['code' => 'iot.common.AuthActionPermissionDeny', 'message' => 'The authorization fails.', 'http_code' => 400, 'description' => 'The authorization fails.'], + ['code' => 'iot.common.RamActionPermissionDeny', 'message' => 'You do not have the RAM permission.', 'http_code' => 400, 'description' => 'The RAM user does not have permissions to access the resource.'], + ['code' => 'iot.lv.requestAuthError', 'message' => 'Request auth error.', 'http_code' => 403, 'description' => 'The verification failed.'], + ['code' => 'iot.lv.requestError', 'message' => 'Post-paid change limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'iot.lv.requestError', 'message' => 'Request error.', 'http_code' => 400, 'description' => 'Request error.'], + ['code' => 'iot.lv.requestError', 'message' => 'Request error', 'http_code' => 400, 'description' => 'Request error'], + ['code' => 'iot.lv.requestParamError', 'message' => 'Request parameter error.', 'http_code' => 403, 'description' => 'The request parameter is invalid.'], + ['code' => 'iot.lv.requestTimeError', 'message' => 'Request time error.', 'http_code' => 403, 'description' => ''], + ['code' => 'iot.system.InstanceNotFound', 'message' => 'The instance ID does not exist.', 'http_code' => 400, 'description' => 'The instance ID does not exist.'], + ['code' => 'iot.system.UidNotFound', 'message' => 'The Alibaba Cloud account does not exist or the IoT Platform service is not activated.', 'http_code' => 400, 'description' => 'The Alibaba Cloud account does not exist or the IoT Platform service is not activated.'], + ['code' => 'iot.vision.AccountAlreadyExist', 'message' => 'Account already exist.', 'http_code' => 400, 'description' => 'The account already exists.'], + ['code' => 'iot.vision.AccountNotFound', 'message' => 'Account not found.', 'http_code' => 400, 'description' => 'The account does not exist.'], + ['code' => 'iot.vision.AccountRegistryAddFailed', 'message' => 'Add account registry failed.', 'http_code' => 400, 'description' => 'Failed to add account registration information.'], + ['code' => 'iot.vision.AccountRegistryLockFailed', 'message' => 'Get account registry lock failed.', 'http_code' => 400, 'description' => 'Failed to obtain a distributed lock during account registration.'], + ['code' => 'iot.vision.AccountRegistryRemoveFailed', 'message' => 'Remove account registry failed.', 'http_code' => 400, 'description' => 'Failed to delete account registration information.'], + ['code' => 'iot.vision.ActiveCodeInsufficient', 'message' => 'Active code quota is insufficient.', 'http_code' => 400, 'description' => ''], + ['code' => 'iot.vision.AppNameExist', 'message' => 'AppName exist.', 'http_code' => 400, 'description' => 'The name that you specified for the application already exists.'], + ['code' => 'iot.vision.BatchHasCreated', 'message' => 'This batch task has been created.', 'http_code' => 400, 'description' => 'This batch task has been created.'], + ['code' => 'iot.vision.BatchUpgradeDeviceFailed', 'message' => 'Batch upgrade device failed:%s', 'http_code' => 400, 'description' => 'The system failed to batch update the devices.'], + ['code' => 'iot.vision.BindFailed', 'message' => 'Bind account and device failed.', 'http_code' => 400, 'description' => 'The system failed to associate the account with the device.'], + ['code' => 'iot.vision.BindingRelationNotFound', 'message' => 'Account and device binding relation not found.', 'http_code' => 400, 'description' => 'The device is not associated with the account.'], + ['code' => 'iot.vision.CancelOTATaskFailed', 'message' => 'Cancel ota task failed:%s', 'http_code' => 400, 'description' => 'The upgrade task failed to be canceled.'], + ['code' => 'iot.vision.CancelUpgradeTaskFailed', 'message' => 'Cancel upgrade task failed:%s', 'http_code' => 400, 'description' => 'The system failed to cancel the device update.'], + ['code' => 'iot.vision.CheckDeviceFileFailed', 'message' => 'Check device file failed:%s', 'http_code' => 400, 'description' => 'The system failed to verify the device list file.'], + ['code' => 'iot.vision.CheckDeviceFileRequestFailed', 'message' => 'Check device file request failed:%s', 'http_code' => 400, 'description' => 'The request to verify the device list file failed.'], + ['code' => 'iot.vision.ConcurrencyExceedLimit', 'message' => 'Concurrency exceed the limit.', 'http_code' => 400, 'description' => 'The number of concurrent threads exceeds the limit.'], + ['code' => 'iot.vision.CreateDeviceFailed', 'message' => 'create device failed.', 'http_code' => 400, 'description' => 'create device failed.'], + ['code' => 'iot.vision.CreateFirmwareFailed', 'message' => 'Create firmware failed:%s', 'http_code' => 400, 'description' => 'The system failed to create the update package.'], + ['code' => 'iot.vision.CreateFirmwareModuleFailed', 'message' => 'Create firmware module failed:%s', 'http_code' => 400, 'description' => 'The system failed to create the update package module.'], + ['code' => 'iot.vision.CreateProductFailed', 'message' => 'Create product failed.', 'http_code' => 400, 'description' => 'Create product failed.'], + ['code' => 'iot.vision.CreateProductNotAllow', 'message' => 'Create product not allow.', 'http_code' => 400, 'description' => 'Create product not allow.'], + ['code' => 'iot.vision.CreateProjectFailed', 'message' => 'Create project failed.', 'http_code' => 400, 'description' => 'Create project failed.'], + ['code' => 'iot.vision.CreateStorageOrderFailed', 'message' => 'Create storage order failed.', 'http_code' => 400, 'description' => 'Create storage order failed.'], + ['code' => 'iot.vision.CreateSubscribeRelationFailed', 'message' => 'Create subscribe relation failed:%s', 'http_code' => 400, 'description' => 'The system failed to create the subscription.'], + ['code' => 'iot.vision.DeleteDeviceFailed', 'message' => 'delete device failed.', 'http_code' => 400, 'description' => 'delete device failed.'], + ['code' => 'iot.vision.DeleteFirmwareFailed', 'message' => 'Delete firmware failed:%s', 'http_code' => 400, 'description' => 'The system failed to delete the update package.'], + ['code' => 'iot.vision.DeleteFirmwareModuleFailed', 'message' => 'Delete firmware module failed:%s', 'http_code' => 400, 'description' => 'The system failed to delete the update package module.'], + ['code' => 'iot.vision.DeleteProductFailed', 'message' => 'Delete product failed.', 'http_code' => 400, 'description' => 'Delete product failed.'], + ['code' => 'iot.vision.DeleteProjectFailed', 'message' => 'Delete project failed.', 'http_code' => 400, 'description' => 'Delete project failed.'], + ['code' => 'iot.vision.DeleteSubscribeRelationFailed', 'message' => 'Delete subscribe relation failed:%s', 'http_code' => 400, 'description' => 'The system failed to delete the subscription.'], + ['code' => 'iot.vision.DevcieOffline', 'message' => 'Device offline.', 'http_code' => 400, 'description' => 'The device is offline.'], + ['code' => 'iot.vision.DeviceInactive', 'message' => 'Device inactive.', 'http_code' => 400, 'description' => 'The device is inactive.'], + ['code' => 'iot.vision.DeviceNameCheckFailed', 'message' => 'Device names check failed.', 'http_code' => 400, 'description' => 'Device names check failed.'], + ['code' => 'iot.vision.DeviceNameChecking', 'message' => 'Device names are checking.', 'http_code' => 400, 'description' => ''], + ['code' => 'iot.vision.DeviceNameDuplicate', 'message' => 'Device name duplicate.', 'http_code' => 400, 'description' => 'The DeviceName already exists.'], + ['code' => 'iot.vision.DeviceNameFormatInvalid', 'message' => 'Device name format invalid.', 'http_code' => 400, 'description' => 'Device name format invalid.'], + ['code' => 'iot.vision.DeviceNicknameInvalid', 'message' => 'Device nickname invalid.', 'http_code' => 400, 'description' => 'Device nickname invalid.'], + ['code' => 'iot.vision.DeviceNoOwner', 'message' => 'Device has no owner.', 'http_code' => 400, 'description' => 'Device has no owner.'], + ['code' => 'iot.vision.DeviceNotExist', 'message' => 'Device not exist.', 'http_code' => 400, 'description' => 'Device not exist.'], + ['code' => 'iot.vision.DeviceNotStreaming', 'message' => 'Device is not streaming.', 'http_code' => 400, 'description' => 'The device does not ingest streams.'], + ['code' => 'iot.vision.DeviceNumLimit', 'message' => 'device num exceed limit.', 'http_code' => 400, 'description' => 'device num exceed limit.'], + ['code' => 'iot.vision.DeviceOffline', 'message' => 'Device is offline.', 'http_code' => 400, 'description' => 'The device is offline.'], + ['code' => 'iot.vision.DeviceOwnerChanged', 'message' => 'Device owner changed.', 'http_code' => 400, 'description' => 'Device owner changed.'], + ['code' => 'iot.vision.DevicePropertyFormatInvalid', 'message' => 'Device property format invalid.', 'http_code' => 400, 'description' => 'Device property format invalid.'], + ['code' => 'iot.vision.DevicesCountExceedLimit', 'message' => 'The devices count exceed the limit.', 'http_code' => 400, 'description' => 'The devices count exceed the limit.'], + ['code' => 'iot.vision.DevicesExceedUnreleasedProductLimit', 'message' => 'Devices count exceed the limit of unreleased product.', 'http_code' => 400, 'description' => ''], + ['code' => 'iot.vision.DownloadJobError', 'message' => 'Download job error.', 'http_code' => 400, 'description' => 'An exception occurred on the download task.'], + ['code' => 'iot.vision.FirmwareNotFound', 'message' => 'The specified firmware does not exist.', 'http_code' => 400, 'description' => 'No update package of the version exists.'], + ['code' => 'iot.vision.FirmwareNotVerified', 'message' => 'Firmware validation not completed.', 'http_code' => 400, 'description' => 'The update package is verified.'], + ['code' => 'iot.vision.FirmwareSourceVersionMismatch', 'message' => 'Current firmware version of device does not match source version of firmware.', 'http_code' => 400, 'description' => 'The current version number of the device does not match the original version number of the update package.'], + ['code' => 'iot.vision.FirmwareVerifyFailed', 'message' => 'Firmware verify failed.', 'http_code' => 400, 'description' => 'The system failed to verify the update package.'], + ['code' => 'iot.vision.FirmwareVersionMismatch', 'message' => 'The version of firmware mismatch.', 'http_code' => 400, 'description' => 'The version number of the update package does not match the specified version number.'], + ['code' => 'iot.vision.FreeStorageLimit', 'message' => 'Free storage quota exceed limit.', 'http_code' => 400, 'description' => 'Free storage quota exceed limit.'], + ['code' => 'iot.vision.FreeStorageQuotaLimit', 'message' => 'No enough free storage quota or exceed limit.', 'http_code' => 400, 'description' => 'No enough free storage quota or exceed limit.'], + ['code' => 'iot.vision.GbIdDuplicate', 'message' => 'The GB28181 deviceId is duplicated.', 'http_code' => 400, 'description' => 'The standard ID already exists.'], + ['code' => 'iot.vision.GbServiceNotEnabled', 'message' => 'The GB28181 service has not been enabled.', 'http_code' => 400, 'description' => 'The standard service is not started.'], + ['code' => 'iot.vision.GenerateDeviceNameListUrlFailed', 'message' => 'Generate device name list url failed:%s', 'http_code' => 400, 'description' => 'The system failed to generate a device list upload URL.'], + ['code' => 'iot.vision.GenerateFirmwareUploadUrlFailed', 'message' => 'Generate firmware upload url failed:%s', 'http_code' => 400, 'description' => 'The system failed to generate a firmware upload URL.'], + ['code' => 'iot.vision.GetAccountInfoFailed', 'message' => 'Get account info failed.', 'http_code' => 400, 'description' => 'The system failed to query information about the account.'], + ['code' => 'iot.vision.GetDeviceInfoFailed', 'message' => 'Get device info failed.', 'http_code' => 400, 'description' => 'The system failed to query the details of the device.'], + ['code' => 'iot.vision.GetOwnerIdentityInfoFailed', 'message' => 'Get owner identity info failed.', 'http_code' => 400, 'description' => 'The system failed to query information about the device administrator.'], + ['code' => 'iot.vision.GetThingEventSnapshotFailed', 'message' => 'Get thing event snapshot failed.', 'http_code' => 400, 'description' => 'The system failed to query TSL event snapshots.'], + ['code' => 'iot.vision.HasNoAccessPermission', 'message' => 'Has no access permission.', 'http_code' => 403, 'description' => ''], + ['code' => 'iot.vision.HasRelatedProduct', 'message' => 'Has related product.', 'http_code' => 400, 'description' => 'One or more associated products cannot be deleted.'], + ['code' => 'iot.vision.IdentityAppKeyProductNotBind', 'message' => 'The app associated with the identityId does not have permission to access the product.', 'http_code' => 400, 'description' => 'No product is associated with the AppKey that is related to the account.'], + ['code' => 'iot.vision.ImportProjectFailed', 'message' => 'Import project failed.', 'http_code' => 400, 'description' => 'Import project failed.'], + ['code' => 'iot.vision.InstanceArrearage', 'message' => 'Instance arrearage.', 'http_code' => 400, 'description' => 'Instance arrearage.'], + ['code' => 'iot.vision.InvalidCallerType', 'message' => 'Invalid caller type.', 'http_code' => 400, 'description' => 'Invalid caller type.'], + ['code' => 'iot.vision.InvalidFirmwareId', 'message' => 'Invalid firmware Id.', 'http_code' => 400, 'description' => 'The ID of the update package is invalid.'], + ['code' => 'iot.vision.InvalidIotInstance', 'message' => 'Invalid iot instance.', 'http_code' => 400, 'description' => 'Invalid iot instance.'], + ['code' => 'iot.vision.InvalidStorageCommodity', 'message' => 'Invalid storage commodity.', 'http_code' => 400, 'description' => 'Invalid storage commodity.'], + ['code' => 'iot.vision.InvalidStorageOrder', 'message' => 'Invalid storage order.', 'http_code' => 400, 'description' => 'Invalid storage order.'], + ['code' => 'iot.vision.InvokeServiceFailed', 'message' => '%s', 'http_code' => 400, 'description' => 'The system failed to call the TSL service.'], + ['code' => 'iot.vision.InvokeServiceFailed', 'message' => '%s failed.', 'http_code' => 400, 'description' => 'The system failed to call the TSL service.'], + ['code' => 'iot.vision.InvokeServiceFailed', 'message' => 'Invoke service failed:%s', 'http_code' => 400, 'description' => 'The system failed to call the TSL service.'], + ['code' => 'iot.vision.JobNotExist', 'message' => 'Job not exist or expired.', 'http_code' => 400, 'description' => 'The task does not exist or has expired.'], + ['code' => 'iot.vision.ModifyFirmwareFailed', 'message' => 'Modify firmware failed:%s', 'http_code' => 400, 'description' => 'The system failed to modify the update package.'], + ['code' => 'iot.vision.NoAvailableActiveCode', 'message' => 'No available active codes.', 'http_code' => 400, 'description' => 'No available active codes.'], + ['code' => 'iot.vision.NoStorageQuota', 'message' => 'No storage quota.', 'http_code' => 400, 'description' => 'The storage quota is exceeded.'], + ['code' => 'iot.vision.ParamBatchIdInvalid', 'message' => 'Parameter batchId is invalid.', 'http_code' => 400, 'description' => 'Parameter batchId is invalid.'], + ['code' => 'iot.vision.PreviousImportProjectTaskNotFinished', 'message' => 'Previous import project task not finished.', 'http_code' => 400, 'description' => 'Previous import project task not finished.'], + ['code' => 'iot.vision.ProductCancelReleaseFailed.', 'message' => 'Product cancel release failed.', 'http_code' => 400, 'description' => 'Product cancel release failed.'], + ['code' => 'iot.vision.ProductHasRelatedAuthorization', 'message' => 'Product has related authorization.', 'http_code' => 400, 'description' => 'Product has related authorization.'], + ['code' => 'iot.vision.ProductHasRelatedResource', 'message' => 'Product has related resource.', 'http_code' => 400, 'description' => 'Product has related resource.'], + ['code' => 'iot.vision.ProductKeyFormatInvalid', 'message' => 'Product key format invalid.', 'http_code' => 400, 'description' => 'Product key format invalid.'], + ['code' => 'iot.vision.ProductNameDuplicated', 'message' => 'Product name duplicated.', 'http_code' => 400, 'description' => 'Product name duplicated.'], + ['code' => 'iot.vision.ProductNameFormatInvalid', 'message' => 'Product name format invalid.', 'http_code' => 400, 'description' => 'Product name format invalid.'], + ['code' => 'iot.vision.ProductNameLengthInvalid', 'message' => 'Product name length invalid.', 'http_code' => 400, 'description' => 'Product name length invalid.'], + ['code' => 'iot.vision.ProductNotExist', 'message' => 'Product not exist.', 'http_code' => 400, 'description' => 'Product not exist.'], + ['code' => 'iot.vision.ProductNotRelease', 'message' => 'Product not release.', 'http_code' => 400, 'description' => 'Product not release.'], + ['code' => 'iot.vision.ProductNumLimit', 'message' => 'Product number exceed limit.', 'http_code' => 400, 'description' => 'Product number exceed limit.'], + ['code' => 'iot.vision.ProductReleased', 'message' => 'Product had been released.', 'http_code' => 400, 'description' => 'Product had been released.'], + ['code' => 'iot.vision.ProductReleaseFailed', 'message' => 'Product release failed.', 'http_code' => 400, 'description' => 'Product release failed.'], + ['code' => 'iot.vision.ProductShouldNotDelete', 'message' => 'Product should not delete.', 'http_code' => 400, 'description' => 'Product should not delete.'], + ['code' => 'iot.vision.ProductShouldNotEdit', 'message' => 'Product should not edit.', 'http_code' => 400, 'description' => 'Product should not edit.'], + ['code' => 'iot.vision.ProductTagDuplicated', 'message' => 'Product tag duplicated.', 'http_code' => 400, 'description' => 'Product tag duplicated.'], + ['code' => 'iot.vision.ProductTagLengthInvalid', 'message' => 'Product tag length invalid.', 'http_code' => 400, 'description' => 'Product tag length invalid.'], + ['code' => 'iot.vision.ProductTagNotFound', 'message' => 'Product tag not found.', 'http_code' => 400, 'description' => 'Product tag not found.'], + ['code' => 'iot.vision.ProductTagNumLimit', 'message' => 'Product tag num limit.', 'http_code' => 400, 'description' => 'Product tag num limit.'], + ['code' => 'iot.vision.ProductTypeMismatch', 'message' => 'Product type mismatch.', 'http_code' => 400, 'description' => 'Product type mismatch.'], + ['code' => 'iot.vision.ProductUpdateFailed', 'message' => 'Product update failed.', 'http_code' => 400, 'description' => 'Product update failed.'], + ['code' => 'iot.vision.ProjectCreateLimit', 'message' => 'Project still in initializing please try again later.', 'http_code' => 400, 'description' => 'One or more of your projects are being created. Try again later.'], + ['code' => 'iot.vision.ProjectHasNoProducts', 'message' => 'Project has no products.', 'http_code' => 400, 'description' => 'Project has no products.'], + ['code' => 'iot.vision.ProjectHasRelatedResource', 'message' => 'Project has related resource.', 'http_code' => 400, 'description' => 'Project has related resource.'], + ['code' => 'iot.vision.ProjectNameDuplicated', 'message' => 'Project name duplicated.', 'http_code' => 400, 'description' => 'Project name duplicated.'], + ['code' => 'iot.vision.ProjectNameLengthInvalid', 'message' => 'Project name length invalid.', 'http_code' => 400, 'description' => 'Project name length invalid.'], + ['code' => 'iot.vision.ProjectNotExist', 'message' => 'Project does not exist.', 'http_code' => 400, 'description' => 'Project does not exist.'], + ['code' => 'iot.vision.ProjectNumLimit', 'message' => 'Project num exceed limit.', 'http_code' => 400, 'description' => 'Project num exceed limit.'], + ['code' => 'iot.vision.PropertyNotFound', 'message' => 'Property not found.', 'http_code' => 400, 'description' => 'The TSL property does not exist.'], + ['code' => 'iot.vision.PropertyReadOnly', 'message' => 'Property is read only.', 'http_code' => 400, 'description' => 'The TSL property is read-only.'], + ['code' => 'iot.vision.QueryAppListError', 'message' => 'No Result.', 'http_code' => 400, 'description' => 'No Result.'], + ['code' => 'iot.vision.QueryBindingAccountFailed', 'message' => 'Query binding account failed.', 'http_code' => 400, 'description' => 'The system failed to query associated users.'], + ['code' => 'iot.vision.QueryBindingDeviceFailed', 'message' => 'Query binding device failed.', 'http_code' => 400, 'description' => 'The system failed to query the associated device list.'], + ['code' => 'iot.vision.QueryCommodityPriceFailed', 'message' => 'Query commodity price failed.', 'http_code' => 400, 'description' => 'The system failed to query the price of the cloud storage product.'], + ['code' => 'iot.vision.QueryConsumerGroupFailed', 'message' => 'Query consumer group failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the consumer group.'], + ['code' => 'iot.vision.QueryDeviceFailed', 'message' => 'query device failed.', 'http_code' => 400, 'description' => 'query device failed.'], + ['code' => 'iot.vision.QueryDeviceGroupFailed', 'message' => 'Query device group failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the device group.'], + ['code' => 'iot.vision.QueryDeviceUpgradeCountFailed', 'message' => 'Query device upgrade count failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the number of device updates.'], + ['code' => 'iot.vision.QueryDeviceUpgradeInfoFailed', 'message' => 'Query device upgrade info failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the update status of the device.'], + ['code' => 'iot.vision.QueryDeviceVersionStatisticsFailed', 'message' => 'Query device version statistics failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the details of the distribution of device versions.'], + ['code' => 'iot.vision.QueryFirmwareFailed', 'message' => 'Query firmware failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the firmware.'], + ['code' => 'iot.vision.QueryFirmwareModuleFailed', 'message' => 'Query firmware module failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the update package module.'], + ['code' => 'iot.vision.QueryFirmwareVersionFailed', 'message' => 'Query firmware version failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the update package version.'], + ['code' => 'iot.vision.QueryProductRelatedDeviceFailed', 'message' => 'Query product related device failed.', 'http_code' => 400, 'description' => 'Query product related device failed.'], + ['code' => 'iot.vision.QuerySubscribeRelationFailed', 'message' => 'Query subscribe relation failed:%s', 'http_code' => 400, 'description' => 'The system failed to query subscriptions.'], + ['code' => 'iot.vision.QueryUpgradeDefaultTimeoutFailed', 'message' => 'Query upgrade default timeout failed:%s', 'http_code' => 400, 'description' => 'The request to query the default timeout period of the update failed.'], + ['code' => 'iot.vision.QueryUpgradeDeviceFailed', 'message' => 'Query upgrade device failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the device to be updated.'], + ['code' => 'iot.vision.QueryUpgradeStatisticsInfoFailed', 'message' => 'Query upgrade statistics info failed:%s', 'http_code' => 400, 'description' => 'The system failed to query statistics on updates.'], + ['code' => 'iot.vision.QueryUpgradeTaskFailed', 'message' => 'Query upgrade task failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the update task.'], + ['code' => 'iot.vision.RecordNotExist', 'message' => 'Record not exist.', 'http_code' => 400, 'description' => 'The video file does not exist.'], + ['code' => 'iot.vision.RefreshTooFrequently', 'message' => 'Refresh too frequently.', 'http_code' => 400, 'description' => 'Refresh requests are submitted too frequently.'], + ['code' => 'iot.vision.RequestAuthFailed', 'message' => 'Request auth failed.', 'http_code' => 403, 'description' => 'Request auth failed.'], + ['code' => 'iot.vision.RequestError', 'message' => 'Request error.', 'http_code' => 400, 'description' => 'The request failed.'], + ['code' => 'iot.vision.RequestFailed', 'message' => 'Request failed.', 'http_code' => 400, 'description' => 'Request failed.'], + ['code' => 'iot.vision.RequestFailed', 'message' => 'product already publish operation not allowed.', 'http_code' => 400, 'description' => 'The operation cannot be performed on the product because the product is published.'], + ['code' => 'iot.vision.RequestFailed', 'message' => 'product not exist.', 'http_code' => 400, 'description' => 'The product does not exist.'], + ['code' => 'iot.vision.RequestForbidden', 'message' => 'Request forbidden.', 'http_code' => 403, 'description' => 'Request forbidden.'], + ['code' => 'iot.vision.RequestParamError', 'message' => 'Request parameter error.', 'http_code' => 400, 'description' => 'Request parameter error.'], + ['code' => 'iot.vision.RequestParamError', 'message' => 'Request parameter error:%s', 'http_code' => 400, 'description' => 'The request parameter is invalid.'], + ['code' => 'iot.vision.RequestParameterError', 'message' => 'Request parameter error:%s', 'http_code' => 400, 'description' => 'The request parameter is invalid.'], + ['code' => 'iot.vision.RequestTrafficControl', 'message' => 'Request traffic control.', 'http_code' => 429, 'description' => 'Request traffic control.'], + ['code' => 'iot.vision.ReUpgradeDeviceFailed', 'message' => 'ReUpgrade device failed:%s', 'http_code' => 400, 'description' => 'The system failed to re-update the device.'], + ['code' => 'iot.vision.RtmpKeyNotSet', 'message' => 'Rtmp key not set.', 'http_code' => 400, 'description' => 'No authentication key is specified.'], + ['code' => 'iot.vision.ServerError', 'message' => 'server error.', 'http_code' => 400, 'description' => 'server error.'], + ['code' => 'iot.vision.ServiceEnumSpecError', 'message' => 'Service enum spec error.', 'http_code' => 400, 'description' => 'The enumeration parameter of the TSL service is invalid.'], + ['code' => 'iot.vision.ServiceNotFound', 'message' => 'Invoke service failed as service not found.', 'http_code' => 400, 'description' => 'The TSL service does not exist.'], + ['code' => 'iot.vision.ServiceParamNotExist', 'message' => 'Invoke service failed as service param not exist.', 'http_code' => 400, 'description' => 'The parameter of the TSL service does not exist.'], + ['code' => 'iot.vision.ServiceResponseTimeout', 'message' => 'Invoke service response timeout.', 'http_code' => 400, 'description' => 'The device response timed out.'], + ['code' => 'iot.vision.SetAccountFailed', 'message' => 'Set account failed.', 'http_code' => 400, 'description' => 'Set account failed.'], + ['code' => 'iot.vision.SetDefaultRecordPlanFailed', 'message' => 'Set default record plan failed.', 'http_code' => 400, 'description' => 'The system failed to configure the default video recording plan.'], + ['code' => 'iot.vision.SetPropertyFailed', 'message' => 'Set property failed.', 'http_code' => 400, 'description' => 'The system failed to configure the TSL property.'], + ['code' => 'iot.vision.StorageCommodityUnavailable', 'message' => 'Storage commodity unavailable.', 'http_code' => 400, 'description' => 'You cannot use the cloud storage product.'], + ['code' => 'iot.vision.StorageOrderAlreadyPaid', 'message' => 'Storage order had been paid.', 'http_code' => 400, 'description' => 'The payment for the cloud storage order is complete.'], + ['code' => 'iot.vision.StorageOrderGetLockFailed', 'message' => 'Get storage order lock failed try again later.', 'http_code' => 400, 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['code' => 'iot.vision.StorageOrderPayFailed', 'message' => 'Storage order pay failed.', 'http_code' => 400, 'description' => 'The payment for the cloud storage order failed.'], + ['code' => 'iot.vision.StorageOrderStatusInvalid', 'message' => 'Storage order status invalid.', 'http_code' => 400, 'description' => 'You cannot perform the operation on the cloud storage order.'], + ['code' => 'iot.vision.StreamNameDuplicate', 'message' => 'Stream name duplicate.', 'http_code' => 400, 'description' => 'The stream name already exists.'], + ['code' => 'iot.vision.StreamPushFailed', 'message' => 'Stream push failed.', 'http_code' => 400, 'description' => 'The stream ingest failed.'], + ['code' => 'iot.vision.TargetDeviceOwnerDifferent', 'message' => 'Target device owner is different.', 'http_code' => 400, 'description' => 'The administrator of the destination device is different from the administrator of the order to be transferred.'], + ['code' => 'iot.vision.TemplateMacroInvalid', 'message' => 'macro invalid.', 'http_code' => 400, 'description' => 'The format of the macro is invalid.'], + ['code' => 'iot.vision.TemplateTextInvalid', 'message' => 'var or text invalid.', 'http_code' => 400, 'description' => 'The format of the variable or the text is invalid.'], + ['code' => 'iot.vision.TenantMismatch', 'message' => 'Caller tenant and account belong tenant mismatch.', 'http_code' => 400, 'description' => 'The tenant of the API operation caller is different from the tenant to which the account belongs.'], + ['code' => 'iot.vision.ThingAbilityNameDuplicated', 'message' => 'Thing model ability name duplicated.', 'http_code' => 400, 'description' => 'The name that you specified for the TSL feature already exists.'], + ['code' => 'iot.vision.ThingEventNotFound', 'message' => 'Thing event not found.', 'http_code' => 400, 'description' => 'The TSL event does not exist.'], + ['code' => 'iot.vision.ThingModelAbilityDuplicated', 'message' => 'Thing model ability duplicated.', 'http_code' => 400, 'description' => 'Thing model ability duplicated.'], + ['code' => 'iot.vision.ThingModelIdentifierNotExist', 'message' => 'Thing model identifier not exist.', 'http_code' => 400, 'description' => 'Thing model identifier not exist.'], + ['code' => 'iot.vision.ThingModelNotExist', 'message' => 'Thing model not exist.', 'http_code' => 400, 'description' => 'Thing model not exist.'], + ['code' => 'iot.vision.ThingModelParamsFormatInvalid', 'message' => 'Thing model params format invalid.', 'http_code' => 400, 'description' => 'Thing model params format invalid.'], + ['code' => 'iot.vision.ThingModelParamsInvalid', 'message' => 'Thing model params invalid.', 'http_code' => 400, 'description' => 'Thing model params invalid.'], + ['code' => 'iot.vision.ThingModelUpdateFailed', 'message' => 'Thing model update failed.', 'http_code' => 400, 'description' => 'The modification on the TSL model failed to take effect.'], + ['code' => 'iot.vision.UnbindFailed', 'message' => 'Unbind account and device failed.', 'http_code' => 400, 'description' => 'The system failed to disassociate the device from the account.'], + ['code' => 'iot.vision.UnexpectedInternalError', 'message' => 'Unexpected internal error.', 'http_code' => 400, 'description' => 'Unexpected internal error.'], + ['code' => 'iot.vision.UpdateConsumerGroupFailed', 'message' => 'Update consumer group failed:%s', 'http_code' => 400, 'description' => 'The system failed to update the consumer group.'], + ['code' => 'iot.vision.UpdateFirmwareModuleFailed', 'message' => 'Update firmware module failed:%s', 'http_code' => 400, 'description' => 'The system failed to update the update package module.'], + ['code' => 'iot.vision.UpdateOTATaskStrategyFailed', 'message' => 'Update ota task strategy failed:%s', 'http_code' => 400, 'description' => 'Failed to update the OTA upgrade task policy.'], + ['code' => 'iot.vision.UpdateSubscribeRelationFailed', 'message' => 'Update subscribe relation failed:%s', 'http_code' => 400, 'description' => 'The system failed to update the subscription.'], + ['code' => 'iot.vision.VerifyFirmwareRequestFailed', 'message' => 'Verify firmware request failed:%s', 'http_code' => 400, 'description' => 'The request to verify the update package failed.'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamSnapshotJob'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryGbSubDeviceList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceUserGroup'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLocalRecordDownloadByTimeJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPictureSearchAiboxes'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRecordPlan'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableGbSubDevice'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerRecord'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFaceUser'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRecord'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ClearFaceDeviceDB'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordByRecordId'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPictureSearchJobResult'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventRecordPlan'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStreamSnapshotJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePictureSearchJob'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshGbSubDeviceList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceDeviceGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceEventRecord'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPictureSearchJobStatus'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVisionDeviceInfo'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceUserGroupAndDeviceGroupRelation'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceInternetProtocol'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddEventRecordPlanDevice'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordUrlByTime'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTimeTemplate'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamPushJob'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStreamSnapshotJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCarProcessEvents'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaceUser'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordDownloadJobList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLocalFileUploadJob'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordDownloadUrl'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryEventRecordPlanDeviceByPlan'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStreamPushJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceAllDeviceGroup'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePicture'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStreamPushJobList'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRecordDownloadByTimeJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPictureSearchDevices'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaceUserGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTimeTemplate'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordPlanDeviceByPlan'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRecordPlanDevice'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceUserByName'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVoiceIntercom'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransferDeviceInstance'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceEvent'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEventRecordPlan'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindPictureSearchAppWithDevices'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryEventRecordPlanDetail'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePictureSearchApp'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckFaceUserDoExistOnDevice'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDevicePictureFile'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceDeviceToDeviceGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceUserPicture'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTimeTemplate'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRtmpKey'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveFaceDeviceFromDeviceGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceUserIdByCustomUserId'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaceUserGroupAndDeviceGroupRelation'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRtmpDevice'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRtmpKey'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceRecordLifeCycle'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddRecordPlanDevice'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDevicePictureLifeCycle'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchQueryVisionDeviceInfo'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGbDevice'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceDeviceGroupsByDevice'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTimeTemplate'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGbDevice'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordPlans'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordDownloadJobById'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceVodUrl'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceVodUrlByTime'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceUser'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamPushJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveFaceUserFromUserGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDevicePictureByList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceUserToUserGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPictureSearchJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryLiveStreaming'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PictureSearchPicture'], + ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecord'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGbDevice'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRecordPlan'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMonthRecord'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryEventRecordPlanDeviceByDevice'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDevicePictureLifeCycle'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRtmpKey'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLocalFileUploadJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopTriggeredRecord'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerCapturePicture'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryLocalFileUploadJob'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaceDeviceGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFaceUserGroupAndDeviceGroupRelation'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEventRecordPlan'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPictureSearchApps'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryEventRecordPlans'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordPlanDeviceByDevice'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordUrl'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopLiveStreaming'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetDeviceRecordLifeCycle'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordPlanDetail'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceAllUserGroup'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTimeTemplateDetail'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindPictureSearchAppWithDevices'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventRecordPlanDevice'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPictureFiles'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceUserGroup'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRtmpDevice'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceCustomUserIdByUserId'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddFaceUserGroupAndDeviceGroupRelation'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceAllUserIdsByGroupId'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRecordPlan'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceUser'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceEventPicture'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceAllUserGroupAndDeviceGroupRelation'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFaceUserBatch'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePictureSearchApp'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFaceUserPicture'], + ], + ], + 'ram' => [ + 'productCode' => 'LinkVisual', + 'productName' => 'Link Visual', + 'ramCodes' => ['linkvisual'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DeleteRecordPlan', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteRecordPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', + ], + ], + [ + 'apiName' => 'BindPictureSearchAppWithDevices', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:BindPictureSearchAppWithDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestError', - 'errorMessage' => 'Request error.', + ], + ], + [ + 'apiName' => 'CreateRtmpDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateRtmpDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.JobNotExist', - 'errorMessage' => 'Job not exist or expired.', + ], + ], + [ + 'apiName' => 'QueryGbSubDeviceList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryGbSubDeviceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', + ], + [ + 'apiName' => 'QueryEventRecordPlanDeviceByPlan', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryEventRecordPlanDeviceByPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', + ], + ], + [ + 'apiName' => 'QueryStreamSnapshotJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryStreamSnapshotJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + [ + 'apiName' => 'CreateEventRecordPlan', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:CreateEventRecordPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateStreamSnapshotJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateStreamSnapshotJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RemoveFaceUserFromUserGroup', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:RemoveFaceUserFromUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateLocalFileUploadJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateLocalFileUploadJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRecordDownloadJobById', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordDownloadJobById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRtmpKey', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteRtmpKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRecord', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteStreamSnapshotJob' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreatePictureSearchJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:CreatePictureSearchJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'QueryDeviceEventPicture', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceEventPicture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'BatchQueryVisionDeviceInfo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:BatchQueryVisionDeviceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', + [ + 'apiName' => 'DeleteRecord', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DeviceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', + ], + [ + 'apiName' => 'CreatePictureSearchApp', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:CreatePictureSearchApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + [ + 'apiName' => 'AddFaceUserToUserGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceUserToUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'iot-cn-n6w1y59****', + ], + [ + 'apiName' => 'UpdateRecordPlan', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateRecordPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StreamType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', + ], + [ + 'apiName' => 'TriggerCapturePicture', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:TriggerCapturePicture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'SetDevicePictureLifeCycle', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:SetDevicePictureLifeCycle', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', + [ + 'apiName' => 'QueryEventRecordPlanDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryEventRecordPlanDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', + ], + ], + [ + 'apiName' => 'StopLiveStreaming', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:StopLiveStreaming', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestError', - 'errorMessage' => 'Request error.', + ], + ], + [ + 'apiName' => 'QueryDeviceEventRecord', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceEventRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.JobNotExist', - 'errorMessage' => 'Job not exist or expired.', + ], + ], + [ + 'apiName' => 'QueryLiveStreaming', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryLiveStreaming', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', + ], + [ + 'apiName' => 'QueryFaceUserGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', + ], + ], + [ + 'apiName' => 'DeleteFaceUserGroupAndDeviceGroupRelation', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteFaceUserGroupAndDeviceGroupRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + [ + 'apiName' => 'UnbindPictureSearchAppWithDevices', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UnbindPictureSearchAppWithDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryStreamPushJob' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DeleteLocalFileUploadJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteLocalFileUploadJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'StopTriggeredRecord', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:StopTriggeredRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteFaceUser', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteFaceUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', + [ + 'apiName' => 'QueryRecordPlanDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordPlanDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DeviceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', + ], + [ + 'apiName' => 'QueryTimeTemplateDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryTimeTemplateDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '23*********', + ], + [ + 'apiName' => 'QueryPictureSearchJobResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryPictureSearchJobResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + [ + 'apiName' => 'QueryFaceCustomUserIdByUserId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceCustomUserIdByUserId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'iot-cn-n6w1y59****', + ], + [ + 'apiName' => 'CheckFaceUserDoExistOnDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CheckFaceUserDoExistOnDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'JobType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PushUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtmp://****', - ], - 'StreamType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1581595942', - ], - 'PushStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], + [ + 'apiName' => 'TransferDeviceInstance', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:TransferDeviceInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', + [ + 'apiName' => 'AddFaceUserPicture', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceUserPicture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', + ], + ], + [ + 'apiName' => 'GetPictureSearchJobStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:GetPictureSearchJobStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestError', - 'errorMessage' => 'Request error.', + ], + ], + [ + 'apiName' => 'QueryDeviceRecordLifeCycle', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceRecordLifeCycle', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.JobNotExist', - 'errorMessage' => 'Job not exist or expired.', + ], + ], + [ + 'apiName' => 'UpdateEventRecordPlan', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateEventRecordPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', + ], + [ + 'apiName' => 'QueryVoiceIntercom', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryVoiceIntercom', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', + ], + ], + [ + 'apiName' => 'QueryEventRecordPlanDeviceByDevice', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryEventRecordPlanDeviceByDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + [ + 'apiName' => 'QueryFaceAllUserIdsByGroupId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceAllUserIdsByGroupId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryStreamPushJobList' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'UpdatePictureSearchApp', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:UpdatePictureSearchApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'QueryMonthRecord', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryMonthRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QueryFaceDeviceGroupsByDevice', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceDeviceGroupsByDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', + [ + 'apiName' => 'QueryDeviceEvent', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceEvent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', + ], + [ + 'apiName' => 'CreateLocalRecordDownloadByTimeJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateLocalRecordDownloadByTimeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DeviceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', + ], + [ + 'apiName' => 'DeleteRecordPlanDevice', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteRecordPlanDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + [ + 'apiName' => 'QueryPictureSearchAiboxes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryPictureSearchAiboxes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'iot-cn-n6w1y59****', + ], + [ + 'apiName' => 'QueryRtmpKey', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRtmpKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + ], + [ + 'apiName' => 'QueryRecordByRecordId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordByRecordId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'JobType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', + ], + [ + 'apiName' => 'UpdateFaceUserGroupAndDeviceGroupRelation', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateFaceUserGroupAndDeviceGroupRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - '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' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'JobId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '23********', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1581595942', - ], - 'PushStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'JobType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'CreateStreamPushJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateStreamPushJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', + [ + 'apiName' => 'UpdateRtmpKey', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateRtmpKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', + ], + ], + [ + 'apiName' => 'QueryDeviceVodUrlByTime', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceVodUrlByTime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestError', - 'errorMessage' => 'Request error.', + ], + ], + [ + 'apiName' => 'QueryLocalFileUploadJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryLocalFileUploadJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', + ], + [ + 'apiName' => 'DeleteRtmpDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteRtmpDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', + ], + ], + [ + 'apiName' => 'QueryDeviceVodUrl', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceVodUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + [ + 'apiName' => 'DeleteEventRecordPlan', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteEventRecordPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryStreamSnapshotJob' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'QueryDevicePictureByList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDevicePictureByList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'QueryTimeTemplate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryTimeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QueryRecordDownloadUrl', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordDownloadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1BwAGV****', + [ + 'apiName' => 'QueryRecordPlanDeviceByDevice', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordPlanDeviceByDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DeviceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'camera1', + ], + [ + 'apiName' => 'QueryRecordUrl', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd7XmBoJhAr88C6PelXDF00****', + ], + [ + 'apiName' => 'ClearFaceDeviceDB', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:ClearFaceDeviceDB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IotInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'iot-cn-n6w1y59****', + ], + [ + 'apiName' => 'QueryCarProcessEvents', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryCarProcessEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'JobList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StreamType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SnapshotInterval' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '600', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DeleteEventRecordPlanDevice', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteEventRecordPlanDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', + [ + 'apiName' => 'QueryStreamPushJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryStreamPushJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', + ], + ], + [ + 'apiName' => 'QueryFaceUserIdByCustomUserId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceUserIdByCustomUserId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestError', - 'errorMessage' => 'Request error.', + ], + ], + [ + 'apiName' => 'QueryDevicePictureFile', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDevicePictureFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', + ], + [ + 'apiName' => 'QueryPictureSearchJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryPictureSearchJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', + ], + ], + [ + 'apiName' => 'DeleteStreamPushJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteStreamPushJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + [ + 'apiName' => 'DeleteFaceDeviceGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteFaceDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddFaceUserGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryFaceUserByName', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceUserByName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryDevicePictureLifeCycle', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDevicePictureLifeCycle', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRecordPlanDeviceByPlan', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordPlanDeviceByPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteTimeTemplate', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteTimeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeletePicture', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeletePicture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteFaceUserGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteFaceUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddEventRecordPlanDevice', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddEventRecordPlanDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateGbDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateGbDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateGbDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateGbDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateFaceUser', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateFaceUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTimeTemplate', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateTimeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddFaceUser', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryStreamPushJobList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryStreamPushJobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryFaceUserBatch', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceUserBatch', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRecordDownloadByTimeJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateRecordDownloadByTimeJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteGbDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteGbDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnableGbSubDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:EnableGbSubDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateTimeTemplate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:CreateTimeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteFaceUserPicture', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteFaceUserPicture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RefreshGbSubDeviceList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:RefreshGbSubDeviceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryVisionDeviceInfo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryVisionDeviceInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddFaceUserGroupAndDeviceGroupRelation', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceUserGroupAndDeviceGroupRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryFaceAllDeviceGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceAllDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'TriggerRecord', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:TriggerRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RemoveFaceDeviceFromDeviceGroup', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:RemoveFaceDeviceFromDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryFaceUserGroupAndDeviceGroupRelation', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceUserGroupAndDeviceGroupRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteStreamSnapshotJob', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:DeleteStreamSnapshotJob', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddRecordPlanDevice', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddRecordPlanDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PictureSearchPicture', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:PictureSearchPicture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryEventRecordPlans', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryEventRecordPlans', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddFaceDeviceToDeviceGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceDeviceToDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRecordPlan', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:CreateRecordPlan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetDeviceRecordLifeCycle', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'linkvisual:SetDeviceRecordLifeCycle', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryPictureFiles', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryPictureFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryFaceUser', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRecordUrlByTime', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordUrlByTime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRecordPlans', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordPlans', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRecordDownloadJobList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryRecordDownloadJobList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryFaceAllUserGroupAndDeviceGroupRelation', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceAllUserGroupAndDeviceGroupRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateInstanceInternetProtocol', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UpdateInstanceInternetProtocol', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryFaceAllUserGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFaceAllUserGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddFaceDeviceGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'linkvisual:AddFaceDeviceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryPictureSearchApps', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryPictureSearchApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryPictureSearchDevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'linkvisual:QueryPictureSearchDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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', - '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', ], + 'resourceTypes' => [], ], ]; diff --git a/data/en_us/linkvisual/2023-06-30/api-docs.php b/data/en_us/linkvisual/2023-06-30/api-docs.php index ca984f2..dfaf05f 100644 --- a/data/en_us/linkvisual/2023-06-30/api-docs.php +++ b/data/en_us/linkvisual/2023-06-30/api-docs.php @@ -1,65 +1,158 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Linkvisual', - 'version' => '2023-06-30', - ], + 'info' => ['style' => 'RPC', 'product' => 'Linkvisual', 'version' => '2023-06-30'], 'directories' => [ [ - 'id' => 352715, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'BindStorageOrder', - 'CheckFreeStorageValid', - 'ConsumeFreeStorage', - 'CreateAndPayStorageOrder', - 'EnableFreeStorage', - 'EnableStorageOrder', - 'FreezeFreeStorage', - 'GenerateDevice', - 'FreezeStorageOrder', - 'GenerateDeviceByBatchId', - 'QueryBatchStatus', - 'QueryDeviceDetail', - 'QueryFreeStorage', - 'QueryDevicesDownloadUrl', - 'QueryGenerateDevicesInfoList', - 'QueryGenerateDevicesRecord', - 'QueryStorageCommodityList', - 'QueryStorageOrder', - 'QueryStorageOrderList', - 'TransferStorageOrder', - 'UploadDeviceNameList', - 'GetThingEventSnapshot', - 'BatchBindDevice', - 'GetAccountById', - 'GetDeviceStatus', - 'GetSubDeviceList', - 'GetThingPropertySnapshot', - 'InvokeThingService', - 'ListBindingAccountByDevice', - 'ListBindingDeviceByAccount', - 'SetThingProperty', - 'UnbindAllUserByDevice', - 'UnbindDevice', + 'QueryDeviceDetail', 'QueryGenerateDevicesRecord', 'GetThingEventSnapshot', 'GetAccountById', 'GetDeviceStatus', 'GetSubDeviceList', 'GetThingPropertySnapshot', 'InvokeThingService', 'ListBindingAccountByDevice', 'SetThingProperty', 'BatchBindDevice', 'BindStorageOrder', 'CheckFreeStorageValid', 'ConsumeFreeStorage', 'CreateAndPayStorageOrder', 'EnableFreeStorage', 'EnableStorageOrder', 'FreezeFreeStorage', 'FreezeStorageOrder', 'GenerateDevice', + 'GenerateDeviceByBatchId', 'ListBindingDeviceByAccount', 'QueryBatchStatus', 'QueryDevicesDownloadUrl', 'QueryFreeStorage', 'QueryGenerateDevicesInfoList', 'QueryStorageCommodityList', 'QueryStorageOrder', 'QueryStorageOrderList', 'TransferStorageOrder', 'UnbindAllUserByDevice', 'UnbindDevice', 'UploadDeviceNameList', ], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'BindStorageOrder' => [ - 'methods' => [ - 'post', - 'get', + 'BatchBindDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'OpenId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'OpenIdAppKey', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'IdentityId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DeviceList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductKey' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'DeviceName' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 20, + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'BindDeviceList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'BindResultMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProductKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'BindResultCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.GetAccountInfoFailed', 'errorMessage' => 'Get account info failed.', 'description' => 'The system failed to query information about the account.'], + ['errorCode' => 'iot.vision.AccountNotFound', 'errorMessage' => 'Account not found.', 'description' => 'The account does not exist.'], + ['errorCode' => 'iot.vision.TenantMismatch', 'errorMessage' => 'Caller tenant and account belong tenant mismatch.', 'description' => 'The tenant of the API operation caller is different from the tenant to which the account belongs.'], + ['errorCode' => 'iot.vision.IdentityAppKeyProductNotBind', 'errorMessage' => 'The app associated with the identityId does not have permission to access the product.', 'description' => 'No product is associated with the AppKey that is related to the account.'], + ['errorCode' => 'iot.vision.BindFailed', 'errorMessage' => 'Bind account and device failed.', 'description' => 'The system failed to associate the account with the device.'], + ], + 403 => [ + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchBindDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:BatchBindDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"BindDeviceList\\": [\\n {\\n \\"BindResultMessage\\": \\"\\",\\n \\"ProductKey\\": \\"\\",\\n \\"BindResultCode\\": 0,\\n \\"DeviceName\\": \\"\\",\\n \\"IotId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'BindStorageOrder' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -70,104 +163,57 @@ [ 'name' => 'EventRecordDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '30', - 'minimum' => '0', - 'default' => '10', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '30', 'minimum' => '0', 'default' => '10', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'EventRecordProlong', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'UserName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'MaxRecordFileDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '3600', - 'minimum' => '600', - 'default' => '1800', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '600', 'default' => '1800', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'EnableDefaultPlan', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'PreRecordDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '5', - 'minimum' => '0', - 'default' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '5', 'minimum' => '0', 'default' => '0', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -175,160 +221,91 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Copies' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Specification' => [ - 'type' => 'string', - ], - 'RecordType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CommodityCode' => [ - 'type' => 'string', - ], - 'PreConsume' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'EndTimeUTC' => [ - 'type' => 'string', - ], - 'UserId' => [ - 'type' => 'string', - ], - 'IdentityId' => [ - 'type' => 'string', - ], - 'StartTimeUTC' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'OutOrderNo' => [ - 'type' => 'string', - ], - 'Price' => [ - 'type' => 'string', - ], - 'OrderType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PaymentStatus' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'UserName' => [ - 'type' => 'string', - ], - 'OrderId' => [ - 'type' => 'string', - ], - 'IotId' => [ - 'type' => 'string', - ], + 'Status' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Copies' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Specification' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RecordType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CommodityCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PreConsume' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'EndTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IdentityId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OutOrderNo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Price' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PaymentStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'UserName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNoOwner', - 'errorMessage' => 'Device has no owner.', - ], - [ - 'errorCode' => 'iot.vision.InvalidStorageOrder', - 'errorMessage' => 'Invalid storage order.', - ], - [ - 'errorCode' => 'iot.vision.DeviceOwnerChanged', - 'errorMessage' => 'Device owner changed.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderGetLockFailed', - 'errorMessage' => 'Get storage order lock failed try again later.', - ], - [ - 'errorCode' => 'iot.vision.GetOwnerIdentityInfoFailed', - 'errorMessage' => 'Get owner identity info failed.', - ], - [ - 'errorCode' => 'iot.vision.SetDefaultRecordPlanFailed', - 'errorMessage' => 'Set default record plan failed.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.DeviceNoOwner', 'errorMessage' => 'Device has no owner.', 'description' => 'Device has no owner.'], + ['errorCode' => 'iot.vision.InvalidStorageOrder', 'errorMessage' => 'Invalid storage order.', 'description' => 'Invalid storage order.'], + ['errorCode' => 'iot.vision.DeviceOwnerChanged', 'errorMessage' => 'Device owner changed.', 'description' => 'Device owner changed.'], + ['errorCode' => 'iot.vision.StorageOrderGetLockFailed', 'errorMessage' => 'Get storage order lock failed try again later.', 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['errorCode' => 'iot.vision.GetOwnerIdentityInfoFailed', 'errorMessage' => 'Get owner identity info failed.', 'description' => 'The system failed to query information about the device administrator.'], + ['errorCode' => 'iot.vision.SetDefaultRecordPlanFailed', 'errorMessage' => 'Set default record plan failed.', 'description' => 'The system failed to configure the default video recording plan.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindStorageOrder'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:BindStorageOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"Copies\\": 0,\\n \\"Specification\\": \\"\\",\\n \\"RecordType\\": 0,\\n \\"CommodityCode\\": \\"\\",\\n \\"PreConsume\\": 0,\\n \\"EndTimeUTC\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"IdentityId\\": \\"\\",\\n \\"StartTimeUTC\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"OutOrderNo\\": \\"\\",\\n \\"Price\\": \\"\\",\\n \\"OrderType\\": 0,\\n \\"PaymentStatus\\": 0,\\n \\"UserName\\": \\"\\",\\n \\"OrderId\\": \\"\\",\\n \\"IotId\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'CheckFreeStorageValid' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -339,26 +316,17 @@ [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -366,84 +334,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNoOwner', - 'errorMessage' => 'Device has no owner.', - ], - [ - 'errorCode' => 'iot.vision.FreeStorageQuotaLimit', - 'errorMessage' => 'No enough free storage quota or exceed limit.', - ], - [ - 'errorCode' => 'iot.vision.InvalidStorageCommodity', - 'errorMessage' => 'Invalid storage commodity.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], - [ - 'errorCode' => 'iot.vision.GetDeviceInfoFailed', - 'errorMessage' => 'Get device info failed.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.DeviceNoOwner', 'errorMessage' => 'Device has no owner.', 'description' => 'Device has no owner.'], + ['errorCode' => 'iot.vision.FreeStorageQuotaLimit', 'errorMessage' => 'No enough free storage quota or exceed limit.', 'description' => 'No enough free storage quota or exceed limit.'], + ['errorCode' => 'iot.vision.InvalidStorageCommodity', 'errorMessage' => 'Invalid storage commodity.', 'description' => 'Invalid storage commodity.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], + ['errorCode' => 'iot.vision.GetDeviceInfoFailed', 'errorMessage' => 'Get device info failed.', 'description' => 'The system failed to query the details of the device.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckFreeStorageValid'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CheckFreeStorageValid', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], 'ConsumeFreeStorage' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -454,88 +400,47 @@ [ 'name' => 'EventRecordProlong', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'EventRecordDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '30', - 'minimum' => '0', - 'default' => '10', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '30', 'minimum' => '0', 'default' => '10', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ImmediateUse', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'EnableDefaultPlan', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'PreRecordDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '5', - 'minimum' => '0', - 'default' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '5', 'minimum' => '0', 'default' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Quota', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -543,133 +448,77 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'type' => 'string', - ], - 'Type' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'EndTimeUTC' => [ - 'type' => 'string', - ], - 'Months' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Expired' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RemainQuota' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'StartTimeUTC' => [ - 'type' => 'string', - ], - 'Consumed' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Lifecycle' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Type' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Months' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Expired' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'RemainQuota' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'StartTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Consumed' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Lifecycle' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNoOwner', - 'errorMessage' => 'Device has no owner.', - ], - [ - 'errorCode' => 'iot.vision.FreeStorageQuotaLimit', - 'errorMessage' => 'No enough free storage quota or exceed limit.', - ], - [ - 'errorCode' => 'iot.vision.GetOwnerIdentityInfoFailed', - 'errorMessage' => 'Get owner identity info failed.', - ], - [ - 'errorCode' => 'iot.vision.GetDeviceInfoFailed', - 'errorMessage' => 'Get device info failed.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderGetLockFailed', - 'errorMessage' => 'Get storage order lock failed try again later.', - ], - [ - 'errorCode' => 'iot.vision.SetDefaultRecordPlanFailed', - 'errorMessage' => 'Set default record plan failed.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.DeviceNoOwner', 'errorMessage' => 'Device has no owner.', 'description' => 'Device has no owner.'], + ['errorCode' => 'iot.vision.FreeStorageQuotaLimit', 'errorMessage' => 'No enough free storage quota or exceed limit.', 'description' => 'No enough free storage quota or exceed limit.'], + ['errorCode' => 'iot.vision.GetOwnerIdentityInfoFailed', 'errorMessage' => 'Get owner identity info failed.', 'description' => 'The system failed to query information about the device administrator.'], + ['errorCode' => 'iot.vision.GetDeviceInfoFailed', 'errorMessage' => 'Get device info failed.', 'description' => 'The system failed to query the details of the device.'], + ['errorCode' => 'iot.vision.StorageOrderGetLockFailed', 'errorMessage' => 'Get storage order lock failed try again later.', 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['errorCode' => 'iot.vision.SetDefaultRecordPlanFailed', 'errorMessage' => 'Set default record plan failed.', 'description' => 'The system failed to configure the default video recording plan.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:ConsumeFreeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"EndTime\\": \\"\\",\\n \\"Type\\": 0,\\n \\"StartTime\\": \\"\\",\\n \\"EndTimeUTC\\": \\"\\",\\n \\"Months\\": 0,\\n \\"Expired\\": 0,\\n \\"RemainQuota\\": 0,\\n \\"StartTimeUTC\\": \\"\\",\\n \\"Consumed\\": 0,\\n \\"Lifecycle\\": 0\\n }\\n}","type":"json"}]', ], 'CreateAndPayStorageOrder' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -680,141 +529,77 @@ [ 'name' => 'DeviceNoOwner', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'EventRecordDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '30', - 'minimum' => '0', - 'default' => '10', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '30', 'minimum' => '0', 'default' => '10', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Copies', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100', - 'minimum' => '1', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'CommodityCode', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'EventRecordProlong', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Specification', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ImmediateUse', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'UserName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'MaxRecordFileDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '3600', - 'minimum' => '600', - 'default' => '1800', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '600', 'default' => '1800', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'EnableDefaultPlan', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'PreRecordDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '5', - 'minimum' => '0', - 'default' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '5', 'minimum' => '0', 'default' => '0', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -822,184 +607,97 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Copies' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Specification' => [ - 'type' => 'string', - ], - 'RecordType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CommodityCode' => [ - 'type' => 'string', - ], - 'PreConsume' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'EndTimeUTC' => [ - 'type' => 'string', - ], - 'UserId' => [ - 'type' => 'string', - ], - 'IdentityId' => [ - 'type' => 'string', - ], - 'StartTimeUTC' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'OutOrderNo' => [ - 'type' => 'string', - ], - 'Price' => [ - 'type' => 'string', - ], - 'OrderType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PaymentStatus' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'UserName' => [ - 'type' => 'string', - ], - 'OrderId' => [ - 'type' => 'string', - ], - 'IotId' => [ - 'type' => 'string', - ], + 'Status' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Copies' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Specification' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RecordType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CommodityCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PreConsume' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'EndTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IdentityId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OutOrderNo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Price' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PaymentStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'UserName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNoOwner', - 'errorMessage' => 'Device has no owner.', - ], - [ - 'errorCode' => 'iot.vision.CreateStorageOrderFailed', - 'errorMessage' => 'Create storage order failed.', - ], - [ - 'errorCode' => 'iot.vision.GetDeviceInfoFailed', - 'errorMessage' => 'Get device info failed.', - ], - [ - 'errorCode' => 'iot.vision.InvalidStorageCommodity', - 'errorMessage' => 'Invalid storage commodity.', - ], - [ - 'errorCode' => 'iot.vision.StorageCommodityUnavailable', - 'errorMessage' => 'Storage commodity unavailable.', - ], - [ - 'errorCode' => 'iot.vision.GetOwnerIdentityInfoFailed', - 'errorMessage' => 'Get owner identity info failed.', - ], - [ - 'errorCode' => 'iot.vision.SetDefaultRecordPlanFailed', - 'errorMessage' => 'Set default record plan failed.', - ], - [ - 'errorCode' => 'iot.vision.QueryCommodityPriceFailed', - 'errorMessage' => 'Query commodity price failed.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderGetLockFailed', - 'errorMessage' => 'Get storage order lock failed try again later.', - ], - [ - 'errorCode' => 'iot.vision.InvalidStorageOrder', - 'errorMessage' => 'Invalid storage order.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderAlreadyPaid', - 'errorMessage' => 'Storage order had been paid.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderPayFailed', - 'errorMessage' => 'Storage order pay failed.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.DeviceNoOwner', 'errorMessage' => 'Device has no owner.', 'description' => 'Device has no owner.'], + ['errorCode' => 'iot.vision.CreateStorageOrderFailed', 'errorMessage' => 'Create storage order failed.', 'description' => 'Create storage order failed.'], + ['errorCode' => 'iot.vision.GetDeviceInfoFailed', 'errorMessage' => 'Get device info failed.', 'description' => 'The system failed to query the details of the device.'], + ['errorCode' => 'iot.vision.InvalidStorageCommodity', 'errorMessage' => 'Invalid storage commodity.', 'description' => 'Invalid storage commodity.'], + ['errorCode' => 'iot.vision.StorageCommodityUnavailable', 'errorMessage' => 'Storage commodity unavailable.', 'description' => 'You cannot use the cloud storage product.'], + ['errorCode' => 'iot.vision.GetOwnerIdentityInfoFailed', 'errorMessage' => 'Get owner identity info failed.', 'description' => 'The system failed to query information about the device administrator.'], + ['errorCode' => 'iot.vision.SetDefaultRecordPlanFailed', 'errorMessage' => 'Set default record plan failed.', 'description' => 'The system failed to configure the default video recording plan.'], + ['errorCode' => 'iot.vision.QueryCommodityPriceFailed', 'errorMessage' => 'Query commodity price failed.', 'description' => 'The system failed to query the price of the cloud storage product.'], + ['errorCode' => 'iot.vision.StorageOrderGetLockFailed', 'errorMessage' => 'Get storage order lock failed try again later.', 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['errorCode' => 'iot.vision.InvalidStorageOrder', 'errorMessage' => 'Invalid storage order.', 'description' => 'Invalid storage order.'], + ['errorCode' => 'iot.vision.StorageOrderAlreadyPaid', 'errorMessage' => 'Storage order had been paid.', 'description' => 'The payment for the cloud storage order is complete.'], + ['errorCode' => 'iot.vision.StorageOrderPayFailed', 'errorMessage' => 'Storage order pay failed.', 'description' => 'The payment for the cloud storage order failed.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAndPayStorageOrder'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateAndPayStorageOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"Copies\\": 0,\\n \\"Specification\\": \\"\\",\\n \\"RecordType\\": 0,\\n \\"CommodityCode\\": \\"\\",\\n \\"PreConsume\\": 0,\\n \\"EndTimeUTC\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"IdentityId\\": \\"\\",\\n \\"StartTimeUTC\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"OutOrderNo\\": \\"\\",\\n \\"Price\\": \\"\\",\\n \\"OrderType\\": 0,\\n \\"PaymentStatus\\": 0,\\n \\"UserName\\": \\"\\",\\n \\"OrderId\\": \\"\\",\\n \\"IotId\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'EnableFreeStorage' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1010,26 +708,17 @@ [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -1037,125 +726,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'type' => 'string', - ], - 'Type' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'EndTimeUTC' => [ - 'type' => 'string', - ], - 'Months' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Expired' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RemainQuota' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'StartTimeUTC' => [ - 'type' => 'string', - ], - 'Consumed' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Lifecycle' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Type' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Months' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Expired' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'RemainQuota' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'StartTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Consumed' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Lifecycle' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNoOwner', - 'errorMessage' => 'Device has no owner.', - ], - [ - 'errorCode' => 'iot.vision.FreeStorageQuotaLimit', - 'errorMessage' => 'No enough free storage quota or exceed limit.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderGetLockFailed', - 'errorMessage' => 'Get storage order lock failed try again later.', - ], - [ - 'errorCode' => 'iot.vision.InvalidStorageOrder', - 'errorMessage' => 'Invalid storage order.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.DeviceNoOwner', 'errorMessage' => 'Device has no owner.', 'description' => 'Device has no owner.'], + ['errorCode' => 'iot.vision.FreeStorageQuotaLimit', 'errorMessage' => 'No enough free storage quota or exceed limit.', 'description' => 'No enough free storage quota or exceed limit.'], + ['errorCode' => 'iot.vision.StorageOrderGetLockFailed', 'errorMessage' => 'Get storage order lock failed try again later.', 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['errorCode' => 'iot.vision.InvalidStorageOrder', 'errorMessage' => 'Invalid storage order.', 'description' => 'Invalid storage order.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableFreeStorage'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:EnableFreeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"EndTime\\": \\"\\",\\n \\"Type\\": 0,\\n \\"StartTime\\": \\"\\",\\n \\"EndTimeUTC\\": \\"\\",\\n \\"Months\\": 0,\\n \\"Expired\\": 0,\\n \\"RemainQuota\\": 0,\\n \\"StartTimeUTC\\": \\"\\",\\n \\"Consumed\\": 0,\\n \\"Lifecycle\\": 0\\n }\\n}","type":"json"}]', ], 'EnableStorageOrder' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1166,34 +810,22 @@ [ 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -1201,156 +833,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Copies' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Specification' => [ - 'type' => 'string', - ], - 'RecordType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CommodityCode' => [ - 'type' => 'string', - ], - 'PreConsume' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'EndTimeUTC' => [ - 'type' => 'string', - ], - 'UserId' => [ - 'type' => 'string', - ], - 'IdentityId' => [ - 'type' => 'string', - ], - 'StartTimeUTC' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'OutOrderNo' => [ - 'type' => 'string', - ], - 'Price' => [ - 'type' => 'string', - ], - 'OrderType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PaymentStatus' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'UserName' => [ - 'type' => 'string', - ], - 'OrderId' => [ - 'type' => 'string', - ], - 'IotId' => [ - 'type' => 'string', - ], + 'Status' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Copies' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Specification' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RecordType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CommodityCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PreConsume' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'EndTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IdentityId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OutOrderNo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Price' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PaymentStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'UserName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNoOwner', - 'errorMessage' => 'Device has no owner.', - ], - [ - 'errorCode' => 'iot.vision.InvalidStorageOrder', - 'errorMessage' => 'Invalid storage order.', - ], - [ - 'errorCode' => 'iot.vision.DeviceOwnerChanged', - 'errorMessage' => 'Device owner changed.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderGetLockFailed', - 'errorMessage' => 'Get storage order lock failed try again later.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderStatusInvalid', - 'errorMessage' => 'Storage order status invalid.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.DeviceNoOwner', 'errorMessage' => 'Device has no owner.', 'description' => 'Device has no owner.'], + ['errorCode' => 'iot.vision.InvalidStorageOrder', 'errorMessage' => 'Invalid storage order.', 'description' => 'Invalid storage order.'], + ['errorCode' => 'iot.vision.DeviceOwnerChanged', 'errorMessage' => 'Device owner changed.', 'description' => 'Device owner changed.'], + ['errorCode' => 'iot.vision.StorageOrderGetLockFailed', 'errorMessage' => 'Get storage order lock failed try again later.', 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['errorCode' => 'iot.vision.StorageOrderStatusInvalid', 'errorMessage' => 'Storage order status invalid.', 'description' => 'You cannot perform the operation on the cloud storage order.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableStorageOrder'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:EnableStorageOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"Copies\\": 0,\\n \\"Specification\\": \\"\\",\\n \\"RecordType\\": 0,\\n \\"CommodityCode\\": \\"\\",\\n \\"PreConsume\\": 0,\\n \\"EndTimeUTC\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"IdentityId\\": \\"\\",\\n \\"StartTimeUTC\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"OutOrderNo\\": \\"\\",\\n \\"Price\\": \\"\\",\\n \\"OrderType\\": 0,\\n \\"PaymentStatus\\": 0,\\n \\"UserName\\": \\"\\",\\n \\"OrderId\\": \\"\\",\\n \\"IotId\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'FreezeFreeStorage' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1361,26 +927,17 @@ [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -1388,239 +945,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'type' => 'string', - ], - 'Type' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'EndTimeUTC' => [ - 'type' => 'string', - ], - 'Months' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Expired' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RemainQuota' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'StartTimeUTC' => [ - 'type' => 'string', - ], - 'Consumed' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Lifecycle' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Type' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Months' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Expired' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'RemainQuota' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'StartTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Consumed' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Lifecycle' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNoOwner', - 'errorMessage' => 'Device has no owner.', - ], - [ - 'errorCode' => 'iot.vision.FreeStorageQuotaLimit', - 'errorMessage' => 'No enough free storage quota or exceed limit.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderGetLockFailed', - 'errorMessage' => 'Get storage order lock failed try again later.', - ], - [ - 'errorCode' => 'iot.vision.InvalidStorageOrder', - 'errorMessage' => 'Invalid storage order.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.DeviceNoOwner', 'errorMessage' => 'Device has no owner.', 'description' => 'Device has no owner.'], + ['errorCode' => 'iot.vision.FreeStorageQuotaLimit', 'errorMessage' => 'No enough free storage quota or exceed limit.', 'description' => 'No enough free storage quota or exceed limit.'], + ['errorCode' => 'iot.vision.StorageOrderGetLockFailed', 'errorMessage' => 'Get storage order lock failed try again later.', 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['errorCode' => 'iot.vision.InvalidStorageOrder', 'errorMessage' => 'Invalid storage order.', 'description' => 'Invalid storage order.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - ], - 'GenerateDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FreezeFreeStorage'], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'Amount', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '10000', - 'minimum' => '1', - ], - ], - [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], + 'ramActions' => [ [ - 'name' => 'ProjectId', - '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' => [ - 'BatchId' => [ - 'type' => 'string', - ], - ], - ], + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:FreezeFreeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.ActiveCodeInsufficient', - 'errorMessage' => 'Active code quota is insufficient.', - ], - [ - 'errorCode' => 'iot.vision.DevicesCountExceedLimit', - 'errorMessage' => 'The devices count exceed the limit.', - ], - [ - 'errorCode' => 'iot.vision.DevicesExceedUnreleasedProductLimit', - 'errorMessage' => 'Devices count exceed the limit of unreleased product.', - ], - ], - 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' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"EndTime\\": \\"\\",\\n \\"Type\\": 0,\\n \\"StartTime\\": \\"\\",\\n \\"EndTimeUTC\\": \\"\\",\\n \\"Months\\": 0,\\n \\"Expired\\": 0,\\n \\"RemainQuota\\": 0,\\n \\"StartTimeUTC\\": \\"\\",\\n \\"Consumed\\": 0,\\n \\"Lifecycle\\": 0\\n }\\n}","type":"json"}]', ], 'FreezeStorageOrder' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1631,43 +1029,27 @@ [ 'name' => 'DeviceNoOwner', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -1675,152 +1057,89 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Copies' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Specification' => [ - 'type' => 'string', - ], - 'RecordType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CommodityCode' => [ - 'type' => 'string', - ], - 'PreConsume' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'EndTimeUTC' => [ - 'type' => 'string', - ], - 'UserId' => [ - 'type' => 'string', - ], - 'IdentityId' => [ - 'type' => 'string', - ], - 'StartTimeUTC' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'OutOrderNo' => [ - 'type' => 'string', - ], - 'Price' => [ - 'type' => 'string', - ], - 'OrderType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PaymentStatus' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'UserName' => [ - 'type' => 'string', - ], - 'OrderId' => [ - 'type' => 'string', - ], - 'IotId' => [ - 'type' => 'string', - ], + 'Status' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Copies' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Specification' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RecordType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CommodityCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PreConsume' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'EndTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IdentityId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OutOrderNo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Price' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PaymentStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'UserName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNoOwner', - 'errorMessage' => 'Device has no owner.', - ], - [ - 'errorCode' => 'iot.vision.DeviceOwnerChanged', - 'errorMessage' => 'Device owner changed.', - ], - [ - 'errorCode' => 'iot.vision.InvalidStorageOrder', - 'errorMessage' => 'Invalid storage order.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderGetLockFailed', - 'errorMessage' => 'Get storage order lock failed try again later.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.DeviceNoOwner', 'errorMessage' => 'Device has no owner.', 'description' => 'Device has no owner.'], + ['errorCode' => 'iot.vision.DeviceOwnerChanged', 'errorMessage' => 'Device owner changed.', 'description' => 'Device owner changed.'], + ['errorCode' => 'iot.vision.InvalidStorageOrder', 'errorMessage' => 'Invalid storage order.', 'description' => 'Invalid storage order.'], + ['errorCode' => 'iot.vision.StorageOrderGetLockFailed', 'errorMessage' => 'Get storage order lock failed try again later.', 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - ], - 'GenerateDeviceByBatchId' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FreezeStorageOrder'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:FreezeStorageOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"Copies\\": 0,\\n \\"Specification\\": \\"\\",\\n \\"RecordType\\": 0,\\n \\"CommodityCode\\": \\"\\",\\n \\"PreConsume\\": 0,\\n \\"EndTimeUTC\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"IdentityId\\": \\"\\",\\n \\"StartTimeUTC\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"OutOrderNo\\": \\"\\",\\n \\"Price\\": \\"\\",\\n \\"OrderType\\": 0,\\n \\"PaymentStatus\\": 0,\\n \\"UserName\\": \\"\\",\\n \\"OrderId\\": \\"\\",\\n \\"IotId\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GenerateDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1829,28 +1148,19 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'BatchId', + 'name' => 'Amount', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '10000', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -1858,96 +1168,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ - 'BatchId' => [ - 'type' => 'string', - ], + 'BatchId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.ParamBatchIdInvalid', - 'errorMessage' => 'Parameter batchId is invalid.', - ], - [ - 'errorCode' => 'iot.vision.BatchHasCreated', - 'errorMessage' => 'This batch task has been created.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNameChecking', - 'errorMessage' => 'Device names are checking.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNameCheckFailed', - 'errorMessage' => 'Device names check failed.', - ], - [ - 'errorCode' => 'iot.vision.ActiveCodeInsufficient', - 'errorMessage' => 'Active code quota is insufficient.', - ], - [ - 'errorCode' => 'iot.vision.DevicesCountExceedLimit', - 'errorMessage' => 'The devices count exceed the limit.', - ], - [ - 'errorCode' => 'iot.vision.DevicesExceedUnreleasedProductLimit', - 'errorMessage' => 'Devices count exceed the limit of unreleased product.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.ActiveCodeInsufficient', 'errorMessage' => 'Active code quota is insufficient.', 'description' => ''], + ['errorCode' => 'iot.vision.DevicesCountExceedLimit', 'errorMessage' => 'The devices count exceed the limit.', 'description' => 'The devices count exceed the limit.'], + ['errorCode' => 'iot.vision.DevicesExceedUnreleasedProductLimit', 'errorMessage' => 'Devices count exceed the limit of unreleased product.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - ], - 'QueryBatchStatus' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GenerateDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"BatchId\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GenerateDeviceByBatchId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1958,26 +1240,17 @@ [ 'name' => 'BatchId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -1985,94 +1258,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'type' => 'string', - ], - 'InvalidDetailList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DeviceName' => [ - 'type' => 'string', - ], - 'ErrorMsg' => [ - 'type' => 'string', - ], - ], - ], - ], - 'InvalidList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'ValidList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], + 'BatchId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.ParamBatchIdInvalid', 'errorMessage' => 'Parameter batchId is invalid.', 'description' => 'Parameter batchId is invalid.'], + ['errorCode' => 'iot.vision.BatchHasCreated', 'errorMessage' => 'This batch task has been created.', 'description' => 'This batch task has been created.'], + ['errorCode' => 'iot.vision.DeviceNameChecking', 'errorMessage' => 'Device names are checking.', 'description' => ''], + ['errorCode' => 'iot.vision.DeviceNameCheckFailed', 'errorMessage' => 'Device names check failed.', 'description' => 'Device names check failed.'], + ['errorCode' => 'iot.vision.ActiveCodeInsufficient', 'errorMessage' => 'Active code quota is insufficient.', 'description' => ''], + ['errorCode' => 'iot.vision.DevicesCountExceedLimit', 'errorMessage' => 'The devices count exceed the limit.', 'description' => 'The devices count exceed the limit.'], + ['errorCode' => 'iot.vision.DevicesExceedUnreleasedProductLimit', 'errorMessage' => 'Devices count exceed the limit of unreleased product.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - ], - 'QueryDeviceDetail' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateDeviceByBatchId'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GenerateDeviceByBatchId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"BatchId\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetAccountById' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2081,44 +1332,27 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1Bw******', - ], - ], - [ - 'name' => 'DeviceName', + 'name' => 'OpenId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Device01', - ], + 'schema' => ['description' => 'The third-party platform user ID.'."\n" + .'><notice> If you specify this parameter, you must also specify **OpenIdAppKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => '60yqjd1**************************561da00851', 'title' => ''], ], [ - 'name' => 'IotId', + 'name' => 'OpenIdAppKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'schema' => ['description' => 'The AppKey issued by the third-party platform.'."\n" + ."\n" + .'><notice> If you specify this parameter, you must also specify **OpenId**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => '76****57', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'IdentityId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'a123qs*****sy4QU', - ], + 'schema' => ['description' => 'The user identity ID.'."\n" + ."\n" + .'><notice> **IdentityId** serves as the user identifier and has a one-to-one mapping with the combination of **OpenId** and **OpenIdAppKey**. If you specify this parameter, you do not need to specify **OpenId** or **OpenIdAppKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => '5035op97******************a63994', 'title' => ''], ], ], 'responses' => [ @@ -2126,184 +1360,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see **Error codes** in this topic.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Unexpected internal error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The data returned if the call is successful.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ONLINE', - ], - 'ProductName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'DeviceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Device01', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1834500000000', - ], - 'FirmwareVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'V1.0.0.0', - ], - 'OnlineTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2298700000000', - ], - 'ActiveTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1934500000000', - ], - 'ProductKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'a1Bw******', - ], - 'IpAddress' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.***.***.***', - ], - 'NodeType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'DeviceSecret' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mz2Canp4GB7qRVf1OYPNtRqB2anu****', - ], - 'Nickname' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'detectors_in_beijing', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'LoginName' => ['description' => 'The logon name of the account.', 'type' => 'string', 'example' => '18*******20', 'title' => ''], + 'Email' => ['description' => 'The email address.', 'type' => 'string', 'example' => '******', 'title' => ''], + 'IdentityId' => ['description' => 'The user identity ID.', 'type' => 'string', 'example' => '5035op97******************a63994', 'title' => ''], + 'LastLoginTime' => ['description' => 'The last logon time, in the format of a 13-digit millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1700209499000', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the account was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1700189358000', 'title' => ''], + 'NickName' => ['description' => 'The nickname of the user.', 'type' => 'string', 'example' => '18*******20', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the account was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1700209499000', 'title' => ''], + 'Phone' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '18*******20', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.InvalidIotInstance', - 'errorMessage' => 'Invalid iot instance.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], - [ - 'errorCode' => 'iot.vision.ProductNotExist', - 'errorMessage' => 'Product not exist.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNameFormatInvalid', - 'errorMessage' => 'Device name format invalid.', - ], - [ - 'errorCode' => 'iot.vision.InstanceArrearage', - 'errorMessage' => 'Instance arrearage.', - ], - [ - 'errorCode' => 'iot.vision.ProductKeyFormatInvalid', - 'errorMessage' => 'Product key format invalid.', - ], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.GetAccountInfoFailed', 'errorMessage' => 'Get account info failed.', 'description' => 'The system failed to query information about the account.'], + ['errorCode' => 'iot.vision.AccountNotFound', 'errorMessage' => 'Account not found.', 'description' => 'The account does not exist.'], + ['errorCode' => 'iot.vision.TenantMismatch', 'errorMessage' => 'Caller tenant and account belong tenant mismatch.', 'description' => 'The tenant of the API operation caller is different from the tenant to which the account belongs.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], - [ - 'errorCode' => 'iot.vision.HasNoAccessPermission', - 'errorMessage' => 'Has no access permission.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => '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 \\"Status\\": \\"ONLINE\\",\\n \\"ProductName\\": \\"test\\",\\n \\"DeviceName\\": \\"Device01\\",\\n \\"CreateTime\\": 1834500000000,\\n \\"FirmwareVersion\\": \\"V1.0.0.0\\",\\n \\"OnlineTime\\": 2298700000000,\\n \\"ActiveTime\\": 1934500000000,\\n \\"ProductKey\\": \\"a1Bw******\\",\\n \\"IpAddress\\": \\"10.***.***.***\\",\\n \\"NodeType\\": 0,\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"DeviceSecret\\": \\"mz2Canp4GB7qRVf1OYPNtRqB2anu****\\",\\n \\"Nickname\\": \\"detectors_in_beijing\\",\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryDeviceDetailResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <Status>ONLINE</Status>\\n <ProductName>test</ProductName>\\n <DeviceSecret>mz2Canp4GB7qRVf1OYPNtRqB2anu****</DeviceSecret>\\n <CreateTime>1834500000000</CreateTime>\\n <OnlineTime>2298700000000</OnlineTime>\\n <FirmwareVersion>V1.0.0.0</FirmwareVersion>\\n <IotId>C47T6xwp6ms4bNlkHRWCg4****</IotId>\\n <ActiveTime>1934500000000</ActiveTime>\\n <NodeType>0</NodeType>\\n <Region>cn-shanghai</Region>\\n <IpAddress>10.***.***.***</IpAddress>\\n <ProductKey>a1Bw******</ProductKey>\\n <Nickname>detectors_in_beijing</Nickname>\\n <DeviceName>Device01</DeviceName>\\n</Data>\\n<Success>true</Success>\\n</QueryDeviceDetailResponse>","errorExample":""}]', - 'title' => 'QueryDeviceDetail', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unexpected internal error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LoginName\\": \\"18*******20\\",\\n \\"Email\\": \\"******\\",\\n \\"IdentityId\\": \\"5035op97******************a63994\\",\\n \\"LastLoginTime\\": 1700209499000,\\n \\"GmtCreate\\": 1700189358000,\\n \\"NickName\\": \\"18*******20\\",\\n \\"GmtModified\\": 1700209499000,\\n \\"Phone\\": \\"18*******20\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetAccountById', + 'summary' => 'Queries user account information by user identity ID (IdentityId) or third-party platform user ID (OpenId).', + 'description' => '## QPS limit'."\n" + ."\n" + .'The maximum queries per second (QPS) per Alibaba Cloud account for invoking this operation is 50.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under a single Alibaba Cloud account share the quota of that account.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common request parameters when you call this API operation.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryFreeStorage' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountById'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GetAccountById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetDeviceStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2314,26 +1451,26 @@ [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the video device belongs.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1Bw******', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the video device.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'Device01', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the video device.'."\n" + .'><notice>'."\n" + .'**IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], ], 'responses' => [ @@ -2341,210 +1478,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see **Error codes** in this topic.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Unexpected internal error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ + 'description' => 'The data returned if the call was successful.', 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'type' => 'string', - ], - 'Type' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'EndTimeUTC' => [ - 'type' => 'string', - ], - 'Months' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Expired' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RemainQuota' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'StartTimeUTC' => [ - 'type' => 'string', - ], - 'Consumed' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Lifecycle' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'Status' => ['description' => 'The current status of the device. Valid values:'."\n" + ."\n" + .'- **ONLINE**: The device is online.'."\n" + .'- **OFFLINE**: The device is offline.'."\n" + .'- **UNACTIVE**: The device is not activated.'."\n" + .'- **DISABLE**: The device is disabled.', 'type' => 'string', 'example' => 'ONLINE', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNoOwner', - 'errorMessage' => 'Device has no owner.', - ], - [ - 'errorCode' => 'iot.vision.FreeStorageQuotaLimit', - 'errorMessage' => 'No enough free storage quota or exceed limit.', - ], - [ - 'errorCode' => 'iot.vision.GetDeviceInfoFailed', - 'errorMessage' => 'Get device info failed.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderGetLockFailed', - 'errorMessage' => 'Get storage order lock failed try again later.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.InvalidIotInstance', 'errorMessage' => 'Invalid iot instance.', 'description' => 'Invalid iot instance.'], + ['errorCode' => 'iot.vision.ProductNotExist', 'errorMessage' => 'Product not exist.', 'description' => 'Product not exist.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], + ['errorCode' => 'iot.vision.InstanceArrearage', 'errorMessage' => 'Instance arrearage.', 'description' => 'Instance arrearage.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ['errorCode' => 'iot.vision.HasNoAccessPermission', 'errorMessage' => 'Has no access permission.', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - ], - 'QueryDevicesDownloadUrl' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unexpected internal error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": \\"ONLINE\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetDeviceStatus', + 'summary' => 'Queries the status of a device.', + 'description' => '## QPS limit'."\n" + ."\n" + .'You can invoke this operation up to 50 times per second per Alibaba Cloud account.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users within an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeviceStatus'], ], ], - 'systemTags' => [], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'BatchId', - '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' => [ - 'OssDownloadUrl' => [ - 'type' => 'string', - ], - ], - ], + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GetDeviceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'iot.system.SystemException', - 'errorMessage' => 'An internal error occurred. Try again later.', - ], - [ - 'errorCode' => 'iot.common.AuthActionPermissionDeny', - 'errorMessage' => 'The authorization fails.', - ], - ], - 403 => [ - [ - 'errorCode' => 'iot.lv.requestAuthError', - 'errorMessage' => 'Request auth error.', - ], - [ - 'errorCode' => 'iot.lv.requestParamError', - 'errorMessage' => 'Request parameter error.', - ], - ], - ], ], - 'QueryGenerateDevicesInfoList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSubDeviceList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2555,40 +1569,36 @@ [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '50', - 'minimum' => '1', - ], + 'schema' => ['description' => 'The number of records per page in the response. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '5', 'title' => ''], ], [ - 'name' => 'BatchId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the gateway device belongs.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1Bw******', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '1000', - 'minimum' => '1', - ], + 'schema' => ['description' => 'The name of the gateway device.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'Device01', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The ID of the gateway device.'."\n" + .'><notice>'."\n" + .'**IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number to return. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -2596,102 +1606,101 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see **Error codes** in this topic.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request parameter error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ + 'description' => 'The data returned if the call was successful.', 'type' => 'object', 'properties' => [ - 'PageNo' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PageSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Total' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ListData' => [ + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SubDeviceList' => [ + 'description' => 'The list of sub-devices.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DeviceName' => [ - 'type' => 'string', - ], - 'IotId' => [ - 'type' => 'string', - ], - 'DeviceSecret' => [ - 'type' => 'string', - ], + 'ProductKey' => ['description' => 'The **ProductKey** of the product to which the device belongs.', 'type' => 'string', 'example' => 'wse5******', 'title' => ''], + 'DeviceName' => ['description' => 'The name of the device.', 'type' => 'string', 'example' => 'device-test', 'title' => ''], + 'IotId' => ['description' => 'The ID of the device.', 'type' => 'string', 'example' => 'qswdfrttgg*********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.common.RamActionPermissionDeny', - 'errorMessage' => 'You do not have the RAM permission.', - ], - [ - 'errorCode' => 'iot.vision.ProductNotExist', - 'errorMessage' => 'Product not exist.', - ], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.InvalidIotInstance', 'errorMessage' => 'Invalid iot instance.', 'description' => 'Invalid iot instance.'], + ['errorCode' => 'iot.vision.ProductNotExist', 'errorMessage' => 'Product not exist.', 'description' => 'Product not exist.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], + ['errorCode' => 'iot.vision.InstanceArrearage', 'errorMessage' => 'Instance arrearage.', 'description' => 'Instance arrearage.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ['errorCode' => 'iot.vision.HasNoAccessPermission', 'errorMessage' => 'Has no access permission.', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - ], - 'QueryGenerateDevicesRecord' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 1,\\n \\"Total\\": 1,\\n \\"SubDeviceList\\": [\\n {\\n \\"ProductKey\\": \\"wse5******\\",\\n \\"DeviceName\\": \\"device-test\\",\\n \\"IotId\\": \\"qswdfrttgg*********\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetSubDeviceList', + 'summary' => 'Queries the list of sub-devices for a gateway device.', + 'description' => '## QPS limit'."\n" + ."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account for invoking this operation is 50.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must specify common parameters when you call this operation.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubDeviceList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GetSubDeviceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetThingEventSnapshot' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2700,56 +1709,33 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'Identifier', + 'in' => 'query', + 'schema' => ['description' => 'The event identifier of the thing model.', 'type' => 'string', 'required' => true, 'example' => 'AlarmType', 'title' => ''], ], [ - 'name' => 'PageNo', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => ['description' => 'The **ProductKey** of the product to which the video device belongs.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1Bw******', 'title' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9999999999999', - 'minimum' => '1', - 'example' => '1690819200000', - ], + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the video device.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'Device01', 'title' => ''], ], [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9999999999999', - 'minimum' => '1', - 'example' => '1659283200000', - ], + 'name' => 'IotId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the video device.'."\n" + .'><notice>'."\n" + .'**IotId** is a globally unique identifier of the device and corresponds one-to-one with the combination of **ProductKey** and **DeviceName**. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], ], 'responses' => [ @@ -2757,261 +1743,207 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '400', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Request parameter error.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E5******-4***-***B-8**E-D3********65', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see **Error codes** in this topic.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Unexpected internal error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'ListData' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ApplyDeviceCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '133', - ], - 'SpecCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Consumer_IPC_512Kbps', - ], - 'ProductKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'a3w******', - ], - 'ProductName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1690819200000', - ], - 'BatchStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CREATE', - ], - 'NetworkType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'WIFI', - ], - 'OperateUid' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '110000000000', - ], - 'SuccessCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'BatchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1508******195', - ], - ], - ], - ], + 'description' => 'The data returned if the call is successful.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventType' => ['description' => 'The event type. Valid values:'."\n" + ."\n" + .'- **info**: information.'."\n" + .'- **alert**: alert.'."\n" + .'- **error**: fault.', 'type' => 'string', 'example' => 'alert', 'title' => ''], + 'EventCode' => ['description' => 'The event code.', 'type' => 'string', 'example' => 'IntelligentAlarm', 'title' => ''], + 'Identifier' => ['description' => 'The event identifier.', 'type' => 'string', 'example' => 'IntelligentAlarm', 'title' => ''], + 'Timestamp' => ['description' => 'The timestamp when the event occurred. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1700010288668', 'title' => ''], + 'EventBody' => ['description' => 'The event content.', 'type' => 'string', 'example' => '{\\"EventList \\":[{\\"AlarmPicID \\":\\"\\",\\"EventTime \\":\\"1700010288542 \\",\\"AlarmType \\":1,\\"AlarmPicSize \\":1,\\"Data \\":\\"test \\"}]}', 'title' => ''], + 'IotId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.InvalidIotInstance', 'errorMessage' => 'Invalid iot instance.', 'description' => 'Invalid iot instance.'], + ['errorCode' => 'iot.vision.ProductNotExist', 'errorMessage' => 'Product not exist.', 'description' => 'Product not exist.'], + ['errorCode' => 'iot.vision.ThingModelNotExist', 'errorMessage' => 'Thing model not exist.', 'description' => 'Thing model not exist.'], + ['errorCode' => 'iot.vision.ThingModelIdentifierNotExist', 'errorMessage' => 'Thing model identifier not exist.', 'description' => 'Thing model identifier not exist.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], + ['errorCode' => 'iot.vision.InstanceArrearage', 'errorMessage' => 'Instance arrearage.', 'description' => 'Instance arrearage.'], + ['errorCode' => 'iot.vision.GetThingEventSnapshotFailed', 'errorMessage' => 'Get thing event snapshot failed.', 'description' => 'The system failed to query TSL event snapshots.'], + ['errorCode' => 'iot.vision.ThingEventNotFound', 'errorMessage' => 'Thing event not found.', 'description' => 'The TSL event does not exist.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ['errorCode' => 'iot.vision.HasNoAccessPermission', 'errorMessage' => 'Has no access permission.', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E5******-4***-***B-8**E-D3********65\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 1,\\n \\"Total\\": 5,\\n \\"ListData\\": [\\n {\\n \\"ApplyDeviceCount\\": 133,\\n \\"SpecCode\\": \\"Consumer_IPC_512Kbps\\",\\n \\"ProductKey\\": \\"a3w******\\",\\n \\"ProductName\\": \\"电饭煲\\",\\n \\"CreateTime\\": 1690819200000,\\n \\"BatchStatus\\": \\"CREATE\\",\\n \\"NetworkType\\": \\"WIFI\\",\\n \\"OperateUid\\": 110000000000,\\n \\"SuccessCount\\": 5,\\n \\"BatchId\\": \\"1508******195\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryGenerateDevicesRecordResponse>\\n<RequestId>E5******-4***-***B-8**E-D3********65</RequestId>\\n<Data>\\n <PageSize>1</PageSize>\\n <Total>5</Total>\\n <PageNo>1</PageNo>\\n <ListData>\\n <SpecCode>Consumer_IPC_512Kbps</SpecCode>\\n <OperateUid>110000000000</OperateUid>\\n <ProductName>电饭煲</ProductName>\\n <NetworkType>WIFI</NetworkType>\\n <BatchStatus>CREATE</BatchStatus>\\n <CreateTime>1690819200000</CreateTime>\\n <BatchId>1508******195</BatchId>\\n <SuccessCount>5</SuccessCount>\\n <ProductKey>a3w******</ProductKey>\\n <ApplyDeviceCount>133</ApplyDeviceCount>\\n </ListData>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</QueryGenerateDevicesRecordResponse>","errorExample":""}]', - 'title' => 'QueryGenerateDevicesRecord', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unexpected internal error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EventType\\": \\"alert\\",\\n \\"EventCode\\": \\"IntelligentAlarm\\",\\n \\"Identifier\\": \\"IntelligentAlarm\\",\\n \\"Timestamp\\": 1700010288668,\\n \\"EventBody\\": \\"{\\\\\\\\\\\\\\"EventList \\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"AlarmPicID \\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EventTime \\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1700010288542 \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AlarmType \\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"AlarmPicSize \\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"Data \\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test \\\\\\\\\\\\\\"}]}\\",\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query thing model event snapshot', + 'description' => '## QPS limit'."\n" + ."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account is 50.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common parameters when you call this operation.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryStorageCommodityList' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetThingEventSnapshot'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GetThingEventSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'summary' => '', + ], + 'GetThingPropertySnapshot' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], - 'parameters' => [], + 'parameters' => [ + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => ['description' => 'The **ProductKey** of the product to which the video device belongs.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1Bw******', 'title' => ''], + ], + [ + 'name' => 'DeviceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the video device.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'Device01', 'title' => ''], + ], + [ + 'name' => 'IotId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the video device.'."\n" + .'><notice>'."\n" + .'**IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - 'Data' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Specification' => [ - 'type' => 'string', - ], - 'CommodityCode' => [ - 'type' => 'string', - ], - 'RecordType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Price' => [ - 'type' => 'string', - ], - 'Months' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CommodityName' => [ - 'type' => 'string', - ], - 'Lifecycle' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see **Error codes** in this topic.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'Data' => ['description' => 'The property data returned if the call is successful.', 'type' => 'string', 'example' => '{\\"StreamVideoQuality\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"MotionDetectSensitivity\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"ImageFlipState\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"SubStreamVideoQuality\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"AlarmSwitch\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"AlarmFrequencyLevel\\":{\\"time\\":1700009930921,\\"value\\":\\"10\\"}}', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request parameter error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" + ."\n" + .'- **true**: The call is successful.'."\n" + .'- **false**: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.InvalidIotInstance', 'errorMessage' => 'Invalid iot instance.', 'description' => 'Invalid iot instance.'], + ['errorCode' => 'iot.vision.ProductNotExist', 'errorMessage' => 'Product not exist.', 'description' => 'Product not exist.'], + ['errorCode' => 'iot.vision.ThingModelNotExist', 'errorMessage' => 'Thing model not exist.', 'description' => 'Thing model not exist.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], + ['errorCode' => 'iot.vision.InstanceArrearage', 'errorMessage' => 'Instance arrearage.', 'description' => 'Instance arrearage.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ['errorCode' => 'iot.vision.HasNoAccessPermission', 'errorMessage' => 'Has no access permission.', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - ], - 'QueryStorageOrder' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"400\\",\\n \\"Data\\": \\"{\\\\\\\\\\\\\\"StreamVideoQuality\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"MotionDetectSensitivity\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"ImageFlipState\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"SubStreamVideoQuality\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"AlarmSwitch\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"AlarmFrequencyLevel\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1700009930921,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10\\\\\\\\\\\\\\"}}\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetThingPropertySnapshot', + 'summary' => 'Queries the snapshots of all Thing Specification Language (TSL) properties of a specified device and returns the latest property data.', + 'description' => '## Rate limit'."\n" + ."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account is 50.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetThingPropertySnapshot'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GetThingPropertySnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'InvokeThingService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3020,45 +1952,38 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'DeviceNoOwner', + 'name' => 'Identifier', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['description' => 'The service identifier in the Thing Specification Language (TSL) model.', 'type' => 'string', 'required' => true, 'example' => 'SetNum', 'title' => ''], ], [ - 'name' => 'OrderId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the video device belongs.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1Bw******', 'title' => ''], ], [ - 'name' => 'ProductKey', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the video device.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'Device01', 'title' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'Args', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The input parameters of the service to invoke. The value is a JSON string, such as **Args={"param1":1}**.', 'type' => 'string', 'required' => false, 'example' => '{"param1":1}', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the video device.'."\n" + .'><notice>'."\n" + .'**IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], ], 'responses' => [ @@ -3066,152 +1991,92 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see **Error codes** in this topic.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request parameter error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ + 'description' => 'The data returned if the call is successful.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Copies' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Specification' => [ - 'type' => 'string', - ], - 'RecordType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CommodityCode' => [ - 'type' => 'string', - ], - 'PreConsume' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'EndTimeUTC' => [ - 'type' => 'string', - ], - 'UserId' => [ - 'type' => 'string', - ], - 'IdentityId' => [ - 'type' => 'string', - ], - 'StartTimeUTC' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'OutOrderNo' => [ - 'type' => 'string', - ], - 'Price' => [ - 'type' => 'string', - ], - 'OrderType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PaymentStatus' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'UserName' => [ - 'type' => 'string', - ], - 'OrderId' => [ - 'type' => 'string', - ], - 'IotId' => [ - 'type' => 'string', - ], + 'Data' => ['description' => 'The result of the service invocation, in JSON string format.', 'type' => 'string', 'example' => '{"param1":1}', 'title' => ''], + 'MessageId' => ['description' => 'The ID of the message sent from the cloud to the device for the service invocation.', 'type' => 'string', 'example' => 'abcabcabc1234****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNoOwner', - 'errorMessage' => 'Device has no owner.', - ], - [ - 'errorCode' => 'iot.vision.InvalidStorageOrder', - 'errorMessage' => 'Invalid storage order.', - ], - [ - 'errorCode' => 'iot.vision.DeviceOwnerChanged', - 'errorMessage' => 'Device owner changed.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderGetLockFailed', - 'errorMessage' => 'Get storage order lock failed try again later.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.InvalidIotInstance', 'errorMessage' => 'Invalid iot instance.', 'description' => 'Invalid iot instance.'], + ['errorCode' => 'iot.vision.ProductNotExist', 'errorMessage' => 'Product not exist.', 'description' => 'Product not exist.'], + ['errorCode' => 'iot.vision.ThingModelNotExist', 'errorMessage' => 'Thing model not exist.', 'description' => 'Thing model not exist.'], + ['errorCode' => 'iot.vision.ThingModelIdentifierNotExist', 'errorMessage' => 'Thing model identifier not exist.', 'description' => 'Thing model identifier not exist.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], + ['errorCode' => 'iot.vision.InstanceArrearage', 'errorMessage' => 'Instance arrearage.', 'description' => 'Instance arrearage.'], + ['errorCode' => 'iot.vision.ServiceParamNotExist', 'errorMessage' => 'Invoke service failed as service param not exist.', 'description' => 'The parameter of the TSL service does not exist.'], + ['errorCode' => 'iot.vision.ServiceNotFound', 'errorMessage' => 'Invoke service failed as service not found.', 'description' => 'The TSL service does not exist.'], + ['errorCode' => 'iot.vision.DeviceInactive', 'errorMessage' => 'Device inactive.', 'description' => 'The device is inactive.'], + ['errorCode' => 'iot.vision.DevcieOffline', 'errorMessage' => 'Device offline.', 'description' => 'The device is offline.'], + ['errorCode' => 'iot.vision.ServiceEnumSpecError', 'errorMessage' => 'Service enum spec error.', 'description' => 'The enumeration parameter of the TSL service is invalid.'], + ['errorCode' => 'iot.vision.ServiceResponseTimeout', 'errorMessage' => 'Invoke service response timeout.', 'description' => 'The device response timed out.'], + ['errorCode' => 'iot.vision.InvokeServiceFailed', 'errorMessage' => 'Invoke service failed:%s', 'description' => 'The system failed to call the TSL service.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ['errorCode' => 'iot.vision.HasNoAccessPermission', 'errorMessage' => 'Has no access permission.', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - ], - 'QueryStorageOrderList' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Data\\": \\"{\\\\\\"param1\\\\\\":1}\\",\\n \\"MessageId\\": \\"abcabcabc1234****\\"\\n }\\n}","type":"json"}]', + 'title' => 'InvokeThingService', + 'summary' => 'Invokes a specified service on a single device.', + 'description' => '## QPS limit'."\n" + ."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account is 200.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of that account.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must also specify common parameters when calling this API operation.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InvokeThingService'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:InvokeThingService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListBindingAccountByDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3220,59 +2085,47 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'DeviceNoOwner', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], - ], - [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '200', - 'minimum' => '1', - ], + 'schema' => ['description' => 'The number of records to display on each page. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '5', 'title' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the video device belongs.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1Bw******', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the video device.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'Device01', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the video device.'."\n" + .'><notice>'."\n" + .'**IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '1000', - 'minimum' => '1', - ], + 'schema' => ['description' => 'The page number to display in the returned results. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Owned', + 'in' => 'query', + 'schema' => ['description' => 'The binding type between the user and the device.'."\n" + ."\n" + .'- **0**: shared user.'."\n" + .'- **1**: administrator user.'."\n" + .'- If this parameter is not specified, all users are queried.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1', 'minimum' => '0', 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -3280,172 +2133,98 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see **Error codes** in this topic.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Unexpected internal error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ + 'description' => 'The data returned if the call is successful.', 'type' => 'object', 'properties' => [ - 'PageNo' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PageSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Total' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PageCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'StorageOrderList' => [ + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records displayed on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'AccountList' => [ + 'description' => 'The list of user information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Copies' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Specification' => [ - 'type' => 'string', - ], - 'RecordType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CommodityCode' => [ - 'type' => 'string', - ], - 'PreConsume' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'EndTimeUTC' => [ - 'type' => 'string', - ], - 'UserId' => [ - 'type' => 'string', - ], - 'IdentityId' => [ - 'type' => 'string', - ], - 'StartTimeUTC' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'OutOrderNo' => [ - 'type' => 'string', - ], - 'Price' => [ - 'type' => 'string', - ], - 'OrderType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PaymentStatus' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'UserName' => [ - 'type' => 'string', - ], - 'OrderId' => [ - 'type' => 'string', - ], - 'IotId' => [ - 'type' => 'string', - ], + 'IdentityAlias' => ['description' => 'The display name of the user.', 'type' => 'string', 'example' => '18*******20', 'title' => ''], + 'IdentityId' => ['description' => 'The identity ID of the user.', 'type' => 'string', 'example' => '5035op97******************a63994', 'title' => ''], + 'BindTime' => ['description' => 'The time when the device was bound to the user. The value is a 13-digit timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2222220000000', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNoOwner', - 'errorMessage' => 'Device has no owner.', - ], - [ - 'errorCode' => 'iot.vision.DeviceOwnerChanged', - 'errorMessage' => 'Device owner changed.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderGetLockFailed', - 'errorMessage' => 'Get storage order lock failed try again later.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.TenantMismatch', 'errorMessage' => 'Caller tenant and account belong tenant mismatch.', 'description' => 'The tenant of the API operation caller is different from the tenant to which the account belongs.'], + ['errorCode' => 'iot.vision.QueryBindingAccountFailed', 'errorMessage' => 'Query binding account failed.', 'description' => 'The system failed to query associated users.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - ], - 'TransferStorageOrder' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unexpected internal error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 1,\\n \\"Total\\": 1,\\n \\"AccountList\\": [\\n {\\n \\"IdentityAlias\\": \\"18*******20\\",\\n \\"IdentityId\\": \\"5035op97******************a63994\\",\\n \\"BindTime\\": 2222220000000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListBindingAccountByDevice', + 'summary' => 'Queries the list of users bound to a specified device.', + 'description' => '## Rate limit'."\n" + ."\n" + .'You can invoke this operation up to 50 times per second (QPS) for each Alibaba Cloud account.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBindingAccountByDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:ListBindingAccountByDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListBindingDeviceByAccount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3454,104 +2233,34 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'EventRecordDuration', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '30', - 'minimum' => '0', - 'default' => '10', - ], - ], - [ - 'name' => 'DstIotId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'SupportCrossIdentityTransfer', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], - ], - [ - 'name' => 'SrcIotId', + 'name' => 'OpenId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'SrcOrderId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], - ], - [ - 'name' => 'EventRecordProlong', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], - ], - [ - 'name' => 'ImmediateUse', + 'name' => 'OpenIdAppKey', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'UserName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'UserId', + 'name' => 'IdentityId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'EnableDefaultPlan', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'PreRecordDuration', + 'name' => 'SubDevice', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '5', - 'minimum' => '0', - 'default' => '0', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -3559,156 +2268,93 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Copies' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Specification' => [ - 'type' => 'string', - ], - 'RecordType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CommodityCode' => [ - 'type' => 'string', - ], - 'PreConsume' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'EndTimeUTC' => [ - 'type' => 'string', - ], - 'UserId' => [ - 'type' => 'string', - ], - 'IdentityId' => [ - 'type' => 'string', - ], - 'StartTimeUTC' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'OutOrderNo' => [ - 'type' => 'string', - ], - 'Price' => [ - 'type' => 'string', - ], - 'OrderType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PaymentStatus' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'UserName' => [ - 'type' => 'string', - ], - 'OrderId' => [ - 'type' => 'string', - ], - 'IotId' => [ - 'type' => 'string', + 'PageNo' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Total' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'PageCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProductKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Owned' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'NodeType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'BindTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNoOwner', - 'errorMessage' => 'Device has no owner.', - ], - [ - 'errorCode' => 'iot.vision.DeviceOwnerChanged', - 'errorMessage' => 'Device owner changed.', - ], - [ - 'errorCode' => 'iot.vision.InvalidStorageOrder', - 'errorMessage' => 'Invalid storage order.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderGetLockFailed', - 'errorMessage' => 'Get storage order lock failed try again later.', - ], - [ - 'errorCode' => 'iot.vision.StorageOrderStatusInvalid', - 'errorMessage' => 'Storage order status invalid.', - ], - [ - 'errorCode' => 'iot.vision.TargetDeviceOwnerDifferent', - 'errorMessage' => 'Target device owner is different.', - ], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.QueryBindingDeviceFailed', 'errorMessage' => 'Query binding device failed.', 'description' => 'The system failed to query the associated device list.'], + ['errorCode' => 'iot.vision.GetAccountInfoFailed', 'errorMessage' => 'Get account info failed.', 'description' => 'The system failed to query information about the account.'], + ['errorCode' => 'iot.vision.AccountNotFound', 'errorMessage' => 'Account not found.', 'description' => 'The account does not exist.'], + ['errorCode' => 'iot.vision.TenantMismatch', 'errorMessage' => 'Caller tenant and account belong tenant mismatch.', 'description' => 'The tenant of the API operation caller is different from the tenant to which the account belongs.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - ], - 'UploadDeviceNameList' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBindingDeviceByAccount'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:ListBindingDeviceByAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"PageNo\\": 0,\\n \\"PageSize\\": 0,\\n \\"Total\\": 0,\\n \\"PageCount\\": 0,\\n \\"DeviceList\\": [\\n {\\n \\"ProductKey\\": \\"\\",\\n \\"Owned\\": 0,\\n \\"DeviceName\\": \\"\\",\\n \\"NodeType\\": \\"\\",\\n \\"BindTime\\": 0,\\n \\"IotId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryBatchStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3717,33 +2363,19 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'DeviceNames', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'maxItems' => 10000, - ], + 'name' => 'BatchId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -3751,106 +2383,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ - 'BatchId' => [ - 'type' => 'string', - ], + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'InvalidDetailList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DeviceName' => [ - 'type' => 'string', - ], - 'ErrorMsg' => [ - 'type' => 'string', - ], + 'DeviceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMsg' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'RepeatedDeviceNameList' => [ + 'InvalidList' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'InvalidDeviceNameList' => [ + 'ValidList' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.ActiveCodeInsufficient', - 'errorMessage' => 'Active code quota is insufficient.', - ], - [ - 'errorCode' => 'iot.vision.DevicesCountExceedLimit', - 'errorMessage' => 'The devices count exceed the limit.', - ], - [ - 'errorCode' => 'iot.vision.DevicesExceedUnreleasedProductLimit', - 'errorMessage' => 'Devices count exceed the limit of unreleased product.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - ], - 'GetThingEventSnapshot' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryBatchStatus'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryBatchStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Status\\": \\"\\",\\n \\"InvalidDetailList\\": [\\n {\\n \\"DeviceName\\": \\"\\",\\n \\"ErrorMsg\\": \\"\\"\\n }\\n ],\\n \\"InvalidList\\": [\\n \\"\\"\\n ],\\n \\"ValidList\\": [\\n \\"\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryDeviceDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3859,44 +2480,33 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Identifier', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'AlarmType', - ], - ], - [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1Bw******', - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the video device belongs.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1Bw******', 'title' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Device01', - ], + 'schema' => ['description' => 'The name of the video device.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'Device01', 'title' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'schema' => ['description' => 'The ID of the video device.'."\n" + .'><notice>'."\n" + .'**IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => 'a123qs*****sy4QU', 'title' => ''], ], ], 'responses' => [ @@ -3904,151 +2514,105 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '400', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Unexpected internal error.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E55***B7-4***-4***-8***-D3******F565', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see **Error codes** in this topic.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request parameter error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EventType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'alert', - ], - 'EventCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'IntelligentAlarm', - ], - 'Identifier' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'IntelligentAlarm', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700010288668', - ], - 'EventBody' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"EventList \\":[{\\"AlarmPicID \\":\\"\\",\\"EventTime \\":\\"1700010288542 \\",\\"AlarmType \\":1,\\"AlarmPicSize \\":1,\\"Data \\":\\"test \\"}]}', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], - ], + 'description' => 'The data returned if the call is successful.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The device status. Valid values:'."\n" + ."\n" + .'- **ONLINE**: The device is online.'."\n" + .'- **OFFLINE**: The device is offline.'."\n" + .'- **UNACTIVE**: The device is not activated.'."\n" + .'- **DISABLE**: The device is disabled.', 'type' => 'string', 'example' => 'ONLINE', 'title' => ''], + 'ProductName' => ['description' => 'The name of the product to which the device belongs.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DeviceName' => ['description' => 'The device name.', 'type' => 'string', 'example' => 'Device01', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the device was created. The value is a 13-digit timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1834500000000', 'title' => ''], + 'FirmwareVersion' => ['description' => 'The version number of the default OTA module of the device.', 'type' => 'string', 'example' => 'V1.0.0.0', 'title' => ''], + 'OnlineTime' => ['description' => 'The last online time of the device. The value is a 13-digit UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2298700000000', 'title' => ''], + 'ActiveTime' => ['description' => 'The time when the device was activated. The value is a 13-digit timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1934500000000', 'title' => ''], + 'ProductKey' => ['description' => 'The **ProductKey** of the product to which the device belongs.', 'type' => 'string', 'example' => 'a1Bw******', 'title' => ''], + 'IpAddress' => ['description' => 'The IP address of the device.', 'type' => 'string', 'example' => '10.***.***.***', 'title' => ''], + 'NodeType' => ['description' => 'The node type. Valid values:'."\n" + ."\n" + .'- **0**: device. A device cannot mount child devices.'."\n" + .'- **1**: gateway. A gateway can mount child devices.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Region' => ['description' => 'The ID of the region where the device resides.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'DeviceSecret' => ['description' => 'The device secret.', 'type' => 'string', 'example' => 'mz2Canp4GB7qRVf1OYPNtRqB2anu****', 'title' => ''], + 'Nickname' => ['description' => 'The alias of the device.', 'type' => 'string', 'example' => 'detectors_in_beijing', 'title' => ''], + 'IotId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.InvalidIotInstance', - 'errorMessage' => 'Invalid iot instance.', - ], - [ - 'errorCode' => 'iot.vision.ProductNotExist', - 'errorMessage' => 'Product not exist.', - ], - [ - 'errorCode' => 'iot.vision.ThingModelNotExist', - 'errorMessage' => 'Thing model not exist.', - ], - [ - 'errorCode' => 'iot.vision.ThingModelIdentifierNotExist', - 'errorMessage' => 'Thing model identifier not exist.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], - [ - 'errorCode' => 'iot.vision.InstanceArrearage', - 'errorMessage' => 'Instance arrearage.', - ], - [ - 'errorCode' => 'iot.vision.GetThingEventSnapshotFailed', - 'errorMessage' => 'Get thing event snapshot failed.', - ], - [ - 'errorCode' => 'iot.vision.ThingEventNotFound', - 'errorMessage' => 'Thing event not found.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.InvalidIotInstance', 'errorMessage' => 'Invalid iot instance.', 'description' => 'Invalid iot instance.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], + ['errorCode' => 'iot.vision.ProductNotExist', 'errorMessage' => 'Product not exist.', 'description' => 'Product not exist.'], + ['errorCode' => 'iot.vision.DeviceNameFormatInvalid', 'errorMessage' => 'Device name format invalid.', 'description' => 'Device name format invalid.'], + ['errorCode' => 'iot.vision.InstanceArrearage', 'errorMessage' => 'Instance arrearage.', 'description' => 'Instance arrearage.'], + ['errorCode' => 'iot.vision.ProductKeyFormatInvalid', 'errorMessage' => 'Product key format invalid.', 'description' => 'Product key format invalid.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], - [ - 'errorCode' => 'iot.vision.HasNoAccessPermission', - 'errorMessage' => 'Has no access permission.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ['errorCode' => 'iot.vision.HasNoAccessPermission', 'errorMessage' => 'Has no access permission.', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unexpected internal error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EventType\\": \\"alert\\",\\n \\"EventCode\\": \\"IntelligentAlarm\\",\\n \\"Identifier\\": \\"IntelligentAlarm\\",\\n \\"Timestamp\\": 1700010288668,\\n \\"EventBody\\": \\"{\\\\\\\\\\\\\\"EventList \\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"AlarmPicID \\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EventTime \\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1700010288542 \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AlarmType \\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"AlarmPicSize \\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"Data \\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test \\\\\\\\\\\\\\"}]}\\",\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetThingEventSnapshotResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <IotId>C47T6xwp6ms4bNlkHRWCg4****</IotId>\\n <Identifier>IntelligentAlarm</Identifier>\\n <EventBody>{\\"EventList \\":[{\\"AlarmPicID \\":\\"\\",\\"EventTime \\":\\"1700010288542 \\",\\"AlarmType \\":1,\\"AlarmPicSize \\":1,\\"Data \\":\\"test \\"}]}</EventBody>\\n <EventType>alert</EventType>\\n <Timestamp>1700010288668</Timestamp>\\n <EventCode>IntelligentAlarm</EventCode>\\n</Data>\\n<Success>true</Success>\\n</GetThingEventSnapshotResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": \\"ONLINE\\",\\n \\"ProductName\\": \\"test\\",\\n \\"DeviceName\\": \\"Device01\\",\\n \\"CreateTime\\": 1834500000000,\\n \\"FirmwareVersion\\": \\"V1.0.0.0\\",\\n \\"OnlineTime\\": 2298700000000,\\n \\"ActiveTime\\": 1934500000000,\\n \\"ProductKey\\": \\"a1Bw******\\",\\n \\"IpAddress\\": \\"10.***.***.***\\",\\n \\"NodeType\\": 0,\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"DeviceSecret\\": \\"mz2Canp4GB7qRVf1OYPNtRqB2anu****\\",\\n \\"Nickname\\": \\"detectors_in_beijing\\",\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n}","type":"json"}]', + 'title' => 'QueryDeviceDetail', + 'summary' => 'Queries the details of a specified device.', + 'description' => '## Rate limit'."\n" + ."\n" + .'You can invoke this operation up to 50 times per second (QPS) per Alibaba Cloud account.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'BatchBindDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceDetail'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryDevicesDownloadUrl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4057,55 +2621,14 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'OpenId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'OpenIdAppKey', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'IdentityId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'DeviceList', + 'name' => 'BatchId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProductKey' => [ - 'type' => 'string', - 'required' => false, - ], - 'DeviceName' => [ - 'type' => 'string', - 'required' => false, - ], - 'IotId' => [ - 'type' => 'string', - 'required' => false, - ], - ], - ], - 'required' => true, - 'maxItems' => 20, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -4113,113 +2636,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ - 'BindDeviceList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'BindResultMessage' => [ - 'type' => 'string', - ], - 'ProductKey' => [ - 'type' => 'string', - ], - 'BindResultCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'DeviceName' => [ - 'type' => 'string', - ], - 'IotId' => [ - 'type' => 'string', - ], - ], - ], - ], + 'OssDownloadUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.GetAccountInfoFailed', - 'errorMessage' => 'Get account info failed.', - ], - [ - 'errorCode' => 'iot.vision.AccountNotFound', - 'errorMessage' => 'Account not found.', - ], - [ - 'errorCode' => 'iot.vision.TenantMismatch', - 'errorMessage' => 'Caller tenant and account belong tenant mismatch.', - ], - [ - 'errorCode' => 'iot.vision.IdentityAppKeyProductNotBind', - 'errorMessage' => 'The app associated with the identityId does not have permission to access the product.', - ], - [ - 'errorCode' => 'iot.vision.BindFailed', - 'errorMessage' => 'Bind account and device failed.', - ], + ['errorCode' => 'iot.system.SystemException', 'errorMessage' => 'An internal error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'iot.common.AuthActionPermissionDeny', 'errorMessage' => 'The authorization fails.', 'description' => 'The authorization fails.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.lv.requestAuthError', 'errorMessage' => 'Request auth error.', 'description' => 'The verification failed.'], + ['errorCode' => 'iot.lv.requestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'The request parameter is invalid.'], ], - 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDevicesDownloadUrl'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDevicesDownloadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"OssDownloadUrl\\": \\"\\"\\n }\\n}","type":"json"}]', ], - 'GetAccountById' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryFreeStorage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4228,34 +2700,19 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'OpenId', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '60yqjd1**************************561da00851', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'OpenIdAppKey', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '76****57', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'IdentityId', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5035op97******************a63994', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -4263,137 +2720,80 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '400', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Unexpected internal error.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E55***B7-4***-4***-8***-D3******F565', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'LoginName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '18*******20', - ], - 'Email' => [ - 'description' => '', - 'type' => 'string', - 'example' => '******', - ], - 'IdentityId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5035op97******************a63994', - ], - 'LastLoginTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700209499000', - ], - 'GmtCreate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700189358000', - ], - 'NickName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '18*******20', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700209499000', - ], - 'Phone' => [ - 'description' => '', - 'type' => 'string', - 'example' => '18*******20', - ], + 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Type' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Months' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Expired' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'RemainQuota' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'StartTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Consumed' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Lifecycle' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.GetAccountInfoFailed', - 'errorMessage' => 'Get account info failed.', - ], - [ - 'errorCode' => 'iot.vision.AccountNotFound', - 'errorMessage' => 'Account not found.', - ], - [ - 'errorCode' => 'iot.vision.TenantMismatch', - 'errorMessage' => 'Caller tenant and account belong tenant mismatch.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.DeviceNoOwner', 'errorMessage' => 'Device has no owner.', 'description' => 'Device has no owner.'], + ['errorCode' => 'iot.vision.FreeStorageQuotaLimit', 'errorMessage' => 'No enough free storage quota or exceed limit.', 'description' => 'No enough free storage quota or exceed limit.'], + ['errorCode' => 'iot.vision.GetDeviceInfoFailed', 'errorMessage' => 'Get device info failed.', 'description' => 'The system failed to query the details of the device.'], + ['errorCode' => 'iot.vision.StorageOrderGetLockFailed', 'errorMessage' => 'Get storage order lock failed try again later.', 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unexpected internal error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"LoginName\\": \\"18*******20\\",\\n \\"Email\\": \\"******\\",\\n \\"IdentityId\\": \\"5035op97******************a63994\\",\\n \\"LastLoginTime\\": 1700209499000,\\n \\"GmtCreate\\": 1700189358000,\\n \\"NickName\\": \\"18*******20\\",\\n \\"GmtModified\\": 1700209499000,\\n \\"Phone\\": \\"18*******20\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAccountByIdResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <LastLoginTime>1700209499000</LastLoginTime>\\n <LoginName>18*******20</LoginName>\\n <GmtCreate>1700189358000</GmtCreate>\\n <Email>******</Email>\\n <Phone>18*******20</Phone>\\n <GmtModified>1700209499000</GmtModified>\\n <IdentityId>5035op97******************a63994</IdentityId>\\n <NickName>18*******20</NickName>\\n</Data>\\n<Success>true</Success>\\n</GetAccountByIdResponse>","errorExample":""}]', - 'title' => 'GetAccountById', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetDeviceStatus' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFreeStorage'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFreeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"EndTime\\": \\"\\",\\n \\"Type\\": 0,\\n \\"StartTime\\": \\"\\",\\n \\"EndTimeUTC\\": \\"\\",\\n \\"Months\\": 0,\\n \\"Expired\\": 0,\\n \\"RemainQuota\\": 0,\\n \\"StartTimeUTC\\": \\"\\",\\n \\"Consumed\\": 0,\\n \\"Lifecycle\\": 0\\n }\\n}","type":"json"}]', + ], + 'QueryGenerateDevicesInfoList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4402,34 +2802,24 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProductKey', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1Bw******', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'BatchId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Device01', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'IotId', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -4437,107 +2827,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '400', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Unexpected internal error.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E55***B7-4***-4***-8***-D3******F565', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Status' => [ + 'PageNo' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Total' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ListData' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceSecret' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'type' => 'string', - 'example' => 'ONLINE', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.InvalidIotInstance', - 'errorMessage' => 'Invalid iot instance.', - ], - [ - 'errorCode' => 'iot.vision.ProductNotExist', - 'errorMessage' => 'Product not exist.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], - [ - 'errorCode' => 'iot.vision.InstanceArrearage', - 'errorMessage' => 'Instance arrearage.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => 'The RAM user does not have permissions to access the resource.'], + ['errorCode' => 'iot.vision.ProductNotExist', 'errorMessage' => 'Product not exist.', 'description' => 'Product not exist.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], - [ - 'errorCode' => 'iot.vision.HasNoAccessPermission', - 'errorMessage' => 'Has no access permission.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unexpected internal error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": \\"ONLINE\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDeviceStatusResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <Status>ONLINE</Status>\\n</Data>\\n<Success>true</Success>\\n</GetDeviceStatusResponse>","errorExample":""}]', - 'title' => 'GetDeviceStatus', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetSubDeviceList' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryGenerateDevicesInfoList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryGenerateDevicesInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"PageNo\\": 0,\\n \\"PageSize\\": 0,\\n \\"Total\\": 0,\\n \\"ListData\\": [\\n {\\n \\"DeviceName\\": \\"\\",\\n \\"IotId\\": \\"\\",\\n \\"DeviceSecret\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'QueryGenerateDevicesRecord' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4547,59 +2916,26 @@ 'parameters' => [ [ 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '5', - ], - ], - [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1Bw******', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The number of records per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'DeviceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Device01', - ], + 'name' => 'PageNo', + 'in' => 'formData', + 'schema' => ['description' => 'The page number to return. Maximum value: 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'IotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The start time in millisecond-level UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9999999999999', 'minimum' => '1', 'example' => '1690819200000', 'title' => ''], ], [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end time in millisecond-level UNIX timestamp.'."\n" + ."\n" + .'><notice> The interval between the start time and end time cannot exceed 30 days.'."\n" + .'></notice>.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9999999999999', 'minimum' => '1', 'example' => '1659283200000', 'title' => ''], ], ], 'responses' => [ @@ -4607,286 +2943,204 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The result code of the call:'."\n" + .'- A value of 200 indicates success.'."\n" + .'- Any other value indicates failure. For more information, see **Error codes** in this topic.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request parameter error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E5******-4***-***B-8**E-D3********65', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The result returned if the call was successful.', 'type' => 'object', 'properties' => [ - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SubDeviceList' => [ - 'description' => '', + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'ListData' => [ + 'description' => 'The details of the device registration records.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ProductKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'wse5******', - ], - 'DeviceName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'device-test', - ], - 'IotId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qswdfrttgg*********', - ], + 'ApplyDeviceCount' => ['description' => 'The number of devices applied for.', 'type' => 'integer', 'format' => 'int64', 'example' => '133', 'title' => ''], + 'SpecCode' => ['description' => 'The activation code specification. Valid values:'."\n" + ."\n" + .'- **Consumer_IPC_512Kbps**: consumer IPC 512 Kbps.'."\n" + .'- **Consumer_IPC_1Mbps**: consumer IPC 1 Mbps.'."\n" + .'- **Consumer_IPC_2Mbps**: consumer IPC 2 Mbps.'."\n" + .'- **Consumer_IPC_4Mbps**: consumer IPC 4 Mbps.'."\n" + .'- **Industry_IPC**: industry IPC.'."\n" + .'- **NVR_Less64**: network video recorder with 64 or fewer channels.'."\n" + .'- **NVR_Higher64**: network video recorder with more than 64 channels.', 'type' => 'string', 'example' => 'Consumer_IPC_512Kbps', 'title' => ''], + 'ProductKey' => ['description' => 'The **ProductKey** of the product to which the device belongs.', 'type' => 'string', 'example' => 'a3w******', 'title' => ''], + 'ProductName' => ['description' => 'The name of the product to which the device belongs.', 'type' => 'string', 'example' => '电饭煲', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the batch registration task was submitted, in millisecond-level UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1690819200000', 'title' => ''], + 'BatchStatus' => ['description' => 'The batch status of the batch registration. Valid values:'."\n" + ."\n" + .'- **CREATE**: Devices are being created.'."\n" + .'- **CREATE_SUCCESS**: All devices in the application were created.'."\n" + .'- **CREATE_FAILED**: Some devices in the application failed to be created.', 'type' => 'string', 'example' => 'CREATE', 'title' => ''], + 'NetworkType' => ['description' => 'The network connectivity type of the product. Valid values:'."\n" + ."\n" + .'- **WIFI**: Wi-Fi.'."\n" + .'- **CELLULAR**: cellular (GPRS/3G/4G/5G).'."\n" + .'- **ETHERNET**: Ethernet.'."\n" + .'- **OTHER**: other network type.', 'type' => 'string', 'example' => 'WIFI', 'title' => ''], + 'OperateUid' => ['description' => 'The UID of the account that performed the operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '110000000000', 'title' => ''], + 'SuccessCount' => ['description' => 'The number of devices that were successfully registered in the batch.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'BatchId' => ['description' => 'The batch ID of the application.', 'type' => 'string', 'example' => '1508******195', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.InvalidIotInstance', - 'errorMessage' => 'Invalid iot instance.', - ], - [ - 'errorCode' => 'iot.vision.ProductNotExist', - 'errorMessage' => 'Product not exist.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], - [ - 'errorCode' => 'iot.vision.InstanceArrearage', - 'errorMessage' => 'Instance arrearage.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], - [ - 'errorCode' => 'iot.vision.HasNoAccessPermission', - 'errorMessage' => 'Has no access permission.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => '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 \\"PageNo\\": 1,\\n \\"PageSize\\": 1,\\n \\"Total\\": 1,\\n \\"SubDeviceList\\": [\\n {\\n \\"ProductKey\\": \\"wse5******\\",\\n \\"DeviceName\\": \\"device-test\\",\\n \\"IotId\\": \\"qswdfrttgg*********\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSubDeviceListResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <PageSize/>\\n <Total>1</Total>\\n <PageNo/>\\n <SubDeviceList>\\n <IotId>qswdfrttgg*********</IotId>\\n <ProductKey>wse5******</ProductKey>\\n <DeviceName>device-test</DeviceName>\\n </SubDeviceList>\\n</Data>\\n<Success>true</Success>\\n</GetSubDeviceListResponse>","errorExample":""}]', - 'title' => 'GetSubDeviceList', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E5******-4***-***B-8**E-D3********65\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 1,\\n \\"Total\\": 5,\\n \\"ListData\\": [\\n {\\n \\"ApplyDeviceCount\\": 133,\\n \\"SpecCode\\": \\"Consumer_IPC_512Kbps\\",\\n \\"ProductKey\\": \\"a3w******\\",\\n \\"ProductName\\": \\"电饭煲\\",\\n \\"CreateTime\\": 1690819200000,\\n \\"BatchStatus\\": \\"CREATE\\",\\n \\"NetworkType\\": \\"WIFI\\",\\n \\"OperateUid\\": 110000000000,\\n \\"SuccessCount\\": 5,\\n \\"BatchId\\": \\"1508******195\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'QueryGenerateDevicesRecord', + 'summary' => 'Queries the records of batch device registration.', + 'description' => '## Rate limit'."\n" + ."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account for invoking this operation is 20.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'In addition to the request parameters described in this topic, you must specify common parameters when you call this operation.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetThingPropertySnapshot' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryGenerateDevicesRecord'], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ProductKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1Bw******', - ], - ], + 'ramActions' => [ [ - 'name' => 'DeviceName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Device01', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryGenerateDevicesRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryStorageCommodityList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'AK' => [], ], ], + 'systemTags' => [], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '400', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Specification' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CommodityCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RecordType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Price' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Months' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CommodityName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Lifecycle' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'type' => 'string', - 'example' => '{\\"StreamVideoQuality\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"MotionDetectSensitivity\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"ImageFlipState\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"SubStreamVideoQuality\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"AlarmSwitch\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"AlarmFrequencyLevel\\":{\\"time\\":1700009930921,\\"value\\":\\"10\\"}}', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Request parameter error.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E55***B7-4***-4***-8***-D3******F565', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.InvalidIotInstance', - 'errorMessage' => 'Invalid iot instance.', - ], - [ - 'errorCode' => 'iot.vision.ProductNotExist', - 'errorMessage' => 'Product not exist.', - ], - [ - 'errorCode' => 'iot.vision.ThingModelNotExist', - 'errorMessage' => 'Thing model not exist.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], - [ - 'errorCode' => 'iot.vision.InstanceArrearage', - 'errorMessage' => 'Instance arrearage.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], - [ - 'errorCode' => 'iot.vision.HasNoAccessPermission', - 'errorMessage' => 'Has no access permission.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"Data\\": \\"{\\\\\\\\\\\\\\"StreamVideoQuality\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"MotionDetectSensitivity\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"ImageFlipState\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"SubStreamVideoQuality\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"AlarmSwitch\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1699951400324,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"AlarmFrequencyLevel\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":1700009930921,\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10\\\\\\\\\\\\\\"}}\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetThingPropertySnapshotResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>{\\"StreamVideoQuality\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"MotionDetectSensitivity\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"ImageFlipState\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"SubStreamVideoQuality\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"AlarmSwitch\\":{\\"time\\":1699951400324,\\"value\\":\\"0\\"},\\"AlarmFrequencyLevel\\":{\\"time\\":1700009930921,\\"value\\":\\"10\\"}}</Data>\\n<Success>true</Success>\\n</GetThingPropertySnapshotResponse>","errorExample":""}]', - 'title' => 'GetThingPropertySnapshot', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'InvokeThingService' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStorageCommodityList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryStorageCommodityList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": [\\n {\\n \\"Specification\\": \\"\\",\\n \\"CommodityCode\\": \\"\\",\\n \\"RecordType\\": 0,\\n \\"Price\\": \\"\\",\\n \\"Months\\": 0,\\n \\"CommodityName\\": \\"\\",\\n \\"Lifecycle\\": 0\\n }\\n ]\\n}","type":"json"}]', + ], + 'QueryStorageOrder' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4895,54 +3149,29 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Identifier', + 'name' => 'DeviceNoOwner', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'SetNum', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ProductKey', + 'name' => 'OrderId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1Bw******', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Device01', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'Args', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"param1":1}', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -4950,148 +3179,89 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{"param1":1}', - ], - 'MessageId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'abcabcabc1234****', - ], + 'Status' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Copies' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Specification' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RecordType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CommodityCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PreConsume' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'EndTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IdentityId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OutOrderNo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Price' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PaymentStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'UserName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.InvalidIotInstance', - 'errorMessage' => 'Invalid iot instance.', - ], - [ - 'errorCode' => 'iot.vision.ProductNotExist', - 'errorMessage' => 'Product not exist.', - ], - [ - 'errorCode' => 'iot.vision.ThingModelNotExist', - 'errorMessage' => 'Thing model not exist.', - ], - [ - 'errorCode' => 'iot.vision.ThingModelIdentifierNotExist', - 'errorMessage' => 'Thing model identifier not exist.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], - [ - 'errorCode' => 'iot.vision.InstanceArrearage', - 'errorMessage' => 'Instance arrearage.', - ], - [ - 'errorCode' => 'iot.vision.ServiceParamNotExist', - 'errorMessage' => 'Invoke service failed as service param not exist.', - ], - [ - 'errorCode' => 'iot.vision.ServiceNotFound', - 'errorMessage' => 'Invoke service failed as service not found.', - ], - [ - 'errorCode' => 'iot.vision.DeviceInactive', - 'errorMessage' => 'Device inactive.', - ], - [ - 'errorCode' => 'iot.vision.DevcieOffline', - 'errorMessage' => 'Device offline.', - ], - [ - 'errorCode' => 'iot.vision.ServiceEnumSpecError', - 'errorMessage' => 'Service enum spec error.', - ], - [ - 'errorCode' => 'iot.vision.ServiceResponseTimeout', - 'errorMessage' => 'Invoke service response timeout.', - ], - [ - 'errorCode' => 'iot.vision.InvokeServiceFailed', - 'errorMessage' => 'Invoke service failed:%s', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.DeviceNoOwner', 'errorMessage' => 'Device has no owner.', 'description' => 'Device has no owner.'], + ['errorCode' => 'iot.vision.InvalidStorageOrder', 'errorMessage' => 'Invalid storage order.', 'description' => 'Invalid storage order.'], + ['errorCode' => 'iot.vision.DeviceOwnerChanged', 'errorMessage' => 'Device owner changed.', 'description' => 'Device owner changed.'], + ['errorCode' => 'iot.vision.StorageOrderGetLockFailed', 'errorMessage' => 'Get storage order lock failed try again later.', 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], - [ - 'errorCode' => 'iot.vision.HasNoAccessPermission', - 'errorMessage' => 'Has no access permission.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => '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 \\"Data\\": \\"{\\\\\\"param1\\\\\\":1}\\",\\n \\"MessageId\\": \\"abcabcabc1234****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<InvokeThingServiceResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <Data>{\\"param1\\":1}</Data>\\n <MessageId>abcabcabc1234****</MessageId>\\n</Data>\\n<Success>true</Success>\\n</InvokeThingServiceResponse>","errorExample":""}]', - 'title' => 'InvokeThingService', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListBindingAccountByDevice' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStorageOrder'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryStorageOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"Copies\\": 0,\\n \\"Specification\\": \\"\\",\\n \\"RecordType\\": 0,\\n \\"CommodityCode\\": \\"\\",\\n \\"PreConsume\\": 0,\\n \\"EndTimeUTC\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"IdentityId\\": \\"\\",\\n \\"StartTimeUTC\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"OutOrderNo\\": \\"\\",\\n \\"Price\\": \\"\\",\\n \\"OrderType\\": 0,\\n \\"PaymentStatus\\": 0,\\n \\"UserName\\": \\"\\",\\n \\"OrderId\\": \\"\\",\\n \\"IotId\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'QueryStorageOrderList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5100,73 +3270,34 @@ 'systemTags' => [], 'parameters' => [ [ + 'name' => 'DeviceNoOwner', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], + ], + [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '5', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '200', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1Bw******', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Device01', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'Owned', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1', - 'minimum' => '0', - 'example' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -5174,133 +3305,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '400', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Unexpected internal error.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E55***B7-4***-4***-8***-D3******F565', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AccountList' => [ - 'description' => '', + 'PageNo' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Total' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PageCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'StorageOrderList' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'IdentityAlias' => [ - 'description' => '', - 'type' => 'string', - 'example' => '18*******20', - ], - 'IdentityId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5035op97******************a63994', - ], - 'BindTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2222220000000', - ], + 'Status' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Copies' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Specification' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RecordType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CommodityCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PreConsume' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'EndTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IdentityId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OutOrderNo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Price' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PaymentStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'UserName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.TenantMismatch', - 'errorMessage' => 'Caller tenant and account belong tenant mismatch.', - ], - [ - 'errorCode' => 'iot.vision.QueryBindingAccountFailed', - 'errorMessage' => 'Query binding account failed.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.DeviceNoOwner', 'errorMessage' => 'Device has no owner.', 'description' => 'Device has no owner.'], + ['errorCode' => 'iot.vision.DeviceOwnerChanged', 'errorMessage' => 'Device owner changed.', 'description' => 'Device owner changed.'], + ['errorCode' => 'iot.vision.StorageOrderGetLockFailed', 'errorMessage' => 'Get storage order lock failed try again later.', 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Unexpected internal error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 1,\\n \\"Total\\": 1,\\n \\"AccountList\\": [\\n {\\n \\"IdentityAlias\\": \\"18*******20\\",\\n \\"IdentityId\\": \\"5035op97******************a63994\\",\\n \\"BindTime\\": 2222220000000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListBindingAccountByDeviceResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Data>\\n <PageSize>1</PageSize>\\n <Total>1</Total>\\n <PageNo>1</PageNo>\\n <AccountList>\\n <BindTime>1700209801000</BindTime>\\n <IdentityId>5035op97******************a63994</IdentityId>\\n <IdentityAlias>18*******20</IdentityAlias>\\n </AccountList>\\n</Data>\\n<Success>true</Success>\\n</ListBindingAccountByDeviceResponse>","errorExample":""}]', - 'title' => 'ListBindingAccountByDevice', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListBindingDeviceByAccount' => [ - 'methods' => [ - 'post', - 'get', + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStorageOrderList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryStorageOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"PageNo\\": 0,\\n \\"PageSize\\": 0,\\n \\"Total\\": 0,\\n \\"PageCount\\": 0,\\n \\"StorageOrderList\\": [\\n {\\n \\"Status\\": 0,\\n \\"Copies\\": 0,\\n \\"Specification\\": \\"\\",\\n \\"RecordType\\": 0,\\n \\"CommodityCode\\": \\"\\",\\n \\"PreConsume\\": 0,\\n \\"EndTimeUTC\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"IdentityId\\": \\"\\",\\n \\"StartTimeUTC\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"OutOrderNo\\": \\"\\",\\n \\"Price\\": \\"\\",\\n \\"OrderType\\": 0,\\n \\"PaymentStatus\\": 0,\\n \\"UserName\\": \\"\\",\\n \\"OrderId\\": \\"\\",\\n \\"IotId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'SetThingProperty' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5309,58 +3413,35 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'OpenId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'OpenIdAppKey', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '50', - 'minimum' => '1', - ], + 'schema' => ['description' => 'The **ProductKey** of the product to which the video device belongs.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **DeviceName**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'a1Bw******', 'title' => ''], ], [ - 'name' => 'IdentityId', + 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the video device.'."\n" + ."\n" + .'><notice>If you specify this parameter, you must also specify **ProductKey**.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'Device01', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'Args', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '100', - 'minimum' => '1', - ], + 'schema' => ['description' => 'The property information to set, in JSON format.'."\n" + ."\n" + .'Each property is represented as an **identifier** and **property value** (**key:value**) pair. Separate multiple properties with commas (,).', 'type' => 'string', 'required' => true, 'example' => '{"Switch":1,"Color":"blue"}', 'title' => ''], ], [ - 'name' => 'SubDevice', + 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the video device.'."\n" + .'><notice>'."\n" + .'**IotId** is a globally unique identifier of a device and corresponds to a combination of **ProductKey** and **DeviceName** on a one-to-one basis. If you specify this parameter, you do not need to specify **ProductKey** or **DeviceName**. If you specify **IotId** together with **ProductKey** and **DeviceName**, **IotId** takes precedence.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', 'title' => ''], ], ], 'responses' => [ @@ -5368,129 +3449,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - 'Data' => [ - 'type' => 'object', - 'properties' => [ - 'PageNo' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PageSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Total' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'PageCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'DeviceList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProductKey' => [ - 'type' => 'string', - ], - 'Owned' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'DeviceName' => [ - 'type' => 'string', - ], - 'NodeType' => [ - 'type' => 'string', - ], - 'BindTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'IotId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], + 'Code' => ['description' => 'The error code returned if the call fails. For more information, see **Error codes** in this topic.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the call fails.', 'type' => 'string', 'example' => 'Request parameter error.', 'title' => ''], + 'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request.', 'type' => 'string', 'example' => 'E55***B7-4***-4***-8***-D3******F565', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.QueryBindingDeviceFailed', - 'errorMessage' => 'Query binding device failed.', - ], - [ - 'errorCode' => 'iot.vision.GetAccountInfoFailed', - 'errorMessage' => 'Get account info failed.', - ], - [ - 'errorCode' => 'iot.vision.AccountNotFound', - 'errorMessage' => 'Account not found.', - ], - [ - 'errorCode' => 'iot.vision.TenantMismatch', - 'errorMessage' => 'Caller tenant and account belong tenant mismatch.', - ], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.InvalidIotInstance', 'errorMessage' => 'Invalid iot instance.', 'description' => 'Invalid iot instance.'], + ['errorCode' => 'iot.vision.ProductNotExist', 'errorMessage' => 'Product not exist.', 'description' => 'Product not exist.'], + ['errorCode' => 'iot.vision.ThingModelNotExist', 'errorMessage' => 'Thing model not exist.', 'description' => 'Thing model not exist.'], + ['errorCode' => 'iot.vision.ThingModelIdentifierNotExist', 'errorMessage' => 'Thing model identifier not exist.', 'description' => 'Thing model identifier not exist.'], + ['errorCode' => 'iot.vision.DeviceNotExist', 'errorMessage' => 'Device not exist.', 'description' => 'Device not exist.'], + ['errorCode' => 'iot.vision.InstanceArrearage', 'errorMessage' => 'Instance arrearage.', 'description' => 'Instance arrearage.'], + ['errorCode' => 'iot.vision.SetPropertyFailed', 'errorMessage' => 'Set property failed.', 'description' => 'The system failed to configure the TSL property.'], + ['errorCode' => 'iot.vision.PropertyNotFound', 'errorMessage' => 'Property not found.', 'description' => 'The TSL property does not exist.'], + ['errorCode' => 'iot.vision.PropertyReadOnly', 'errorMessage' => 'Property is read only.', 'description' => 'The TSL property is read-only.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ['errorCode' => 'iot.vision.HasNoAccessPermission', 'errorMessage' => 'Has no access permission.', 'description' => ''], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', - ], + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], ], ], - ], - 'SetThingProperty' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'SetThingProperty', + 'summary' => 'Sets property values for a specified device.', + 'description' => '## QPS limit'."\n" + ."\n" + .'The maximum number of queries per second (QPS) per Alibaba Cloud account for this operation is 50.'."\n" + ."\n" + .'> All Resource Access Management (RAM) users under an Alibaba Cloud account share the quota of the account.', + 'requestParamsDescription' => 'In addition to the operation-specific request parameters described in this topic, you must also specify common request parameters when you call this operation.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetThingProperty'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:SetThingProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'TransferStorageOrder' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5499,44 +3529,59 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProductKey', + 'name' => 'EventRecordDuration', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a1Bw******', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '30', 'minimum' => '0', 'default' => '10', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'DeviceName', + 'name' => 'DstIotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Device01', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'Args', + 'name' => 'SupportCrossIdentityTransfer', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '{"Switch":1,"Color":"blue"}', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'IotId', + 'name' => 'SrcIotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'C47T6xwp6ms4bNlkHRWCg4****', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'SrcOrderId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'EventRecordProlong', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ImmediateUse', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'EnableDefaultPlan', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PreRecordDuration', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '5', 'minimum' => '0', 'default' => '0', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -5544,116 +3589,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - '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' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Copies' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Specification' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RecordType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CommodityCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PreConsume' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'EndTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IdentityId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTimeUTC' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OutOrderNo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Price' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PaymentStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'UserName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrderId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.InvalidIotInstance', - 'errorMessage' => 'Invalid iot instance.', - ], - [ - 'errorCode' => 'iot.vision.ProductNotExist', - 'errorMessage' => 'Product not exist.', - ], - [ - 'errorCode' => 'iot.vision.ThingModelNotExist', - 'errorMessage' => 'Thing model not exist.', - ], - [ - 'errorCode' => 'iot.vision.ThingModelIdentifierNotExist', - 'errorMessage' => 'Thing model identifier not exist.', - ], - [ - 'errorCode' => 'iot.vision.DeviceNotExist', - 'errorMessage' => 'Device not exist.', - ], - [ - 'errorCode' => 'iot.vision.InstanceArrearage', - 'errorMessage' => 'Instance arrearage.', - ], - [ - 'errorCode' => 'iot.vision.SetPropertyFailed', - 'errorMessage' => 'Set property failed.', - ], - [ - 'errorCode' => 'iot.vision.PropertyNotFound', - 'errorMessage' => 'Property not found.', - ], - [ - 'errorCode' => 'iot.vision.PropertyReadOnly', - 'errorMessage' => 'Property is read only.', - ], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.DeviceNoOwner', 'errorMessage' => 'Device has no owner.', 'description' => 'Device has no owner.'], + ['errorCode' => 'iot.vision.DeviceOwnerChanged', 'errorMessage' => 'Device owner changed.', 'description' => 'Device owner changed.'], + ['errorCode' => 'iot.vision.InvalidStorageOrder', 'errorMessage' => 'Invalid storage order.', 'description' => 'Invalid storage order.'], + ['errorCode' => 'iot.vision.StorageOrderGetLockFailed', 'errorMessage' => 'Get storage order lock failed try again later.', 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['errorCode' => 'iot.vision.StorageOrderStatusInvalid', 'errorMessage' => 'Storage order status invalid.', 'description' => 'You cannot perform the operation on the cloud storage order.'], + ['errorCode' => 'iot.vision.TargetDeviceOwnerDifferent', 'errorMessage' => 'Target device owner is different.', 'description' => 'The administrator of the destination device is different from the administrator of the order to be transferred.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], - [ - 'errorCode' => 'iot.vision.HasNoAccessPermission', - 'errorMessage' => 'Has no access permission.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransferStorageOrder'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:TransferStorageOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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":"<SetThingPropertyResponse>\\n<RequestId>E55***B7-4***-4***-8***-D3******F565</RequestId>\\n<Success>true</Success>\\n</SetThingPropertyResponse>","errorExample":""}]', - 'title' => 'SetThingProperty', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"Copies\\": 0,\\n \\"Specification\\": \\"\\",\\n \\"RecordType\\": 0,\\n \\"CommodityCode\\": \\"\\",\\n \\"PreConsume\\": 0,\\n \\"EndTimeUTC\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"IdentityId\\": \\"\\",\\n \\"StartTimeUTC\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"OutOrderNo\\": \\"\\",\\n \\"Price\\": \\"\\",\\n \\"OrderType\\": 0,\\n \\"PaymentStatus\\": 0,\\n \\"UserName\\": \\"\\",\\n \\"OrderId\\": \\"\\",\\n \\"IotId\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'UnbindAllUserByDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5664,34 +3683,22 @@ [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'UnbindSubDevice', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -5699,18 +3706,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ @@ -5719,97 +3718,78 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'UnbindResultMessage' => [ - 'type' => 'string', - ], - 'ProductKey' => [ - 'type' => 'string', - ], - 'DeviceName' => [ - 'type' => 'string', - ], - 'UnbindResultCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'IotId' => [ - 'type' => 'string', - ], + 'UnbindResultMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProductKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UnbindResultCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.GetAccountInfoFailed', - 'errorMessage' => 'Get account info failed.', - ], - [ - 'errorCode' => 'iot.vision.AccountNotFound', - 'errorMessage' => 'Account not found.', - ], - [ - 'errorCode' => 'iot.vision.TenantMismatch', - 'errorMessage' => 'Caller tenant and account belong tenant mismatch.', - ], - [ - 'errorCode' => 'iot.vision.UnbindFailed', - 'errorMessage' => 'Unbind account and device failed.', - ], - [ - 'errorCode' => 'iot.vision.BindingRelationNotFound', - 'errorMessage' => 'Account and device binding relation not found.', - ], - [ - 'errorCode' => 'iot.vision.QueryBindingAccountFailed', - 'errorMessage' => 'Query binding account failed.', - ], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.GetAccountInfoFailed', 'errorMessage' => 'Get account info failed.', 'description' => 'The system failed to query information about the account.'], + ['errorCode' => 'iot.vision.AccountNotFound', 'errorMessage' => 'Account not found.', 'description' => 'The account does not exist.'], + ['errorCode' => 'iot.vision.TenantMismatch', 'errorMessage' => 'Caller tenant and account belong tenant mismatch.', 'description' => 'The tenant of the API operation caller is different from the tenant to which the account belongs.'], + ['errorCode' => 'iot.vision.UnbindFailed', 'errorMessage' => 'Unbind account and device failed.', 'description' => 'The system failed to disassociate the device from the account.'], + ['errorCode' => 'iot.vision.BindingRelationNotFound', 'errorMessage' => 'Account and device binding relation not found.', 'description' => 'The device is not associated with the account.'], + ['errorCode' => 'iot.vision.QueryBindingAccountFailed', 'errorMessage' => 'Query binding account failed.', 'description' => 'The system failed to query associated users.'], ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindAllUserByDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UnbindAllUserByDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"SubDeviceUnbindResult\\": [\\n {\\n \\"UnbindResultMessage\\": \\"\\",\\n \\"ProductKey\\": \\"\\",\\n \\"DeviceName\\": \\"\\",\\n \\"UnbindResultCode\\": 0,\\n \\"IotId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'UnbindDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5820,59 +3800,37 @@ [ 'name' => 'OpenId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'OpenIdAppKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'ProductKey', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'DeviceName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IotId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'IdentityId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'UnbindSubDevice', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'true', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -5880,18 +3838,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'ErrorMessage' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ @@ -5900,161 +3850,907 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'UnbindResultMessage' => [ - 'type' => 'string', - ], - 'ProductKey' => [ - 'type' => 'string', - ], - 'DeviceName' => [ - 'type' => 'string', - ], - 'UnbindResultCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'IotId' => [ - 'type' => 'string', - ], + 'UnbindResultMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProductKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UnbindResultCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'IotId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'iot.vision.UnexpectedInternalError', - 'errorMessage' => 'Unexpected internal error.', - ], - [ - 'errorCode' => 'iot.vision.RequestParamError', - 'errorMessage' => 'Request parameter error.', - ], - [ - 'errorCode' => 'iot.vision.RequestFailed', - 'errorMessage' => 'Request failed.', - ], - [ - 'errorCode' => 'iot.vision.GetAccountInfoFailed', - 'errorMessage' => 'Get account info failed.', - ], - [ - 'errorCode' => 'iot.vision.AccountNotFound', - 'errorMessage' => 'Account not found.', - ], - [ - 'errorCode' => 'iot.vision.TenantMismatch', - 'errorMessage' => 'Caller tenant and account belong tenant mismatch.', + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.RequestFailed', 'errorMessage' => 'Request failed.', 'description' => 'Request failed.'], + ['errorCode' => 'iot.vision.GetAccountInfoFailed', 'errorMessage' => 'Get account info failed.', 'description' => 'The system failed to query information about the account.'], + ['errorCode' => 'iot.vision.AccountNotFound', 'errorMessage' => 'Account not found.', 'description' => 'The account does not exist.'], + ['errorCode' => 'iot.vision.TenantMismatch', 'errorMessage' => 'Caller tenant and account belong tenant mismatch.', 'description' => 'The tenant of the API operation caller is different from the tenant to which the account belongs.'], + ['errorCode' => 'iot.vision.BindingRelationNotFound', 'errorMessage' => 'Account and device binding relation not found.', 'description' => 'The device is not associated with the account.'], + ['errorCode' => 'iot.vision.UnbindFailed', 'errorMessage' => 'Unbind account and device failed.', 'description' => 'The system failed to disassociate the device from the account.'], + ], + 403 => [ + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], + ], + 429 => [ + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UnbindDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'errorCode' => 'iot.vision.BindingRelationNotFound', - 'errorMessage' => 'Account and device binding relation not found.', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"SubDeviceUnbindResult\\": [\\n {\\n \\"UnbindResultMessage\\": \\"\\",\\n \\"ProductKey\\": \\"\\",\\n \\"DeviceName\\": \\"\\",\\n \\"UnbindResultCode\\": 0,\\n \\"IotId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'UploadDeviceNameList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DeviceNames', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => true, + 'maxItems' => 10000, + 'description' => '', + 'title' => '', + 'example' => '', ], - [ - 'errorCode' => 'iot.vision.UnbindFailed', - 'errorMessage' => 'Unbind account and device failed.', + ], + [ + 'name' => 'ProductKey', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'BatchId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'InvalidDetailList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeviceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorMsg' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'RepeatedDeviceNameList' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'InvalidDeviceNameList' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'iot.vision.RequestParamError', 'errorMessage' => 'Request parameter error.', 'description' => 'Request parameter error.'], + ['errorCode' => 'iot.vision.UnexpectedInternalError', 'errorMessage' => 'Unexpected internal error.', 'description' => 'Unexpected internal error.'], + ['errorCode' => 'iot.vision.ActiveCodeInsufficient', 'errorMessage' => 'Active code quota is insufficient.', 'description' => ''], + ['errorCode' => 'iot.vision.DevicesCountExceedLimit', 'errorMessage' => 'The devices count exceed the limit.', 'description' => 'The devices count exceed the limit.'], + ['errorCode' => 'iot.vision.DevicesExceedUnreleasedProductLimit', 'errorMessage' => 'Devices count exceed the limit of unreleased product.', 'description' => ''], + ], 403 => [ - [ - 'errorCode' => 'iot.vision.RequestAuthFailed', - 'errorMessage' => 'Request auth failed.', - ], - [ - 'errorCode' => 'iot.vision.RequestForbidden', - 'errorMessage' => 'Request forbidden.', - ], + ['errorCode' => 'iot.vision.RequestAuthFailed', 'errorMessage' => 'Request auth failed.', 'description' => 'Request auth failed.'], + ['errorCode' => 'iot.vision.RequestForbidden', 'errorMessage' => 'Request forbidden.', 'description' => 'Request forbidden.'], ], 429 => [ - [ - 'errorCode' => 'iot.vision.RequestTrafficControl', - 'errorMessage' => 'Request traffic control.', + ['errorCode' => 'iot.vision.RequestTrafficControl', 'errorMessage' => 'Request traffic control.', 'description' => 'Request traffic control.'], + ], + ], + 'title' => '', + 'summary' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadDeviceNameList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UploadDeviceNameList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"BatchId\\": \\"\\",\\n \\"InvalidDetailList\\": [\\n {\\n \\"DeviceName\\": \\"\\",\\n \\"ErrorMsg\\": \\"\\"\\n }\\n ],\\n \\"RepeatedDeviceNameList\\": [\\n \\"\\"\\n ],\\n \\"InvalidDeviceNameList\\": [\\n \\"\\"\\n ]\\n }\\n}","type":"json"}]', ], ], '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' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.ap-northeast-1.aliyuncs.com', 'endpoint' => 'linkvisual.ap-northeast-1.aliyuncs.com', 'vpc' => 'linkvisual-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.cn-hangzhou.aliyuncs.com', 'endpoint' => 'linkvisual.cn-hangzhou.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.cn-shanghai.aliyuncs.com', 'endpoint' => 'linkvisual.cn-shanghai.aliyuncs.com', 'vpc' => 'linkvisual-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'linkvisual.aliyuncs.com', 'endpoint' => 'linkvisual.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => '403', 'message' => 'tenant auth error', 'http_code' => 200, 'description' => 'The request was denied due to a failure in device or user authentication.'], + ['code' => '403', 'message' => 'request forbidden.', 'http_code' => 200, 'description' => 'The request was forbidden due to a failure in parameter authentication.'], + ['code' => '460', 'message' => 'picture type error.', 'http_code' => 200, 'description' => 'The specified image type is invalid.'], + ['code' => '460', 'message' => 'RAM system auth error.', 'http_code' => 200, 'description' => 'Failed to perform RAM authentication.'], + ['code' => '460', 'message' => 'beginTime can not bigger or equal endTime.', 'http_code' => 200, 'description' => 'The specified beginTime must not be later than the endTime.'], + ['code' => '460', 'message' => 'beginTime or endTime can not be null.', 'http_code' => 200, 'description' => 'Both beginTime and endTime must be specified.'], + ['code' => '460', 'message' => 'product is not active.', 'http_code' => 200, 'description' => 'The device has not activated the video service.'], + ['code' => '466', 'message' => 'request too frequently.', 'http_code' => 200, 'description' => 'The request was sent too frequently.'], + ['code' => '466', 'message' => 'alarm picture exist.', 'http_code' => 200, 'description' => 'The specified alert image was existed, couldn\'t upload again.'], + ['code' => '466', 'message' => 'device offline.', 'http_code' => 200, 'description' => 'The specified device is offline.'], + ['code' => '466', 'message' => 'deviceList lifecycle not exist.', 'http_code' => 200, 'description' => 'The device list life cycle does not exist.'], + ['code' => '466', 'message' => 'triggerPicture failed.', 'http_code' => 200, 'description' => 'The device failed to capture an image.'], + ['code' => '466', 'message' => 'push stream fail.', 'http_code' => 200, 'description' => 'Stream ingest failed.'], + ['code' => '466', 'message' => 'device status is disable.', 'http_code' => 200, 'description' => 'The IoT channel of the device is disabled.'], + ['code' => '466', 'message' => 'device status is initial.', 'http_code' => 200, 'description' => 'The IoT channel for the device has not been activated. It is activated when the device is brought online.'], + ['code' => '466', 'message' => 'device status is offline.', 'http_code' => 200, 'description' => 'The device is offline.'], + ['code' => 'Forbidden.RiskControl', 'message' => 'Your account is at risk. Contact customer support for more details.', 'http_code' => 400, 'description' => ''], + ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error.', 'http_code' => 500, 'description' => 'An unknown error occurred on the server.'], + ['code' => 'iot.common.AuthActionPermissionDeny', 'message' => 'The authorization fails.', 'http_code' => 400, 'description' => 'The authorization fails.'], + ['code' => 'iot.common.RamActionPermissionDeny', 'message' => 'You do not have the RAM permission.', 'http_code' => 400, 'description' => 'The RAM user does not have permissions to access the resource.'], + ['code' => 'iot.lv.requestAuthError', 'message' => 'Request auth error.', 'http_code' => 403, 'description' => 'The verification failed.'], + ['code' => 'iot.lv.requestError', 'message' => 'Post-paid change limit.', 'http_code' => 400, 'description' => ''], + ['code' => 'iot.lv.requestError', 'message' => 'Request error.', 'http_code' => 400, 'description' => 'Request error.'], + ['code' => 'iot.lv.requestError', 'message' => 'Request error', 'http_code' => 400, 'description' => 'Request error'], + ['code' => 'iot.lv.requestParamError', 'message' => 'Request parameter error.', 'http_code' => 403, 'description' => 'The request parameter is invalid.'], + ['code' => 'iot.lv.requestTimeError', 'message' => 'Request time error.', 'http_code' => 403, 'description' => ''], + ['code' => 'iot.system.InstanceNotFound', 'message' => 'The instance ID does not exist.', 'http_code' => 400, 'description' => 'The instance ID does not exist.'], + ['code' => 'iot.system.UidNotFound', 'message' => 'The Alibaba Cloud account does not exist or the IoT Platform service is not activated.', 'http_code' => 400, 'description' => 'The Alibaba Cloud account does not exist or the IoT Platform service is not activated.'], + ['code' => 'iot.vision.AccountAlreadyExist', 'message' => 'Account already exist.', 'http_code' => 400, 'description' => 'The account already exists.'], + ['code' => 'iot.vision.AccountNotFound', 'message' => 'Account not found.', 'http_code' => 400, 'description' => 'The account does not exist.'], + ['code' => 'iot.vision.AccountRegistryAddFailed', 'message' => 'Add account registry failed.', 'http_code' => 400, 'description' => 'Failed to add account registration information.'], + ['code' => 'iot.vision.AccountRegistryLockFailed', 'message' => 'Get account registry lock failed.', 'http_code' => 400, 'description' => 'Failed to obtain a distributed lock during account registration.'], + ['code' => 'iot.vision.AccountRegistryRemoveFailed', 'message' => 'Remove account registry failed.', 'http_code' => 400, 'description' => 'Failed to delete account registration information.'], + ['code' => 'iot.vision.ActiveCodeInsufficient', 'message' => 'Active code quota is insufficient.', 'http_code' => 400, 'description' => ''], + ['code' => 'iot.vision.AppNameExist', 'message' => 'AppName exist.', 'http_code' => 400, 'description' => 'The name that you specified for the application already exists.'], + ['code' => 'iot.vision.BatchHasCreated', 'message' => 'This batch task has been created.', 'http_code' => 400, 'description' => 'This batch task has been created.'], + ['code' => 'iot.vision.BatchUpgradeDeviceFailed', 'message' => 'Batch upgrade device failed:%s', 'http_code' => 400, 'description' => 'The system failed to batch update the devices.'], + ['code' => 'iot.vision.BindFailed', 'message' => 'Bind account and device failed.', 'http_code' => 400, 'description' => 'The system failed to associate the account with the device.'], + ['code' => 'iot.vision.BindingRelationNotFound', 'message' => 'Account and device binding relation not found.', 'http_code' => 400, 'description' => 'The device is not associated with the account.'], + ['code' => 'iot.vision.CancelOTATaskFailed', 'message' => 'Cancel ota task failed:%s', 'http_code' => 400, 'description' => 'The upgrade task failed to be canceled.'], + ['code' => 'iot.vision.CancelUpgradeTaskFailed', 'message' => 'Cancel upgrade task failed:%s', 'http_code' => 400, 'description' => 'The system failed to cancel the device update.'], + ['code' => 'iot.vision.CheckDeviceFileFailed', 'message' => 'Check device file failed:%s', 'http_code' => 400, 'description' => 'The system failed to verify the device list file.'], + ['code' => 'iot.vision.CheckDeviceFileRequestFailed', 'message' => 'Check device file request failed:%s', 'http_code' => 400, 'description' => 'The request to verify the device list file failed.'], + ['code' => 'iot.vision.ConcurrencyExceedLimit', 'message' => 'Concurrency exceed the limit.', 'http_code' => 400, 'description' => 'The number of concurrent threads exceeds the limit.'], + ['code' => 'iot.vision.CreateDeviceFailed', 'message' => 'create device failed.', 'http_code' => 400, 'description' => 'create device failed.'], + ['code' => 'iot.vision.CreateFirmwareFailed', 'message' => 'Create firmware failed:%s', 'http_code' => 400, 'description' => 'The system failed to create the update package.'], + ['code' => 'iot.vision.CreateFirmwareModuleFailed', 'message' => 'Create firmware module failed:%s', 'http_code' => 400, 'description' => 'The system failed to create the update package module.'], + ['code' => 'iot.vision.CreateProductFailed', 'message' => 'Create product failed.', 'http_code' => 400, 'description' => 'Create product failed.'], + ['code' => 'iot.vision.CreateProductNotAllow', 'message' => 'Create product not allow.', 'http_code' => 400, 'description' => 'Create product not allow.'], + ['code' => 'iot.vision.CreateProjectFailed', 'message' => 'Create project failed.', 'http_code' => 400, 'description' => 'Create project failed.'], + ['code' => 'iot.vision.CreateStorageOrderFailed', 'message' => 'Create storage order failed.', 'http_code' => 400, 'description' => 'Create storage order failed.'], + ['code' => 'iot.vision.CreateSubscribeRelationFailed', 'message' => 'Create subscribe relation failed:%s', 'http_code' => 400, 'description' => 'The system failed to create the subscription.'], + ['code' => 'iot.vision.DeleteDeviceFailed', 'message' => 'delete device failed.', 'http_code' => 400, 'description' => 'delete device failed.'], + ['code' => 'iot.vision.DeleteFirmwareFailed', 'message' => 'Delete firmware failed:%s', 'http_code' => 400, 'description' => 'The system failed to delete the update package.'], + ['code' => 'iot.vision.DeleteFirmwareModuleFailed', 'message' => 'Delete firmware module failed:%s', 'http_code' => 400, 'description' => 'The system failed to delete the update package module.'], + ['code' => 'iot.vision.DeleteProductFailed', 'message' => 'Delete product failed.', 'http_code' => 400, 'description' => 'Delete product failed.'], + ['code' => 'iot.vision.DeleteProjectFailed', 'message' => 'Delete project failed.', 'http_code' => 400, 'description' => 'Delete project failed.'], + ['code' => 'iot.vision.DeleteSubscribeRelationFailed', 'message' => 'Delete subscribe relation failed:%s', 'http_code' => 400, 'description' => 'The system failed to delete the subscription.'], + ['code' => 'iot.vision.DevcieOffline', 'message' => 'Device offline.', 'http_code' => 400, 'description' => 'The device is offline.'], + ['code' => 'iot.vision.DeviceInactive', 'message' => 'Device inactive.', 'http_code' => 400, 'description' => 'The device is inactive.'], + ['code' => 'iot.vision.DeviceNameCheckFailed', 'message' => 'Device names check failed.', 'http_code' => 400, 'description' => 'Device names check failed.'], + ['code' => 'iot.vision.DeviceNameChecking', 'message' => 'Device names are checking.', 'http_code' => 400, 'description' => ''], + ['code' => 'iot.vision.DeviceNameDuplicate', 'message' => 'Device name duplicate.', 'http_code' => 400, 'description' => 'The DeviceName already exists.'], + ['code' => 'iot.vision.DeviceNameFormatInvalid', 'message' => 'Device name format invalid.', 'http_code' => 400, 'description' => 'Device name format invalid.'], + ['code' => 'iot.vision.DeviceNicknameInvalid', 'message' => 'Device nickname invalid.', 'http_code' => 400, 'description' => 'Device nickname invalid.'], + ['code' => 'iot.vision.DeviceNoOwner', 'message' => 'Device has no owner.', 'http_code' => 400, 'description' => 'Device has no owner.'], + ['code' => 'iot.vision.DeviceNotExist', 'message' => 'Device not exist.', 'http_code' => 400, 'description' => 'Device not exist.'], + ['code' => 'iot.vision.DeviceNotStreaming', 'message' => 'Device is not streaming.', 'http_code' => 400, 'description' => 'The device does not ingest streams.'], + ['code' => 'iot.vision.DeviceNumLimit', 'message' => 'device num exceed limit.', 'http_code' => 400, 'description' => 'device num exceed limit.'], + ['code' => 'iot.vision.DeviceOffline', 'message' => 'Device is offline.', 'http_code' => 400, 'description' => 'The device is offline.'], + ['code' => 'iot.vision.DeviceOwnerChanged', 'message' => 'Device owner changed.', 'http_code' => 400, 'description' => 'Device owner changed.'], + ['code' => 'iot.vision.DevicePropertyFormatInvalid', 'message' => 'Device property format invalid.', 'http_code' => 400, 'description' => 'Device property format invalid.'], + ['code' => 'iot.vision.DevicesCountExceedLimit', 'message' => 'The devices count exceed the limit.', 'http_code' => 400, 'description' => 'The devices count exceed the limit.'], + ['code' => 'iot.vision.DevicesExceedUnreleasedProductLimit', 'message' => 'Devices count exceed the limit of unreleased product.', 'http_code' => 400, 'description' => ''], + ['code' => 'iot.vision.DownloadJobError', 'message' => 'Download job error.', 'http_code' => 400, 'description' => 'An exception occurred on the download task.'], + ['code' => 'iot.vision.FirmwareNotFound', 'message' => 'The specified firmware does not exist.', 'http_code' => 400, 'description' => 'No update package of the version exists.'], + ['code' => 'iot.vision.FirmwareNotVerified', 'message' => 'Firmware validation not completed.', 'http_code' => 400, 'description' => 'The update package is verified.'], + ['code' => 'iot.vision.FirmwareSourceVersionMismatch', 'message' => 'Current firmware version of device does not match source version of firmware.', 'http_code' => 400, 'description' => 'The current version number of the device does not match the original version number of the update package.'], + ['code' => 'iot.vision.FirmwareVerifyFailed', 'message' => 'Firmware verify failed.', 'http_code' => 400, 'description' => 'The system failed to verify the update package.'], + ['code' => 'iot.vision.FirmwareVersionMismatch', 'message' => 'The version of firmware mismatch.', 'http_code' => 400, 'description' => 'The version number of the update package does not match the specified version number.'], + ['code' => 'iot.vision.FreeStorageLimit', 'message' => 'Free storage quota exceed limit.', 'http_code' => 400, 'description' => 'Free storage quota exceed limit.'], + ['code' => 'iot.vision.FreeStorageQuotaLimit', 'message' => 'No enough free storage quota or exceed limit.', 'http_code' => 400, 'description' => 'No enough free storage quota or exceed limit.'], + ['code' => 'iot.vision.GbIdDuplicate', 'message' => 'The GB28181 deviceId is duplicated.', 'http_code' => 400, 'description' => 'The standard ID already exists.'], + ['code' => 'iot.vision.GbServiceNotEnabled', 'message' => 'The GB28181 service has not been enabled.', 'http_code' => 400, 'description' => 'The standard service is not started.'], + ['code' => 'iot.vision.GenerateDeviceNameListUrlFailed', 'message' => 'Generate device name list url failed:%s', 'http_code' => 400, 'description' => 'The system failed to generate a device list upload URL.'], + ['code' => 'iot.vision.GenerateFirmwareUploadUrlFailed', 'message' => 'Generate firmware upload url failed:%s', 'http_code' => 400, 'description' => 'The system failed to generate a firmware upload URL.'], + ['code' => 'iot.vision.GetAccountInfoFailed', 'message' => 'Get account info failed.', 'http_code' => 400, 'description' => 'The system failed to query information about the account.'], + ['code' => 'iot.vision.GetDeviceInfoFailed', 'message' => 'Get device info failed.', 'http_code' => 400, 'description' => 'The system failed to query the details of the device.'], + ['code' => 'iot.vision.GetOwnerIdentityInfoFailed', 'message' => 'Get owner identity info failed.', 'http_code' => 400, 'description' => 'The system failed to query information about the device administrator.'], + ['code' => 'iot.vision.GetThingEventSnapshotFailed', 'message' => 'Get thing event snapshot failed.', 'http_code' => 400, 'description' => 'The system failed to query TSL event snapshots.'], + ['code' => 'iot.vision.HasNoAccessPermission', 'message' => 'Has no access permission.', 'http_code' => 403, 'description' => ''], + ['code' => 'iot.vision.HasRelatedProduct', 'message' => 'Has related product.', 'http_code' => 400, 'description' => 'One or more associated products cannot be deleted.'], + ['code' => 'iot.vision.IdentityAppKeyProductNotBind', 'message' => 'The app associated with the identityId does not have permission to access the product.', 'http_code' => 400, 'description' => 'No product is associated with the AppKey that is related to the account.'], + ['code' => 'iot.vision.ImportProjectFailed', 'message' => 'Import project failed.', 'http_code' => 400, 'description' => 'Import project failed.'], + ['code' => 'iot.vision.InstanceArrearage', 'message' => 'Instance arrearage.', 'http_code' => 400, 'description' => 'Instance arrearage.'], + ['code' => 'iot.vision.InvalidCallerType', 'message' => 'Invalid caller type.', 'http_code' => 400, 'description' => 'Invalid caller type.'], + ['code' => 'iot.vision.InvalidFirmwareId', 'message' => 'Invalid firmware Id.', 'http_code' => 400, 'description' => 'The ID of the update package is invalid.'], + ['code' => 'iot.vision.InvalidIotInstance', 'message' => 'Invalid iot instance.', 'http_code' => 400, 'description' => 'Invalid iot instance.'], + ['code' => 'iot.vision.InvalidStorageCommodity', 'message' => 'Invalid storage commodity.', 'http_code' => 400, 'description' => 'Invalid storage commodity.'], + ['code' => 'iot.vision.InvalidStorageOrder', 'message' => 'Invalid storage order.', 'http_code' => 400, 'description' => 'Invalid storage order.'], + ['code' => 'iot.vision.InvokeServiceFailed', 'message' => '%s', 'http_code' => 400, 'description' => 'The system failed to call the TSL service.'], + ['code' => 'iot.vision.InvokeServiceFailed', 'message' => '%s failed.', 'http_code' => 400, 'description' => 'The system failed to call the TSL service.'], + ['code' => 'iot.vision.InvokeServiceFailed', 'message' => 'Invoke service failed:%s', 'http_code' => 400, 'description' => 'The system failed to call the TSL service.'], + ['code' => 'iot.vision.JobNotExist', 'message' => 'Job not exist or expired.', 'http_code' => 400, 'description' => 'The task does not exist or has expired.'], + ['code' => 'iot.vision.ModifyFirmwareFailed', 'message' => 'Modify firmware failed:%s', 'http_code' => 400, 'description' => 'The system failed to modify the update package.'], + ['code' => 'iot.vision.NoAvailableActiveCode', 'message' => 'No available active codes.', 'http_code' => 400, 'description' => 'No available active codes.'], + ['code' => 'iot.vision.NoStorageQuota', 'message' => 'No storage quota.', 'http_code' => 400, 'description' => 'The storage quota is exceeded.'], + ['code' => 'iot.vision.ParamBatchIdInvalid', 'message' => 'Parameter batchId is invalid.', 'http_code' => 400, 'description' => 'Parameter batchId is invalid.'], + ['code' => 'iot.vision.PreviousImportProjectTaskNotFinished', 'message' => 'Previous import project task not finished.', 'http_code' => 400, 'description' => 'Previous import project task not finished.'], + ['code' => 'iot.vision.ProductCancelReleaseFailed.', 'message' => 'Product cancel release failed.', 'http_code' => 400, 'description' => 'Product cancel release failed.'], + ['code' => 'iot.vision.ProductHasRelatedAuthorization', 'message' => 'Product has related authorization.', 'http_code' => 400, 'description' => 'Product has related authorization.'], + ['code' => 'iot.vision.ProductHasRelatedResource', 'message' => 'Product has related resource.', 'http_code' => 400, 'description' => 'Product has related resource.'], + ['code' => 'iot.vision.ProductKeyFormatInvalid', 'message' => 'Product key format invalid.', 'http_code' => 400, 'description' => 'Product key format invalid.'], + ['code' => 'iot.vision.ProductNameDuplicated', 'message' => 'Product name duplicated.', 'http_code' => 400, 'description' => 'Product name duplicated.'], + ['code' => 'iot.vision.ProductNameFormatInvalid', 'message' => 'Product name format invalid.', 'http_code' => 400, 'description' => 'Product name format invalid.'], + ['code' => 'iot.vision.ProductNameLengthInvalid', 'message' => 'Product name length invalid.', 'http_code' => 400, 'description' => 'Product name length invalid.'], + ['code' => 'iot.vision.ProductNotExist', 'message' => 'Product not exist.', 'http_code' => 400, 'description' => 'Product not exist.'], + ['code' => 'iot.vision.ProductNotRelease', 'message' => 'Product not release.', 'http_code' => 400, 'description' => 'Product not release.'], + ['code' => 'iot.vision.ProductNumLimit', 'message' => 'Product number exceed limit.', 'http_code' => 400, 'description' => 'Product number exceed limit.'], + ['code' => 'iot.vision.ProductReleased', 'message' => 'Product had been released.', 'http_code' => 400, 'description' => 'Product had been released.'], + ['code' => 'iot.vision.ProductReleaseFailed', 'message' => 'Product release failed.', 'http_code' => 400, 'description' => 'Product release failed.'], + ['code' => 'iot.vision.ProductShouldNotDelete', 'message' => 'Product should not delete.', 'http_code' => 400, 'description' => 'Product should not delete.'], + ['code' => 'iot.vision.ProductShouldNotEdit', 'message' => 'Product should not edit.', 'http_code' => 400, 'description' => 'Product should not edit.'], + ['code' => 'iot.vision.ProductTagDuplicated', 'message' => 'Product tag duplicated.', 'http_code' => 400, 'description' => 'Product tag duplicated.'], + ['code' => 'iot.vision.ProductTagLengthInvalid', 'message' => 'Product tag length invalid.', 'http_code' => 400, 'description' => 'Product tag length invalid.'], + ['code' => 'iot.vision.ProductTagNotFound', 'message' => 'Product tag not found.', 'http_code' => 400, 'description' => 'Product tag not found.'], + ['code' => 'iot.vision.ProductTagNumLimit', 'message' => 'Product tag num limit.', 'http_code' => 400, 'description' => 'Product tag num limit.'], + ['code' => 'iot.vision.ProductTypeMismatch', 'message' => 'Product type mismatch.', 'http_code' => 400, 'description' => 'Product type mismatch.'], + ['code' => 'iot.vision.ProductUpdateFailed', 'message' => 'Product update failed.', 'http_code' => 400, 'description' => 'Product update failed.'], + ['code' => 'iot.vision.ProjectCreateLimit', 'message' => 'Project still in initializing please try again later.', 'http_code' => 400, 'description' => 'One or more of your projects are being created. Try again later.'], + ['code' => 'iot.vision.ProjectHasNoProducts', 'message' => 'Project has no products.', 'http_code' => 400, 'description' => 'Project has no products.'], + ['code' => 'iot.vision.ProjectHasRelatedResource', 'message' => 'Project has related resource.', 'http_code' => 400, 'description' => 'Project has related resource.'], + ['code' => 'iot.vision.ProjectNameDuplicated', 'message' => 'Project name duplicated.', 'http_code' => 400, 'description' => 'Project name duplicated.'], + ['code' => 'iot.vision.ProjectNameLengthInvalid', 'message' => 'Project name length invalid.', 'http_code' => 400, 'description' => 'Project name length invalid.'], + ['code' => 'iot.vision.ProjectNotExist', 'message' => 'Project does not exist.', 'http_code' => 400, 'description' => 'Project does not exist.'], + ['code' => 'iot.vision.ProjectNumLimit', 'message' => 'Project num exceed limit.', 'http_code' => 400, 'description' => 'Project num exceed limit.'], + ['code' => 'iot.vision.PropertyNotFound', 'message' => 'Property not found.', 'http_code' => 400, 'description' => 'The TSL property does not exist.'], + ['code' => 'iot.vision.PropertyReadOnly', 'message' => 'Property is read only.', 'http_code' => 400, 'description' => 'The TSL property is read-only.'], + ['code' => 'iot.vision.QueryAppListError', 'message' => 'No Result.', 'http_code' => 400, 'description' => 'No Result.'], + ['code' => 'iot.vision.QueryBindingAccountFailed', 'message' => 'Query binding account failed.', 'http_code' => 400, 'description' => 'The system failed to query associated users.'], + ['code' => 'iot.vision.QueryBindingDeviceFailed', 'message' => 'Query binding device failed.', 'http_code' => 400, 'description' => 'The system failed to query the associated device list.'], + ['code' => 'iot.vision.QueryCommodityPriceFailed', 'message' => 'Query commodity price failed.', 'http_code' => 400, 'description' => 'The system failed to query the price of the cloud storage product.'], + ['code' => 'iot.vision.QueryConsumerGroupFailed', 'message' => 'Query consumer group failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the consumer group.'], + ['code' => 'iot.vision.QueryDeviceFailed', 'message' => 'query device failed.', 'http_code' => 400, 'description' => 'query device failed.'], + ['code' => 'iot.vision.QueryDeviceGroupFailed', 'message' => 'Query device group failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the device group.'], + ['code' => 'iot.vision.QueryDeviceUpgradeCountFailed', 'message' => 'Query device upgrade count failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the number of device updates.'], + ['code' => 'iot.vision.QueryDeviceUpgradeInfoFailed', 'message' => 'Query device upgrade info failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the update status of the device.'], + ['code' => 'iot.vision.QueryDeviceVersionStatisticsFailed', 'message' => 'Query device version statistics failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the details of the distribution of device versions.'], + ['code' => 'iot.vision.QueryFirmwareFailed', 'message' => 'Query firmware failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the firmware.'], + ['code' => 'iot.vision.QueryFirmwareModuleFailed', 'message' => 'Query firmware module failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the update package module.'], + ['code' => 'iot.vision.QueryFirmwareVersionFailed', 'message' => 'Query firmware version failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the update package version.'], + ['code' => 'iot.vision.QueryProductRelatedDeviceFailed', 'message' => 'Query product related device failed.', 'http_code' => 400, 'description' => 'Query product related device failed.'], + ['code' => 'iot.vision.QuerySubscribeRelationFailed', 'message' => 'Query subscribe relation failed:%s', 'http_code' => 400, 'description' => 'The system failed to query subscriptions.'], + ['code' => 'iot.vision.QueryUpgradeDefaultTimeoutFailed', 'message' => 'Query upgrade default timeout failed:%s', 'http_code' => 400, 'description' => 'The request to query the default timeout period of the update failed.'], + ['code' => 'iot.vision.QueryUpgradeDeviceFailed', 'message' => 'Query upgrade device failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the device to be updated.'], + ['code' => 'iot.vision.QueryUpgradeStatisticsInfoFailed', 'message' => 'Query upgrade statistics info failed:%s', 'http_code' => 400, 'description' => 'The system failed to query statistics on updates.'], + ['code' => 'iot.vision.QueryUpgradeTaskFailed', 'message' => 'Query upgrade task failed:%s', 'http_code' => 400, 'description' => 'The system failed to query the update task.'], + ['code' => 'iot.vision.RecordNotExist', 'message' => 'Record not exist.', 'http_code' => 400, 'description' => 'The video file does not exist.'], + ['code' => 'iot.vision.RefreshTooFrequently', 'message' => 'Refresh too frequently.', 'http_code' => 400, 'description' => 'Refresh requests are submitted too frequently.'], + ['code' => 'iot.vision.RequestAuthFailed', 'message' => 'Request auth failed.', 'http_code' => 403, 'description' => 'Request auth failed.'], + ['code' => 'iot.vision.RequestError', 'message' => 'Request error.', 'http_code' => 400, 'description' => 'The request failed.'], + ['code' => 'iot.vision.RequestFailed', 'message' => 'Request failed.', 'http_code' => 400, 'description' => 'Request failed.'], + ['code' => 'iot.vision.RequestFailed', 'message' => 'product already publish operation not allowed.', 'http_code' => 400, 'description' => 'The operation cannot be performed on the product because the product is published.'], + ['code' => 'iot.vision.RequestFailed', 'message' => 'product not exist.', 'http_code' => 400, 'description' => 'The product does not exist.'], + ['code' => 'iot.vision.RequestForbidden', 'message' => 'Request forbidden.', 'http_code' => 403, 'description' => 'Request forbidden.'], + ['code' => 'iot.vision.RequestParamError', 'message' => 'Request parameter error.', 'http_code' => 400, 'description' => 'Request parameter error.'], + ['code' => 'iot.vision.RequestParamError', 'message' => 'Request parameter error:%s', 'http_code' => 400, 'description' => 'The request parameter is invalid.'], + ['code' => 'iot.vision.RequestParameterError', 'message' => 'Request parameter error:%s', 'http_code' => 400, 'description' => 'The request parameter is invalid.'], + ['code' => 'iot.vision.RequestTrafficControl', 'message' => 'Request traffic control.', 'http_code' => 429, 'description' => 'Request traffic control.'], + ['code' => 'iot.vision.ReUpgradeDeviceFailed', 'message' => 'ReUpgrade device failed:%s', 'http_code' => 400, 'description' => 'The system failed to re-update the device.'], + ['code' => 'iot.vision.RtmpKeyNotSet', 'message' => 'Rtmp key not set.', 'http_code' => 400, 'description' => 'No authentication key is specified.'], + ['code' => 'iot.vision.ServerError', 'message' => 'server error.', 'http_code' => 400, 'description' => 'server error.'], + ['code' => 'iot.vision.ServiceEnumSpecError', 'message' => 'Service enum spec error.', 'http_code' => 400, 'description' => 'The enumeration parameter of the TSL service is invalid.'], + ['code' => 'iot.vision.ServiceNotFound', 'message' => 'Invoke service failed as service not found.', 'http_code' => 400, 'description' => 'The TSL service does not exist.'], + ['code' => 'iot.vision.ServiceParamNotExist', 'message' => 'Invoke service failed as service param not exist.', 'http_code' => 400, 'description' => 'The parameter of the TSL service does not exist.'], + ['code' => 'iot.vision.ServiceResponseTimeout', 'message' => 'Invoke service response timeout.', 'http_code' => 400, 'description' => 'The device response timed out.'], + ['code' => 'iot.vision.SetAccountFailed', 'message' => 'Set account failed.', 'http_code' => 400, 'description' => 'Set account failed.'], + ['code' => 'iot.vision.SetDefaultRecordPlanFailed', 'message' => 'Set default record plan failed.', 'http_code' => 400, 'description' => 'The system failed to configure the default video recording plan.'], + ['code' => 'iot.vision.SetPropertyFailed', 'message' => 'Set property failed.', 'http_code' => 400, 'description' => 'The system failed to configure the TSL property.'], + ['code' => 'iot.vision.StorageCommodityUnavailable', 'message' => 'Storage commodity unavailable.', 'http_code' => 400, 'description' => 'You cannot use the cloud storage product.'], + ['code' => 'iot.vision.StorageOrderAlreadyPaid', 'message' => 'Storage order had been paid.', 'http_code' => 400, 'description' => 'The payment for the cloud storage order is complete.'], + ['code' => 'iot.vision.StorageOrderGetLockFailed', 'message' => 'Get storage order lock failed try again later.', 'http_code' => 400, 'description' => 'The system failed to obtain the distributed lock of the cloud storage order. Try again later.'], + ['code' => 'iot.vision.StorageOrderPayFailed', 'message' => 'Storage order pay failed.', 'http_code' => 400, 'description' => 'The payment for the cloud storage order failed.'], + ['code' => 'iot.vision.StorageOrderStatusInvalid', 'message' => 'Storage order status invalid.', 'http_code' => 400, 'description' => 'You cannot perform the operation on the cloud storage order.'], + ['code' => 'iot.vision.StreamNameDuplicate', 'message' => 'Stream name duplicate.', 'http_code' => 400, 'description' => 'The stream name already exists.'], + ['code' => 'iot.vision.StreamPushFailed', 'message' => 'Stream push failed.', 'http_code' => 400, 'description' => 'The stream ingest failed.'], + ['code' => 'iot.vision.TargetDeviceOwnerDifferent', 'message' => 'Target device owner is different.', 'http_code' => 400, 'description' => 'The administrator of the destination device is different from the administrator of the order to be transferred.'], + ['code' => 'iot.vision.TemplateMacroInvalid', 'message' => 'macro invalid.', 'http_code' => 400, 'description' => 'The format of the macro is invalid.'], + ['code' => 'iot.vision.TemplateTextInvalid', 'message' => 'var or text invalid.', 'http_code' => 400, 'description' => 'The format of the variable or the text is invalid.'], + ['code' => 'iot.vision.TenantMismatch', 'message' => 'Caller tenant and account belong tenant mismatch.', 'http_code' => 400, 'description' => 'The tenant of the API operation caller is different from the tenant to which the account belongs.'], + ['code' => 'iot.vision.ThingAbilityNameDuplicated', 'message' => 'Thing model ability name duplicated.', 'http_code' => 400, 'description' => 'The name that you specified for the TSL feature already exists.'], + ['code' => 'iot.vision.ThingEventNotFound', 'message' => 'Thing event not found.', 'http_code' => 400, 'description' => 'The TSL event does not exist.'], + ['code' => 'iot.vision.ThingModelAbilityDuplicated', 'message' => 'Thing model ability duplicated.', 'http_code' => 400, 'description' => 'Thing model ability duplicated.'], + ['code' => 'iot.vision.ThingModelIdentifierNotExist', 'message' => 'Thing model identifier not exist.', 'http_code' => 400, 'description' => 'Thing model identifier not exist.'], + ['code' => 'iot.vision.ThingModelNotExist', 'message' => 'Thing model not exist.', 'http_code' => 400, 'description' => 'Thing model not exist.'], + ['code' => 'iot.vision.ThingModelParamsFormatInvalid', 'message' => 'Thing model params format invalid.', 'http_code' => 400, 'description' => 'Thing model params format invalid.'], + ['code' => 'iot.vision.ThingModelParamsInvalid', 'message' => 'Thing model params invalid.', 'http_code' => 400, 'description' => 'Thing model params invalid.'], + ['code' => 'iot.vision.ThingModelUpdateFailed', 'message' => 'Thing model update failed.', 'http_code' => 400, 'description' => 'The modification on the TSL model failed to take effect.'], + ['code' => 'iot.vision.UnbindFailed', 'message' => 'Unbind account and device failed.', 'http_code' => 400, 'description' => 'The system failed to disassociate the device from the account.'], + ['code' => 'iot.vision.UnexpectedInternalError', 'message' => 'Unexpected internal error.', 'http_code' => 400, 'description' => 'Unexpected internal error.'], + ['code' => 'iot.vision.UpdateConsumerGroupFailed', 'message' => 'Update consumer group failed:%s', 'http_code' => 400, 'description' => 'The system failed to update the consumer group.'], + ['code' => 'iot.vision.UpdateFirmwareModuleFailed', 'message' => 'Update firmware module failed:%s', 'http_code' => 400, 'description' => 'The system failed to update the update package module.'], + ['code' => 'iot.vision.UpdateOTATaskStrategyFailed', 'message' => 'Update ota task strategy failed:%s', 'http_code' => 400, 'description' => 'Failed to update the OTA upgrade task policy.'], + ['code' => 'iot.vision.UpdateSubscribeRelationFailed', 'message' => 'Update subscribe relation failed:%s', 'http_code' => 400, 'description' => 'The system failed to update the subscription.'], + ['code' => 'iot.vision.VerifyFirmwareRequestFailed', 'message' => 'Verify firmware request failed:%s', 'http_code' => 400, 'description' => 'The request to verify the update package failed.'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetThingEventSnapshot'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FreezeFreeStorage'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubDeviceList'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStorageOrder'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDevicesDownloadUrl'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransferStorageOrder'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetThingProperty'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeviceStatus'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableFreeStorage'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'FreezeStorageOrder'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryFreeStorage'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindDevice'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBindingDeviceByAccount'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryBatchStatus'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateDevice'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindAllUserByDevice'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryGenerateDevicesRecord'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckFreeStorageValid'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableStorageOrder'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindStorageOrder'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetThingPropertySnapshot'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStorageOrderList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GenerateDeviceByBatchId'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadDeviceNameList'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryDeviceDetail'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InvokeThingService'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBindingAccountByDevice'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAndPayStorageOrder'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryStorageCommodityList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryGenerateDevicesInfoList'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchBindDevice'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountById'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConsumeFreeStorage'], ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'linkvisual.aliyuncs.com', + ], + 'ram' => [ + 'productCode' => 'LinkVisual', + 'productName' => 'Link Visual', + 'ramCodes' => ['linkvisual'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'FreezeStorageOrder', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:FreezeStorageOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateDeviceByBatchId', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GenerateDeviceByBatchId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnableFreeStorage', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:EnableFreeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryFreeStorage', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryFreeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAndPayStorageOrder', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CreateAndPayStorageOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetThingProperty', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:SetThingProperty', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListBindingDeviceByAccount', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:ListBindingDeviceByAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnableStorageOrder', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:EnableStorageOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetThingEventSnapshot', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GetThingEventSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryStorageOrder', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryStorageOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GenerateDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GenerateDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryDeviceDetail', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDeviceDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UploadDeviceNameList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UploadDeviceNameList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'FreezeFreeStorage', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:FreezeFreeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryGenerateDevicesRecord', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryGenerateDevicesRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryStorageCommodityList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryStorageCommodityList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CheckFreeStorageValid', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:CheckFreeStorageValid', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UnbindDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UnbindDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'InvokeThingService', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:InvokeThingService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UnbindAllUserByDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:UnbindAllUserByDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'TransferStorageOrder', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:TransferStorageOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryGenerateDevicesInfoList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryGenerateDevicesInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryDevicesDownloadUrl', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryDevicesDownloadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BindStorageOrder', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:BindStorageOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSubDeviceList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GetSubDeviceList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetThingPropertySnapshot', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GetThingPropertySnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDeviceStatus', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GetDeviceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAccountById', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:GetAccountById', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryBatchStatus', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryBatchStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BatchBindDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:BatchBindDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ConsumeFreeStorage', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:ConsumeFreeStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListBindingAccountByDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:ListBindingAccountByDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryStorageOrderList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'linkvisual:QueryStorageOrderList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'LinkVisual', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; |