'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Linkvisual',
'version' => '2018-01-20',
],
'directories' => [
[
'id' => 65321,
'title' => null,
'type' => 'directory',
'children' => [
'AddEventRecordPlanDevice',
'CreateEventRecordPlan',
'DeleteEventRecordPlan',
'DeleteEventRecordPlanDevice',
'QueryDeviceEventPicture',
],
],
[
'id' => 65327,
'title' => null,
'type' => 'directory',
'children' => [
'CreateTimeTemplate',
'DeleteTimeTemplate',
'UpdateTimeTemplate',
'QueryTimeTemplateDetail',
],
],
[
'id' => 65339,
'title' => null,
'type' => 'directory',
'children' => [
'AddFaceDeviceGroup',
'AddFaceDeviceToDeviceGroup',
'DeleteFaceDeviceGroup',
'SetDevicePictureLifeCycle',
'StopLiveStreaming',
'QueryDeviceEvent',
'QueryDevicePictureFile',
'QueryDevicePictureLifeCycle',
'QueryDeviceVodUrlByTime',
'QueryFaceAllDeviceGroup',
'QueryFaceDeviceGroupsByDevice',
'QueryLiveStreaming',
'QueryVoiceIntercom',
'RemoveFaceDeviceFromDeviceGroup',
],
],
[
'id' => 65364,
'title' => null,
'type' => 'directory',
'children' => [
'AddFaceUserGroup',
'AddFaceUserToUserGroup',
'DeleteFaceUserGroup',
'UpdateFaceUserGroupAndDeviceGroupRelation',
'UpdateFaceUser',
'QueryFaceAllUserGroupAndDeviceGroupRelation',
'QueryFaceUserGroupAndDeviceGroupRelation',
'QueryFaceUserIdByCustomUserId',
'QueryFaceAllUserGroup',
'QueryFaceAllUserIdsByGroupId',
'QueryFaceCustomUserIdByUserId',
'QueryFaceUser',
'QueryFaceUserGroup',
'RemoveFaceUserFromUserGroup',
],
],
[
'id' => 65379,
'title' => null,
'type' => 'directory',
'children' => [
'AddFaceUser',
'AddFaceUserGroupAndDeviceGroupRelation',
'AddFaceUserPicture',
'DeleteFaceUser',
'DeleteFaceUserGroupAndDeviceGroupRelation',
'DeleteFaceUserPicture',
'CheckFaceUserDoExistOnDevice',
'ClearFaceDeviceDB',
],
],
[
'id' => 65389,
'title' => null,
'type' => 'directory',
'children' => [
'CreatePictureSearchApp',
'CreatePictureSearchJob',
'UpdatePictureSearchApp',
'QueryPictureSearchAiboxes',
'QueryPictureSearchApps',
'QueryPictureSearchDevices',
'QueryPictureSearchJob',
'QueryPictureSearchJobResult',
'GetPictureSearchJobStatus',
'QueryPictureFiles',
'BindPictureSearchAppWithDevices',
'UnbindPictureSearchAppWithDevices',
'PictureSearchPicture',
'TriggerCapturePicture',
],
],
[
'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',
],
],
[
'id' => 177204,
'title' => null,
'type' => 'directory',
'children' => [
'QueryDevicePictureByList',
'TransferDeviceInstance',
'QueryRecordDownloadUrl',
'CreateLocalFileUploadJob',
'DeleteLocalFileUploadJob',
'QueryLocalFileUploadJob',
'QueryFaceUserBatch',
'QueryFaceUserByName',
'DeleteRecord',
'QueryRecordUrlByTime',
'QueryCarProcessEvents',
'DeletePicture',
'UpdateInstanceInternetProtocol',
'CreateRecordDownloadByTimeJob',
'QueryRecordDownloadJobById',
'QueryRecordDownloadJobList',
'CreateLocalRecordDownloadByTimeJob',
'BatchQueryVisionDeviceInfo',
'CreateRtmpDevice',
'DeleteRtmpDevice',
'DeleteRtmpKey',
'QueryRtmpKey',
'QueryVisionDeviceInfo',
'UpdateRtmpKey',
'CreateGbDevice',
'DeleteGbDevice',
'EnableGbSubDevice',
'QueryGbSubDeviceList',
'RefreshGbSubDeviceList',
'UpdateGbDevice',
'CreateStreamPushJob',
'CreateStreamSnapshotJob',
'DeleteStreamPushJob',
'DeleteStreamSnapshotJob',
'QueryStreamPushJob',
'QueryStreamPushJobList',
'QueryStreamSnapshotJob',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AddEventRecordPlanDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zLZyi6aOLyOSHa9hsPyD00****',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
[
'name' => 'PlanId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '5b60bf0dd55944c19d7817442bc9****',
],
],
],
'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' => 'request forbidden',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"request forbidden\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'AddEventRecordPlanDevice',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateEventRecordPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'fc82774fa749485bad7d719f9670****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'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',
],
],
],
],
],
'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":" \\na195f615-8c64-4cc6-af57-2f42c6cca15c\\nfc82774fa749485bad7d719f9670****\\n200\\ntrue\\n ","errorExample":""}]',
'title' => 'CreateEventRecordPlan',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteEventRecordPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'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',
],
],
],
],
],
'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":"\\n438A20F2-AFF2-4CAC-89F9-3378EAA133BD\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'DeleteEventRecordPlan',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteEventRecordPlanDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zLZyi6aOLyOSHa9hsPyD00****',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'tenant auth error',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'DeleteEventRecordPlanDevice',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDeviceEventPicture' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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' => 'EventId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ae6b74f1dc7d402****32c21018****f1608036****71',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'Data' => [
'description' => '',
'type' => 'string',
'example' => 'oss://***/***.jpg',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'product is not active',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Data\\": \\"oss://***/***.jpg\\",\\n \\"ErrorMessage\\": \\"product is not active\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n 200\\n true\\n \\n oss://***/***.jpg\\n \\n","errorExample":""}]',
'title' => 'QueryDeviceEventPicture',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateTimeTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'TimeSections',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DayOfWeek' => [
'description' => '',
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'example',
],
],
[
'name' => 'AllDay',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'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',
],
],
],
],
],
'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":"\\nAD8BAA6B-1197-48DC-A42B-F5986ADF9BFE\\n38c94f874f2e4ce3b4b6da3****65213\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'CreateTimeTemplate',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteTimeTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'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',
],
],
],
],
],
'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":"\\r\\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\r\\n 200\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'DeleteTimeTemplate',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateTimeTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'TimeSections',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DayOfWeek' => [
'description' => '',
'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' => 'TemplateId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'fc82774fa749485bad7d719f9670****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'AllDay',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'tenant auth error',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\r\\n 200\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'UpdateTimeTemplate',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryTimeTemplateDetail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'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' => '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',
],
],
],
],
],
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n 0\\n 0\\n 36f06322442e4e3f85a5ae8862c9****\\n test\\n \\n 0\\n 20000\\n 60000\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryTimeTemplateDetail',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddFaceDeviceGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ZheJiangHZ',
],
],
[
'name' => 'DeviceGroupName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestDeviceGroup',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
],
],
'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":"\\n 0A13279A-5640-45E7-87AA-83750541AD0E\\n \\n 2020-11-20 18:59:01\\n TestDeviceGroup\\n kvjy****\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => 'AddFaceDeviceGroup',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddFaceDeviceToDeviceGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'a1Tp7KYZHHK',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestDevice',
],
],
[
'name' => 'DeviceGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'kvjyhurc',
],
],
],
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'AddFaceDeviceToDeviceGroup',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteFaceDeviceGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestIsolationId',
],
],
[
'name' => 'DeviceGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'qaf2tihq',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'DeleteFaceDeviceGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetDevicePictureLifeCycle' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHR****c300',
],
],
[
'name' => 'Day',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '7',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'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',
],
],
],
],
],
'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":"\\n449ECE75-A36A-4ACE-B253-147C78C440C5\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'SetDevicePictureLifeCycle',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'StopLiveStreaming' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
[
'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' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y59****',
],
],
],
'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',
],
],
],
],
],
'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":"\\r\\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\r\\n 200\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'StopLiveStreaming',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDeviceEvent' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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' => 'EventType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'BeginTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1539507310000',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1539607310000',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y****',
],
],
],
'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' => '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' => '{}',
],
],
],
],
],
],
],
],
],
],
'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":" \\n1FCB5660-020D-40A5-9313-F4F4F493A41F\\n\\n 10\\n 1\\n 2\\n 1\\n \\n 移动侦测\\n 1\\n 2020-12-15 20:40:49\\n ae6b74f1dc7d40218****85967f_1608****471\\n aEtMSm9****ORTFxcGpTbDZ****6eTk0\\n {}\\n
\\n \\n 移动侦测\\n 1\\n 2020-12-15 20:40:29\\n 5650d1cdc****8504520e037b2c_16****9466\\n adsvtMSm9****ORTFkjfdmskDZ****6eTk0\\n {}\\n
\\n 200\\n true\\n\\n ","errorExample":""}]',
'title' => 'QueryDeviceEvent',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDevicePictureFile' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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' => 'CaptureId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'fdc576d03c094faea9fa10fbf48c****',
],
],
[
'name' => 'ThumbWidth',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
'default' => '0',
],
],
[
'name' => 'ExpireTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '60',
'default' => '0',
],
],
[
'name' => 'PictureType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '2',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y******',
],
],
],
'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' => 'request forbidden',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'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',
],
],
],
],
],
],
],
'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":"\\nB6E3F040-F2FD-5B6C-89B2-C3B58D22A5A0\\n\\n 1CJ0***kQi1000000\\n https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***2Cq_90\\n https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/E***3D\\n 1632453652222\\n R****bVhsNCjMjIy\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryDevicePictureFile',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDevicePictureLifeCycle' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
],
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Day' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '7',
],
'IotId' => [
'description' => '',
'type' => 'string',
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0E2244FD-0AC9-4AB4-A8F0-729D78BE1D77\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Day\\": 7,\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n0E2244FD-0AC9-4AB4-A8F0-729D78BE1D77\\n\\n C47T6xwp6ms4bNlkHRWCg4****\\n 7\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryDevicePictureLifeCycle',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDeviceVodUrlByTime' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'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****',
],
],
[
'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' => 'EnableStun',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'ShouldEncrypt',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'BeginTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '2147483648',
'minimum' => '0',
'example' => '1508200012',
],
],
[
'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',
],
],
[
'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',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'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',
],
],
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n MDEy****OTo7PD0+Pw==\\n eA2r****fHjOmnyBfQ==\\n\\n\\n 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\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryDeviceVodUrlByTime',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFaceAllDeviceGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestIsolationId',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestIotInstanceId',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '20',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'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',
],
],
],
],
],
],
],
],
],
],
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n 20\\n 100\\n \\n 2020-05-12 17:19:29\\n TestDeviceGroupName\\n wy250q0m\\n \\n 1\\n\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'QueryFaceAllDeviceGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFaceDeviceGroupsByDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestIsolationId',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestIotInstanceId',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestProductKey',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestDeviceName',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '20',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'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',
],
],
],
],
],
],
],
],
],
],
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n 20\\n 5\\n \\n 2020-05-12 17:12:37\\n TestDeviceGroupName\\n TestDeviceGroupId\\n \\n 1\\n\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'QueryFaceDeviceGroupsByDevice',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryLiveStreaming' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'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****',
],
],
[
'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' => 'EnableStun',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
[
'name' => 'CacheDuration',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '10000',
'minimum' => '0',
'example' => '0',
'default' => '0',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
[
'name' => 'ShouldEncrypt',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'false',
],
],
[
'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',
],
],
[
'name' => 'EncryptType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '0',
],
],
[
'name' => 'ForceIFrame',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
],
],
'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":"\\n01155F78-1A0B-57BE-8349-591341CA7DFC\\n\\n rtmp://47.100.***.***:8000/live?token=dc1****120ce394ef94974/Eb****6RBe8l4_0\\n \\n MDEy****OTo7PD0+Pw==\\n eA2r****fHjOmnyBfQ==\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryLiveStreaming',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryVoiceIntercom' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Scheme',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'default' => 'rtmp',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y*****',
],
],
[
'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' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
],
'responses' => [
200 => [
'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',
],
'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==',
],
],
],
],
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n rtmp://***.***.***.***:8000/talk?token=********\\n \\n MDEyMzQ1Njc4****0+Pw==\\n bPvz6tnfonP1E+****2Q==\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryVoiceIntercom',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RemoveFaceDeviceFromDeviceGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestIsolationId',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestIotInstanceId',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestProductKey',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestDeviceName',
],
],
[
'name' => 'DeviceGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestDeviceGroupId',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'RemoveFaceDeviceFromDeviceGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddFaceUserGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ZheJiangHZ',
],
],
[
'name' => 'UserGroupName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestUserGroup',
],
],
],
'responses' => [
200 => [
'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' => [
'UserGroupName' => [
'description' => '',
'type' => 'string',
'example' => 'TestUserGroup',
],
'ModifiedTime' => [
'description' => '',
'type' => 'string',
'example' => '2020-11-20 18:59:01',
],
'UserGroupId' => [
'description' => '',
'type' => 'string',
'example' => 'kvjy****',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"group already exist\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"UserGroupName\\": \\"TestUserGroup\\",\\n \\"ModifiedTime\\": \\"2020-11-20 18:59:01\\",\\n \\"UserGroupId\\": \\"kvjy****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0A13279A-5640-45E7-87AA-83750541AD0E\\n \\n 2020-11-20 18:59:01\\n TestUserGroup\\n kvjy****\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => 'AddFaceUserGroup',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddFaceUserToUserGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'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' => 'UserGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'kvjy****',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
'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":"\\r\\n 0A13279A-5640-45E7-87AA-83750541AD0E\\r\\n 200\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'AddFaceUserToUserGroup',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteFaceUserGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ZheJiangHZ',
],
],
[
'name' => 'UserGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'kvjy****',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
'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":"\\r\\n\\t0A13279A-5640-45E7-87AA-83750541AD0E\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]',
'title' => 'DeleteFaceUserGroup',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateFaceUserGroupAndDeviceGroupRelation' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'SYNC_INFO_PICTURE',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'RequestId' => [
'description' => '',
'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',
],
],
],
],
],
],
],
'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":"\\r\\n\\t0A13279A-5640-45E7-87AA-83750541AD0E\\r\\n\\t\\r\\n\\t\\t2020-04-25 19:29:30\\r\\n\\t\\tqcb2yea4ha4d****\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]',
'title' => 'UpdateFaceUserGroupAndDeviceGroupRelation',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateFaceUser' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestIsolati****',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'tibce3fsgqel****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ZhangSan',
],
],
[
'name' => 'Params',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{"age":28, "sex":"male"}',
],
],
[
'name' => 'FacePicUrl',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'https://test.com/test.jpg',
],
],
[
'name' => 'CustomUserId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '52242819650301xxxx',
],
],
],
'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',
],
],
],
],
],
'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":"\\n 0A13279A-5640-45E7-87AA-83750541AD0E\\n success\\n 200\\n true\\n","errorExample":""}]',
'title' => 'UpdateFaceUser',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFaceAllUserGroupAndDeviceGroupRelation' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'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',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'RequestId' => [
'description' => '',
'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****',
],
],
],
],
],
],
],
],
],
],
'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":"\\n\\t0A13279A-5640-45E7-87AA-83750541AD0E\\n\\t\\n\\t\\t20\\n\\t\\t10\\n\\t\\t1\\n\\t\\t\\n\\t\\t\\tSYNC_INFO_PICTURE\\n\\t\\t\\t2020-05-12 17:12:37\\n\\t\\t\\tTestDeviceGro****\\n\\t\\t\\tni1iyxqry0j0****\\n\\t\\t\\tTestUserGro****\\n\\t\\t
\\n\\t\\n\\tsuccess\\n\\t200\\n\\ttrue\\n","errorExample":""}]',
'title' => 'QueryFaceAllUserGroupAndDeviceGroupRelation',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFaceUserGroupAndDeviceGroupRelation' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestIsolationId',
],
],
[
'name' => 'ControlId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ni1iyxqry0j03plv',
],
],
],
'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' => [
'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',
],
],
],
],
],
],
],
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n 2020-05-12 17:12:37\\n TestDeviceGroupId\\n TestUserGroupId\\n SYNC_INFO_PICTURE\\n ni1iyxqry0j03plv\\n\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'QueryFaceUserGroupAndDeviceGroupRelation',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFaceUserIdByCustomUserId' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'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',
],
],
],
],
],
],
],
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n TestUserId\\n {\\"age\\":28, \\"sex\\":\\"male\\"}\\n TestCustomUserId\\n TestName\\n\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'QueryFaceUserIdByCustomUserId',
],
'QueryFaceAllUserGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestIsolationId',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '1000',
'minimum' => '1',
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'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',
],
],
],
],
],
],
],
],
],
],
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n 20\\n \\n 2020-05-12 17:12:37\\n TestUserGroupName\\n dmjpxfdk\\n \\n 100\\n 1\\n\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'QueryFaceAllUserGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFaceAllUserIdsByGroupId' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'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',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '20',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'RequestId' => [
'description' => '',
'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',
],
],
],
],
],
],
],
],
],
],
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n 20\\n 100\\n 1\\n \\n {\\"age\\":28, \\"sex\\":\\"male\\"}\\n TestCustomUserId\\n TestUserId\\n TestName\\n
\\n\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'QueryFaceAllUserIdsByGroupId',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFaceCustomUserIdByUserId' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestIsolationId',
],
],
[
'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',
],
],
],
],
],
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\nTestCustomUserId\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'QueryFaceCustomUserIdByUserId',
],
'QueryFaceUser' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestIsolationId',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestUserId',
],
],
],
'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',
],
'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',
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n TestUserId\\n {\\"age\\":28, \\"sex\\":\\"male\\"}\\n TestCustomUserId\\n \\n TestFaceMd5\\n https://test.com/xxx.jpg\\n \\n \\n \\n TestAlgorithmVersion\\n 200\\n TestAlgorithmProvider\\n success\\n TestFaceMd5\\n TestAlgorithmName\\n \\n \\n TestName\\n\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'QueryFaceUser',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFaceUserGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestIsolationId',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestUserId',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'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',
],
],
],
],
],
],
],
],
],
],
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n 20\\n \\n 2020-05-12 17:12:37\\n TestUserGroupName\\n TestUserGroupId\\n \\n 5\\n 1\\n\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'QueryFaceUserGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RemoveFaceUserFromUserGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestIsolationId',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestUserId',
],
],
[
'name' => 'UserGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestUserGroupId',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'RemoveFaceUserFromUserGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddFaceUser' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ZheJiangHZ',
],
],
[
'name' => 'FacePicUrl',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'https://example.com/test.jpeg',
],
],
[
'name' => 'CustomUserId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1234567890',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Tony',
],
],
[
'name' => 'Params',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{"key1":"value1", "key2":"value2"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'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',
],
'Data' => [
'description' => '',
'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****',
],
],
],
],
],
],
],
'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":"\\n 0A13279A-5640-45E7-87AA-83750541AD0E\\n \\n 3mtjaqebeq4d****\\n 1234567890\\n Tony\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => 'AddFaceUser',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddFaceUserGroupAndDeviceGroupRelation' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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',
],
],
[
'name' => 'UserGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'avjyxurd',
],
],
[
'name' => 'DeviceGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'kvjyhurc',
],
],
[
'name' => 'Relation',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'SYNC_INFO_PICTURE',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '0A13279A-5640-45E7-87AA-83750541AD0E',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'ControlId' => [
'description' => '',
'type' => 'string',
'example' => 'qcb2yea4ha4dxmly',
],
'ModifiedTime' => [
'description' => '',
'type' => 'string',
'example' => '2020-11-20 18:59:01',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ControlId\\": \\"qcb2yea4ha4dxmly\\",\\n \\"ModifiedTime\\": \\"2020-11-20 18:59:01\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n 2020-11-20 18:59:01\\n qcb2yea4ha4dxmly\\n\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'AddFaceUserGroupAndDeviceGroupRelation',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddFaceUserPicture' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'https://example.com/test.jpeg',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
'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":"\\r\\n\\t4de2c367-c1db-417c-aa15-8c585e595d92\\r\\n\\t1bb580ef7****\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]',
'title' => 'AddFaceUserPicture',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteFaceUser' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ZheJiangHzXiHu',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '3mtjaqebeq4dulcy',
],
],
],
'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',
],
],
],
],
],
'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":"0A13279A-5640-45E7-87AA-83750541AD0E\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'DeleteFaceUser',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteFaceUserGroupAndDeviceGroupRelation' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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****',
],
],
],
'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' => 'access control not exist',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"ErrorMessage\\": \\"access control not exist\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n\\t0A13279A-5640-45E7-87AA-83750541AD0E\\n\\t200\\n\\ttrue\\n","errorExample":""}]',
'title' => 'DeleteFaceUserGroupAndDeviceGroupRelation',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteFaceUserPicture' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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' => 'FacePicMd5',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1bb580ef7****',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
'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":"\\r\\n\\t4de2c367-c1db-417c-aa15-8c585e595d92\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]',
'title' => 'DeleteFaceUserPicture',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CheckFaceUserDoExistOnDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'a103lZ86ovStDMnU',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestIotInstanceId',
],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'tibce3fsgqelezk8',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'a1654Sr4Y3f',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestDeviceName',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '0A13279A-5640-45E7-87AA-83750541AD0E',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'DoExist' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"0A13279A-5640-45E7-87AA-83750541AD0E\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DoExist\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n true\\n\\nsuccess\\n200\\ntrue","errorExample":""}]',
'title' => 'CheckFaceUserDoExistOnDevice',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ClearFaceDeviceDB' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ZheJiangHZ',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot_instc_pu****_c*-v64********',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'a1Wmy******',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TestDevice_1',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
'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":"\\r\\n\\t0A13279A-5640-45E7-87AA-83750541AD0E\\r\\n\\t\\r\\n\\t200\\r\\n\\ttrue\\r\\n","errorExample":""}]',
'title' => 'ClearFaceDeviceDB',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreatePictureSearchApp' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot_instc_pu****_c*-v64********',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
'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":"\\n3A754C90-1286-4C2C-A3BA-8BF5BAD4BF76\\n5a502d3fbab8410e8fd4be9037c7****\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'CreatePictureSearchApp',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreatePictureSearchJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'maximum' => '9999999999999',
'minimum' => '0',
'example' => '1614227915000',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'maximum' => '9999999999999',
'minimum' => '0',
'example' => '1614327915000',
],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'required' => true,
'example' => '0.5',
],
],
[
'name' => 'BodyThreshold',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'required' => false,
'maximum' => '1',
'minimum' => '0',
'example' => '0.9',
'default' => '0.8',
],
],
[
'name' => 'PictureSearchType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '10',
'minimum' => '0',
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'Data' => [
'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',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RiskControl',
'errorMessage' => 'Your account is at risk. Contact customer support for more details.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"71632df011294a85910c566e7181****\\",\\n \\"ErrorMessage\\": \\"The request has failed due to a temporary failure of the server.\\",\\n \\"RequestId\\": \\"FAEBE068-07DE-4B88-AC2A-51FC2B556211\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nDB14A78C-6F64-40D0-8C03-46E8D57A8FC8\\n71632df011294a85910c566e7181****\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'CreatePictureSearchJob',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdatePictureSearchApp' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AppInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '3e429560124b44b685095df81a27****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RiskControl',
'errorMessage' => 'Your account is at risk. Contact customer support for more details.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Description is mandatory for this action.\\",\\n \\"RequestId\\": \\"CC6B9D69-627C-4C9D-AEAA-0BC08AB6DBED\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nCC6B9D69-627C-4C9D-AEAA-0BC08AB6DBED\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'UpdatePictureSearchApp',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryPictureSearchAiboxes' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AppInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '5a502d3fbab8410e8fd4be9037c7****',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot_instc_pu****_c*-v64********',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'CurrentPage' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageData' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NickName' => [
'description' => '',
'type' => 'string',
'example' => 'box015',
],
'IotId' => [
'description' => '',
'type' => 'string',
'example' => 'VrJwPGjC1sJlqPjZA3cxg4****',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RiskControl',
'errorMessage' => 'Your account is at risk. Contact customer support for more details.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Specified parameter CurrentPage is not valid.\\",\\n \\"RequestId\\": \\"DF7DC571-FE48-4C25-8BE0-B13C3038C85B\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"PageCount\\": 1,\\n \\"PageData\\": [\\n {\\n \\"NickName\\": \\"box015\\",\\n \\"IotId\\": \\"VrJwPGjC1sJlqPjZA3cxg4****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n DF7DC571-FE48-4C25-8BE0-B13C3038C85B\\r\\n \\r\\n 10\\r\\n 1\\r\\n 1\\r\\n 1\\r\\n \\r\\n VrJwPGjC1sJlqPjZA3cxg4****\\r\\n camera1\\r\\n \\r\\n \\r\\n 200\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'QueryPictureSearchAiboxes',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryPictureSearchApps' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '20',
'minimum' => '1',
'example' => '20',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '10000',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot_instc_pu****_c*-v64********',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'CurrentPage' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'PageCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageData' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppInstanceId' => [
'description' => '',
'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' => '',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Forbidden.RiskControl',
'errorMessage' => 'Your account is at risk. Contact customer support for more details.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Specified parameter CurrentPage is not valid.\\",\\n \\"RequestId\\": \\"2C794BB1-0494-4E4E-AACF-174F04CD1F10\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 2,\\n \\"PageCount\\": 1,\\n \\"PageData\\": [\\n {\\n \\"AppInstanceId\\": \\"3e429560124b44b685095df81a27****\\",\\n \\"ModifiedTime\\": 1614328081000,\\n \\"Description\\": \\"以图搜图Demo2\\",\\n \\"Version\\": \\"1.0.0\\",\\n \\"CreateTime\\": 1614327915000,\\n \\"AppTemplateId\\": \\"7b50e7acb2574a789226099300cc****\\",\\n \\"Name\\": \\"新以图搜图\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n2C794BB1-0494-4E4E-AACF-174F04CD1F10\\n\\n 1\\n 20\\n \\n 7b50e7acb2574a789226099300cc****\\n 5a502d3fbab8410e8fd4be9037c7****\\n 1\\n 1614325136000\\n 1.0.0\\n 1614325136000\\n 11\\n \\n \\n 7b50e7acb2574a789226099300cc****\\n 3e429560124b44b685095df81a27****\\n 以图搜图Demo2\\n 1614328081000\\n 1.0.0\\n 1614327915000\\n 新以图搜图\\n \\n 1\\n 2\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryPictureSearchApps',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryPictureSearchDevices' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AppInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '5a502d3fbab8410e8fd4be9037c7****',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '20',
'example' => '10',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'minimum' => '1',
'example' => '1',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'CurrentPage' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageData' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NickName' => [
'description' => '',
'type' => 'string',
'example' => 'camera1',
],
'IotId' => [
'description' => '',
'type' => 'string',
'example' => 'VrJwPGjC1sJlqPjZA3cxg4****',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Specified parameter CurrentPage is not valid.\\",\\n \\"RequestId\\": \\"DF7DC571-FE48-4C25-8BE0-B13C3038C85B\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"PageCount\\": 1,\\n \\"PageData\\": [\\n {\\n \\"NickName\\": \\"camera1\\",\\n \\"IotId\\": \\"VrJwPGjC1sJlqPjZA3cxg4****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nDF7DC571-FE48-4C25-8BE0-B13C3038C85B\\n\\n 1\\n 1\\n \\n VrJwPGjC1sJlqPjZA3cxg4****\\n camera1\\n \\n 1\\n 1\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryPictureSearchDevices',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryPictureSearchJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AppInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'fdc576d03c094faea9fa10fbf48c****',
],
],
[
'name' => 'JobStatus',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '10',
'minimum' => '0',
'example' => '3',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '20',
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '10000',
'minimum' => '1',
'example' => '1',
],
],
],
'responses' => [
200 => [
'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.',
],
],
],
'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":"\\n8FAF4001-2A53-46DF-B83E-306B8070E131\\n\\n 10\\n 1\\n 1\\n 1\\n \\n 3\\n 1614850763692\\n 1614850763000\\n 1614814763692\\n http://xxx.xxx.com/1.jpg\\n b3786935a71442efae014c7b2212****\\n 0.5\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryPictureSearchJob',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryPictureSearchJobResult' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AppInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'fdc576d03c094faea9fa10fbf48c****',
],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'b7e501d0d2524a4caeb50df3282a****',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '20',
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '10000',
'minimum' => '1',
'example' => '1',
],
],
],
'responses' => [
200 => [
'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',
],
'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****',
],
],
],
],
],
],
],
],
],
],
'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":"\\na06c4750-7cce-11eb-8010-557d50136505\\n\\n 10\\n 1\\n 1\\n 1\\n \\n 5RUngwC1RknD4lPiHgH300****\\n 1614333155075\\n camera1\\n pZJUqijOyfpFOOGNPF7S00****\\n https://xxx.xxx.xxx.com/xxx\\n 0.5\\n vectorId86d9a5c32b9947278e526c2eef8a****\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryPictureSearchJobResult',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetPictureSearchJobStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AppInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '892f97c9518548469d319d955d98****',
],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'b3786935a71442efae014c7b2212****',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'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.',
],
],
],
'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":"\\n2c7def10-7cce-11eb-8e79-959f4f722f76\\n\\n 3\\n 1614850763692\\n 1614850763000\\n 1614814763692\\n http://XXX.XXX.com/1.jpg\\n b3786935a71442efae014c7b2212****\\n 0.5\\n\\n200\\ntrue\\n\\n","errorExample":""}]',
'title' => 'GetPictureSearchJobStatus',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryPictureFiles' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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' => 'BeginTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1615357669000',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1615444063000',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'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',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y****',
],
],
],
'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' => 'product is not active.',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Page' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PicId' => [
'description' => '',
'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****',
],
],
],
],
],
],
],
],
],
],
'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":" \\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n \\n 10\\n 1\\n \\n zLZyi6aOLyOSHa9hsPyD00****\\n http://***.jpg\\n http://***_normal.jpg\\n pZJUqijOyfpFOOGNP******\\n 1543458157522\\n
\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => 'QueryPictureFiles',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'BindPictureSearchAppWithDevices' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'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',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => 'VrJwPGjC1sJlqPjZA3cxg4****',
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
'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":"\\nB8A4153B-4F18-49B1-90C0-C9194866FF88\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'BindPictureSearchAppWithDevices',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UnbindPictureSearchAppWithDevices' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'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',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => 'VrJwPGjC1sJlqPjZA3cxg4****',
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
'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":"\\nE779C673-E8E8-41F0-883E-7D9275DF733C\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'UnbindPictureSearchAppWithDevices',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PictureSearchPicture' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'AppInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '5a502d3fbab8410e8fd4be9037c7****',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '20',
'example' => '10',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'SearchPicUrl',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => ' http://***.***/2393.jpg',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1614297000000',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1614850651299',
],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'number',
'format' => 'float',
'required' => true,
'example' => '0.5',
],
],
[
'name' => 'ContainPicUrl',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => true,
'example' => 'true',
],
],
[
'name' => 'PictureSearchType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '10',
'minimum' => '0',
'example' => '1',
'default' => '1',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'CurrentPage' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageData' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PicUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://XXX.XXX/XXX',
],
'EventTime' => [
'description' => '',
'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****',
],
],
],
],
],
],
],
],
],
],
'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":"\\n3ddd5f30-7ccd-11eb-b164-bfd389491534\\n\\n 10\\n 1\\n 1\\n 1\\n \\n 5RUngwC1RknD4lPiHgH300****\\n 1\\n 1614500317482\\n pZJUqijOyfpFOOGNPF7S00****\\n https://XXX.XXX/XXX\\n 0.5\\n vectorId86d9a5c32b9947278e526c2eef8a****\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'PictureSearchPicture',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'TriggerCapturePicture' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'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' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y59****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'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',
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\neventPicId_12****\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'TriggerCapturePicture',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateRecordPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'plan1',
],
],
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '36f06322442e4e3f85a5ae8862c9****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'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',
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n5b60bf0dd55944c19d7817442bc9****\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'CreateRecordPlan',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddRecordPlanDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'create',
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zLZyi6aOLyOSHa9hsPyD00****',
],
],
[
'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****',
],
],
],
'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',
],
],
],
],
],
'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":"\\r\\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\r\\n 200\\r\\n true\\r\\n","errorExample":""}]',
'title' => 'AddRecordPlanDevice',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteRecordPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'PlanId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '6c5a397bc17c4b48ace86f0f0c30****',
],
],
],
'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' => 'request forbidden.',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"request forbidden.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'DeleteRecordPlan',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteRecordPlanDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'delete',
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zLZyi6aOLyOSHa9hsPyD00****',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'tenant auth error',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'DeleteRecordPlanDevice',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetDeviceRecordLifeCycle' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'd7XmBoJhAr88C6PelXDF00****',
],
],
[
'name' => 'Day',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '7',
],
],
],
'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' => 'InvalidParameter',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"InvalidParameter\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'SetDeviceRecordLifeCycle',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'StopTriggeredRecord' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'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' => 'RecordId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'fc82774fa749485bad7d719f9670****',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
],
'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',
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'StopTriggeredRecord',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateEventRecordPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
'default' => '0',
],
],
[
'name' => 'RecordDuration',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '30',
],
],
[
'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' => 'tenant auth error',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'UpdateEventRecordPlan',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateRecordPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'PlanId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '6c5a397bc17c4b48ace86f0f0c30****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'test1',
],
],
[
'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' => 'tenant auth error.',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error.\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nB68F5C11-4844-4A34-872B-313986482C06\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'UpdateRecordPlan',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRecord' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '0',
],
],
[
'name' => 'BeginTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1508200012',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1582420940',
],
],
[
'name' => 'RecordType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'NeedSnapshot',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'false',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-060a****',
],
],
],
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'Page' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SnapshotUrl' => [
'description' => '',
'type' => 'string',
'example' => 'https://lin****/****2Cq_90',
],
'EndTime' => [
'description' => '',
'type' => 'string',
'example' => '2018-09-10 00:00:30',
],
'EventType' => [
'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',
],
],
],
],
],
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n 10\\n 1\\n \\n 1\\n 1\\n 1352\\n 1\\n 2018-09-10 00:00:30\\n https://lin****/****2Cq_90\\n file1\\n 2018-09-10 00:00:00\\n 204800\\n
\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryRecord',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRecordByRecordId' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2c5bf5b6a8704bd3a6a1517fd125****',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-060a01****',
],
],
],
'responses' => [
200 => [
'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',
],
'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' => '',
'type' => 'string',
'example' => '2020-10-12 14:07:20',
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"F46E12A5-633D-4761-80F2-285752A052D5\\",\\n \\"ErrorMessage\\": \\"RecordId is mandatory for this action.\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"EndTime\\": \\"2020-10-12 14:07:31\\",\\n \\"FileName\\": \\"test\\",\\n \\"VodUrl\\": \\"https://iotx-vision-vod-vpc-hz-pre.aliyun-inc.com/vod/device/localrecord/flv/play/1****668.flv?token=e9****a9e14482c56be52&session=470e****3d015\\",\\n \\"BeginTime\\": \\"2020-10-12 14:07:20\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\nF46E12A5-633D-4761-80F2-285752A052D5\\n\\n 2020-10-12 14:07:31\\n test\\n 2020-10-12 14:07:20\\n 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\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryRecordByRecordId',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRecordPlanDetail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PlanId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '5b60bf0dd55944c19d7817442bc9****',
],
],
],
'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',
],
'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' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '6000',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PlanId\\": \\"5b60bf0dd55944c19d7817442bc9****\\",\\n \\"Name\\": \\"test\\",\\n \\"TemplateId\\": \\"693e244a038f4255bb2f5db32874****\\",\\n \\"TemplateInfo\\": {\\n \\"AllDay\\": 1,\\n \\"Default\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"TemplateId\\": \\"693e244a038f4255bb2f5db32874****\\",\\n \\"TimeSectionList\\": [\\n {\\n \\"End\\": 20000,\\n \\"DayOfWeek\\": 0,\\n \\"Begin\\": 6000\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n 5b60bf0dd55944c19d7817442bc9****\\n 693e244a038f4255bb2f5db32874****\\n test\\n \\n 0\\n 0\\n 693e244a038f4255bb2f5db32874****\\n test\\n \\n 0\\n 6000\\n 20000\\n \\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryRecordPlanDetail',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRecordPlanDeviceByDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zLZyi6aOLyOSHa9hsPyD00****',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'tenant auth error',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'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' => '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',
],
],
],
],
],
],
],
],
],
],
],
],
'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":" \\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n 5b60bf0dd55944c19d7817442bc9****\\n 693e244a038f4255bb2f5db32874****\\n test\\n \\n 0\\n 0\\n 693e244a038f4255bb2f5db32874****\\n test\\n \\n 0\\n 6000\\n 20000\\n \\n \\n\\n200\\ntrue\\n ","errorExample":""}]',
'title' => 'QueryRecordPlanDeviceByDevice',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRecordPlanDeviceByPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PlanId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '5b60bf0dd55944c19d7817442bc9****',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Page' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StreamType' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'IotId' => [
'description' => '',
'type' => 'string',
'example' => 'zLZyi6aOLyOSHa9hsPyD00****',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"PageCount\\": 1,\\n \\"Page\\": 1,\\n \\"List\\": [\\n {\\n \\"StreamType\\": 1,\\n \\"IotId\\": \\"zLZyi6aOLyOSHa9hsPyD00****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":" \\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n 200\\n true\\n \\n 2\\n 1\\n 10\\n 1\\n \\n zLZyi6aOLyOSHa9hsPyD00****\\n 1\\n
\\n \\n C47T6xwp6ms4bNlkHRWCg4****\\n 1\\n
\\n \\n ","errorExample":""}]',
'title' => 'QueryRecordPlanDeviceByPlan',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRecordPlans' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Page' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PlanId' => [
'description' => '',
'type' => 'string',
'example' => '6c5a397bc17c4b48ace86f0f0c30****',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'plan1',
],
'TemplateId' => [
'description' => '',
'type' => 'string',
'example' => '693e244a038f4255bb2f5db32874****',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 1,\\n \\"Total\\": 2,\\n \\"Page\\": 1,\\n \\"List\\": [\\n {\\n \\"PlanId\\": \\"6c5a397bc17c4b48ace86f0f0c30****\\",\\n \\"Name\\": \\"plan1\\",\\n \\"TemplateId\\": \\"693e244a038f4255bb2f5db32874****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n11A0BBA2-92B6-4EEF-8542-DBCA40E94611\\n\\n 10\\n 1\\n 2\\n 1\\n \\n 6c5a397bc17c4b48ace86f0f0c30****\\n 693e244a038f4255bb2f5db32874****\\n plan1\\n
\\n \\n 5b60bf0dd55944c19d7817442bc9****\\n 693e244a038f4255bb2f5db32874****\\n plan2\\n
\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryRecordPlans',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRecordUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'file1',
],
],
[
'name' => 'SeekTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y****',
],
],
[
'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' => 'VrJwPGjC1sJlqPjZA3cxg4****',
],
],
[
'name' => 'UrlValidDuration',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '3600',
'minimum' => '10',
'example' => '10',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\nhttps://linkvisual.aliyun.com/ddsffa****.m3u8\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryRecordUrl',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryTimeTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Page' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AllDay' => [
'description' => '',
'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' => '',
'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',
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n 2\\n 1\\n 1\\n 10\\n \\n joijoz***\\n testtime1\\n 0\\n 0\\n \\n 0\\n 20000\\n 60000\\n \\n \\n 1\\n 20000\\n 60000\\n \\n
\\n \\n joijoz***\\n testtime2\\n 0\\n 0\\n \\n 1\\n 20000\\n 60000\\n \\n \\n 2\\n 20000\\n 60000\\n \\n
\\n\\n","errorExample":""}]',
'title' => 'QueryTimeTemplate',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDeviceEventRecord' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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' => 'EventId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '907084996e1d44788d0*****43906_160803*****37',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1****z0t',
],
],
],
'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' => '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',
],
],
],
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n 2021-09-08 15:56:32\\n file1\\n 2021-09-08 15:55:35\\n rtmp://****/****.mp4\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryDeviceEventRecord',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDeviceVodUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
[
'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' => 'EnableStun',
'in' => 'query',
'schema' => [
'type' => 'boolean',
'required' => false,
'default' => 'false',
],
],
[
'name' => 'ShouldEncrypt',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zLZyi6aOLyOSHa9hsPyD00****',
],
],
[
'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',
],
],
[
'name' => 'EncryptType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'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',
],
],
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n \\n MDEy****OTo7PD0+Pw==\\n eA2r****fHjOmnyBfQ==\\n \\n rtmp://***/***.mp4\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryDeviceVodUrl',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryMonthRecord' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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' => 'VrJwPGjC1sJlqPjZA3cxg4****',
],
],
[
'name' => 'Month',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '201901',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'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',
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n110111111011111001111100111110\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryMonthRecord',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDeviceRecordLifeCycle' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DeviceList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'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****',
],
],
],
],
],
],
],
],
'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":"\\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n \\n C47T6xwp6ms4bNlkHRWCg4****\\n 7\\n \\n InvalidParameters\\n 200\\n true\\n","errorExample":""}]',
'title' => 'QueryDeviceRecordLifeCycle',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryEventRecordPlanDetail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PlanId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '5b60bf0dd55944c19d7817442bc9****',
],
],
],
'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',
],
'Data' => [
'description' => '',
'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',
],
],
],
],
],
],
],
],
],
],
],
],
'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":" \\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n 120\\n 5b60bf0dd55944c19d7817442bc9****\\n 30\\n 36f06322442e4e3f85a5ae8862c9****\\n record1\\n \\n 0\\n 0\\n 36f06322442e4e3f85a5ae8862c9****\\n temp1\\n \\n 0\\n 6000\\n 20000\\n \\n \\n 5\\n 0\\n 40000\\n \\n \\n\\n200\\ntrue\\n ","errorExample":""}]',
'title' => 'QueryEventRecordPlanDetail',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryEventRecordPlanDeviceByDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zLZyi6aOLyOSHa9hsPyD00****',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'tenant auth error',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'PreRecordDuration' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'Name' => [
'description' => '',
'type' => 'string',
'example' => 'planAA',
],
'PlanId' => [
'description' => '',
'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',
],
],
],
],
],
],
],
],
],
],
],
],
'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":" \\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n \\n 5b60bf0dd55944c19d7817442bc9****\\n planAA\\n 5\\n 120\\n 36f06322442e4e3f85a5ae8862c9****\\n \\n 36f06322442e4e3f85a5ae8862c9****\\n testtime1\\n 0\\n 0\\n \\n 1\\n 0\\n 86399\\n \\n \\n 5\\n 0\\n 40000\\n \\n \\n \\n 200\\n true\\n","errorExample":""}]',
'title' => 'QueryEventRecordPlanDeviceByDevice',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryEventRecordPlanDeviceByPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PlanId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '5b60bf0dd55944c19d7817442bc9****',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'PageCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Page' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StreamType' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'IotId' => [
'description' => '',
'type' => 'string',
'example' => 'P7WqhWvhplhHlWPO9Op5g4****',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"ErrorMessage\\": \\"tenant auth error\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 2,\\n \\"PageCount\\": 1,\\n \\"Page\\": 1,\\n \\"List\\": [\\n {\\n \\"StreamType\\": 1,\\n \\"IotId\\": \\"P7WqhWvhplhHlWPO9Op5g4****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":" \\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n true\\n \\n 2\\n 1\\n 1\\n 10\\n \\n P7WqhWvhplhHlWPO9Op5g4****\\n 1\\n
\\n \\n C47T6xwp6ms4bNlkHRWCg4****\\n 1\\n
\\n \\n ","errorExample":""}]',
'title' => 'QueryEventRecordPlanDeviceByPlan',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryEventRecordPlans' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
],
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Page' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EventType' => [
'description' => '',
'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****',
],
],
],
],
],
],
],
],
],
],
'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":" \\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n true\\n \\n 1\\n 1\\n 1\\n 10\\n \\n 5b60bf0dd55944c19d7817442bc9****\\n planAA\\n 5\\n 60\\n 36f06322442e4e3f85a5ae8862c9****\\n
\\n \\n","errorExample":""}]',
'title' => 'QueryEventRecordPlans',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'TriggerRecord' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'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' => 'zLZyi6aOLyOSHa****yD000100',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
[
'name' => 'PreRecordDuration',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '5',
],
],
[
'name' => 'RecordDuration',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '60',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y5****0t',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'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',
],
],
],
],
],
'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":"\\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n fc82774fa749485bad7d719f9670****\\n 200\\n true\\n","errorExample":""}]',
'title' => 'TriggerRecord',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDevicePictureByList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'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' => '1CJ0****e7qiq8VkQi1000000',
],
],
[
'name' => 'ThumbWidth',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
'default' => '0',
],
],
[
'name' => 'ExpireTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '60',
'default' => '0',
],
],
[
'name' => 'PictureType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
'default' => '2',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y******',
],
],
[
'name' => 'PictureIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => 'cFc5MzZ****npYT1***TDFzX1hrVzA0Z****',
'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'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',
],
],
],
],
],
],
],
],
],
],
'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":"\\nB68F5AC3-F1AF-5C4A-8170-913F4FDDE2B8\\n\\n \\n 1CJ03rzf****Qi1000000\\n https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEpDE****%2Cq_90\\n https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEp****%3D\\n 1632453652222\\n RW****HFRO****jUyMjIy\\n \\n \\n 1CJ03rzf****Qi1000000\\n https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbOEpDEUQ****uality%2Cq_90\\n https://link-vision-picture-sh.oss-cn-shanghai.aliyuncs.com/EbO****%3D\\n 1632454869397\\n RWJ****OSHFZm****Mzk3\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryDevicePictureByList',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'TransferDeviceInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'DeviceNameList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => 'RepeatList',
'maxItems' => 100,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'a1BwAGV****',
],
],
[
'name' => 'SourceInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iotx-oxssharez200',
],
],
[
'name' => 'TargetInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iot-060***',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'SuccessList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DeviceName' => [
'description' => '',
'type' => 'string',
'example' => 'e598798j****',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => 'success',
],
],
],
],
'FailedList' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DeviceName' => [
'description' => '',
'type' => 'string',
'example' => 'e5jdfalekj****',
],
'Message' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"27AF2E38-12ED-4F67-BD20-36E812CD7A42\\",\\n \\"ErrorMessage\\": \\"来源实例和目标实例不能相同\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SuccessList\\": [\\n {\\n \\"DeviceName\\": \\"e598798j****\\",\\n \\"Message\\": \\"success\\"\\n }\\n ],\\n \\"FailedList\\": [\\n {\\n \\"DeviceName\\": \\"e5jdfalekj****\\",\\n \\"Message\\": \\"设备已经转移或不属于来源实例\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nF1F1CD2E-0918-4804-9D44-8C3EE26DD3B5\\n\\n \\n success\\n QYA1\\n \\n \\n success\\n QYA2\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'TransferDeviceInstance',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRecordDownloadUrl' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'FileName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1623999491_LYPsmZGeEN8GdKzMtYNiBXXXXXXXXX_0/c0064411-2065-400a-a13e-********',
],
],
[
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWR****',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'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',
],
],
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n 0\\n \\n https://link-vision-storage-online.oss-cn-shanghai.aliyuncs.com/transcode%2Fgk-********.mp4?OSSAccessKeyId=LTA*****TTTTTTTT&Expires=16****804&Signature=****\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryRecordDownloadUrl',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateLocalFileUploadJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'TimeSlot',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '',
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y59****',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'JobId' => [
'description' => '',
'type' => 'string',
'example' => '1ec1a2****d0435fbc0****34f6f139d',
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InvalidParameter\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"1ec1a2****d0435fbc0****34f6f139d\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n 1ec1a2****d0435fbc0****34f6f139d\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'CreateLocalFileUploadJob',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteLocalFileUploadJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y59****',
],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1ec1a2****d0435fbc0****34f6f139d',
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'DeleteLocalFileUploadJob',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryLocalFileUploadJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y59****',
],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '1ec1a****5d0435fbc0****34f6f139d',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'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',
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"\\nF9220B6D-E9BD-166E-B103-22ECF0B64393\\n\\n 2\\n \\n IQ9mO4tvM****kQRQUdcg2n400\\n 1634745754\\n \\n 1634746054\\n video1\\n 1634747054\\n \\n 3\\n 1634746054\\n 200\\n g2n4DLQ6ggK\\n gb_hik_IPC\\n \\n \\n kIDFJy49n****aSSxtqvg2n400\\n 1634745754\\n 3\\n 1634746054\\n 9201\\n g2n4DLQ6ggK\\n hik_nvr_39_IPC\\n \\n \\n JWNQ5oTFzU5****BJZKJg2n400\\n 1634745754\\n 3\\n 1634752834\\n 9201\\n g2n4DLQ6ggK\\n hik_nvr_33_\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryLocalFileUploadJob',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFaceUserBatch' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'UserIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => '["xqymlby****4whye","6qyyb69zqara****","64nbfx8****hzmy4"]',
'maxItems' => 50,
],
],
[
'name' => 'IsolationId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ZheJiangHZ',
],
],
],
'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' => 'face user not exist',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'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',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"\\n0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n 1636436864000\\n 3mtjaqebeq4d****\\n 1636427314000\\n {\\"key1\\":\\"value1\\", \\"key2\\":\\"value2\\"}\\n 63f45472c2bf4cfa98b56****49238fa\\n Tony\\n \\n TestFaceMd5\\n https://example.com/test.jpeg\\n \\n TestAlgorithmVersion\\n 200\\n TestAlgorithmProvider\\n TestFaceMd5\\n TestAlgorithmName\\n \\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryFaceUserBatch',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFaceUserByName' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'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',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{"key1":"value1", "key2":"value2"}',
],
],
[
'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',
],
],
],
'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' => 'face user not exist',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'Page' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'List' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Params' => [
'description' => '',
'type' => 'string',
'example' => '{"key1":"value1", "key2":"value2"}',
],
'CustomUserId' => [
'description' => '',
'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',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'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":"\\n0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n 15\\n 1\\n 1\\n \\n 1636436864000\\n 3mtjaqebeq4d****\\n 1636427314000\\n {\\"key1\\":\\"value1\\", \\"key2\\":\\"value2\\"}\\n 1234567890\\n Tony\\n \\n TestFaceMd5\\n https://example.com/test.jpeg\\n \\n TestAlgorithmVersion\\n 200\\n TestAlgorithmProvider\\n TestFaceMd5\\n TestAlgorithmName\\n \\n \\n
\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryFaceUserByName',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteRecord' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'FileNameList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => 'file1',
'maxItems' => 50,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-060a****',
],
],
[
'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' => 'd7XmBoJhAr88C6PelXDF00****',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
],
],
'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":"\\n0A13279A-5640-45E7-87AA-83750541AD0E\\n\\n 3\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'DeleteRecord',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRecordUrlByTime' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-060a****',
],
],
[
'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' => 'd7XmBoJhAr88C6PelXDF00****',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
[
'name' => 'BeginTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '2147483647',
'minimum' => '0',
'example' => '1638675381',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '2147483647',
'minimum' => '0',
'example' => '1638866820',
],
],
[
'name' => 'UrlValidDuration',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '3600',
'minimum' => '10',
'example' => '200',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
'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":"\\n06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\nhttps://linkvisual.aliyun.com/ddsffa****.m3u8\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryRecordUrlByTime',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryCarProcessEvents' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iotx-oxsshare****',
],
],
[
'name' => 'SubIotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ImP6ECd1aQ****CAfWTO000101',
],
],
[
'name' => 'SubProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'a1Duh0F****',
],
],
[
'name' => 'SubDeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'car_test',
],
],
[
'name' => 'BeginTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '10000000000000',
'minimum' => '0',
'example' => '1646288487368',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '10000000000000',
'minimum' => '0',
'example' => '1646288488368',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '10000',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '50',
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'PlateNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'ActionType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '0',
'example' => '2',
],
],
[
'name' => 'AreaIndex',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '10',
'minimum' => '0',
'example' => '1',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'CurrentPage' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'PageCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageData' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EventPicUrl' => [
'description' => '',
'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' => '',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.lv.requestError',
'errorMessage' => 'Request error',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
[
'errorCode' => 'iot.lv.requestTimeError',
'errorMessage' => 'Request time error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Specified access key is not found.\\",\\n \\"RequestId\\": \\"8B8E77F0-7713-0139-A3D6-93482A025D45\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 50,\\n \\"PageCount\\": 1,\\n \\"PageData\\": [\\n {\\n \\"EventPicUrl\\": \\"https://example.com/test.jpg\\",\\n \\"EventTime\\": 1646288428361,\\n \\"ActionType\\": 1,\\n \\"Confidence\\": 63,\\n \\"SubProductKey\\": \\"a1Duh0F****\\",\\n \\"EventId\\": \\"dailyb3d6658d9****\\",\\n \\"SubIotId\\": \\"ImP6ECd1aQxio9CAfWTO****\\",\\n \\"AreaIndex\\": 0,\\n \\"EventType\\": 10005,\\n \\"EventPicId\\": \\"SU5LT2pXaUM4MV****Nzg\\",\\n \\"TaskId\\": \\"daily55617e7653354490938d****\\",\\n \\"SubDeviceName\\": \\"car_test\\",\\n \\"IotId\\": \\"gl9kLgp0UsPSCcIM8EAY00****\\",\\n \\"SubDeviceNickName\\": \\"测试车辆\\",\\n \\"PlateNo\\": \\"浙A6****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n8B8E77F0-7713-0139-A3D6-93482A025D45\\n\\n 10\\n 1\\n 1\\n 50\\n \\n daily55617e7653354490938d****\\n 1\\n 10005\\n ImP6ECd1aQxio9CAfWTO****\\n 测试车辆\\n SU5LT2pXaUM4MV****Nzg\\n gl9kLgp0UsPSCcIM8EAY00****\\n https://example.com/test.jpg\\n 63\\n a1Duh0F****\\n 1646288428361\\n car_test\\n dailyb3d6658d9****\\n 0\\n 浙A6****\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryCarProcessEvents',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeletePicture' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'PictureIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => 'cFc5MzZ****npYT1***TDFzX1hrVzA0Z****',
'maxItems' => 100,
],
],
[
'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' => '1CJ0****e7qiq8VkQi1000000',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iot-cn-n6w1y******',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'DeletedCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.lv.requestError',
'errorMessage' => 'Request error',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"request forbidden\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"DeletedCount\\": 3\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n \\n 3\\n \\n 200\\n true\\n","errorExample":""}]',
'title' => 'DeletePicture',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateInstanceInternetProtocol' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iot-cn-n6w1y59****',
],
],
[
'name' => 'IpVersion',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'IPv4',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '',
'type' => 'string',
'example' => '200',
],
'Data' => [
'description' => '',
'type' => 'object',
'example' => '',
],
'ErrorMessage' => [
'description' => '',
'type' => 'string',
'example' => 'InvalidParameter',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '06DC77A0-4622-42DB-9EE0-25FIOHS82JK1',
],
'Success' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.lv.requestError',
'errorMessage' => 'Request error',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ErrorMessage\\": \\"InvalidParameter\\",\\n \\"RequestId\\": \\"06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 06DC77A0-4622-42DB-9EE0-25FIOHS82JK1\\n 200\\n true\\n","errorExample":""}]',
'title' => 'UpdateInstanceInternetProtocol',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateRecordDownloadByTimeJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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******',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Device01',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
[
'name' => 'BeginTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '2147483648',
'minimum' => '0',
'example' => '1900000000',
],
],
[
'name' => 'RecordType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '9999999999999',
'minimum' => '0',
'example' => '2100000000',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'type' => 'object',
'properties' => [
'JobId' => [
'description' => '',
'type' => 'string',
'example' => 'w2s******',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RecordNotExist',
'errorMessage' => 'Record not exist.',
],
[
'errorCode' => 'iot.vision.DownloadJobError',
'errorMessage' => 'Download job error.',
],
[
'errorCode' => 'iot.vision.ConcurrencyExceedLimit',
'errorMessage' => 'Concurrency exceed the limit.',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Record not exist.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"w2s******\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n w2s******\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'CreateRecordDownloadByTimeJob',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRecordDownloadJobById' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Iot-r******',
],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'w2s******',
],
],
],
'responses' => [
200 => [
'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',
],
'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',
'example' => 'testfile',
],
'IotId' => [
'description' => '',
'type' => 'string',
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.JobNotExist',
'errorMessage' => 'Job not exist or expired.',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request failed.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": -1,\\n \\"EndTime\\": 2100000000,\\n \\"Type\\": 1,\\n \\"Progress\\": 90,\\n \\"RecordType\\": 0,\\n \\"StreamType\\": 0,\\n \\"BeginTime\\": 1900000000,\\n \\"Url\\": \\"http://*********\\",\\n \\"JobErrorCode\\": 9441,\\n \\"FileName\\": \\"testfile\\",\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n -1\\n C47T6xwp6ms4bNlkHRWCg4****\\n 0\\n \\n 1\\n 0\\n 2100000000\\n 9441\\n testfile\\n 1900000000\\n http://*********\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryRecordDownloadJobById',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRecordDownloadJobList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iot-2w******',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '50',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'a1Bw******',
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Device01',
],
],
[
'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',
],
],
],
'responses' => [
200 => [
'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',
],
'Data' => [
'description' => '',
'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****',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"iot.vision.RequestFailed\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Total\\": 1,\\n \\"JobList\\": [\\n {\\n \\"Status\\": -1,\\n \\"Type\\": 1,\\n \\"Progress\\": 90,\\n \\"RecordType\\": 0,\\n \\"BeginTime\\": 1900000000,\\n \\"Url\\": \\"http://*********\\",\\n \\"FileName\\": \\"testfile\\",\\n \\"EndTime\\": 2100000000,\\n \\"StreamType\\": 0,\\n \\"JobId\\": \\"w2s******\\",\\n \\"JobErrorCode\\": 9441,\\n \\"IotId\\": \\"C47T6xwp6ms4bNlkHRWCg4****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n 1\\n \\n -1\\n C47T6xwp6ms4bNlkHRWCg4****\\n 0\\n 1\\n \\n 0\\n 2100000000\\n testfile\\n 9441\\n 1900000000\\n w2s******\\n http://*********\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryRecordDownloadJobList',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateLocalRecordDownloadByTimeJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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******',
],
],
[
'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',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'C47T6xwp6ms4bNlkHRWCg4****',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '9999999999999',
'minimum' => '0',
'example' => '2100000000',
],
],
],
'responses' => [
200 => [
'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******',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.DownloadJobError',
'errorMessage' => 'Download job error.',
],
[
'errorCode' => 'iot.vision.ConcurrencyExceedLimit',
'errorMessage' => 'Concurrency exceed the limit.',
],
[
'errorCode' => 'iot.vision.StreamPushFailed',
'errorMessage' => 'Stream push failed.',
],
[
'errorCode' => 'iot.vision.DeviceOffline',
'errorMessage' => 'Device is offline.',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Download job error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"w2s******\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n w2s******\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'CreateLocalRecordDownloadByTimeJob',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'BatchQueryVisionDeviceInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'DeviceNameList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'maxItems' => 50,
],
],
[
'name' => 'IotIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => false,
'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'DeviceInfoList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => [
'type' => 'string',
],
'DeviceType' => [
'type' => 'integer',
'format' => 'int32',
],
'IotId' => [
'type' => 'string',
],
'GbDeviceInfo' => [
'type' => 'object',
'properties' => [
'GbId' => [
'type' => 'string',
],
'Password' => [
'type' => 'string',
],
'NickName' => [
'type' => 'string',
],
'SubProductKey' => [
'type' => 'string',
],
'DeviceProtocol' => [
'type' => 'integer',
'format' => 'int32',
],
'NetProtocol' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
'RtmpDeviceInfo' => [
'type' => 'object',
'properties' => [
'StreamStatus' => [
'type' => 'integer',
'format' => 'int32',
],
'PushKeyExpireTime' => [
'type' => 'integer',
'format' => 'int32',
],
'StreamName' => [
'type' => 'string',
],
'PushAuthKey' => [
'type' => 'string',
],
'PullAuthKey' => [
'type' => 'string',
],
'PullKeyExpireTime' => [
'type' => 'integer',
'format' => 'int32',
],
'PushUrlSample' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParameterError',
'errorMessage' => 'Request parameter error:%s',
],
[
'errorCode' => 'iot.vision.RequestError',
'errorMessage' => 'Request error.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'CreateRtmpDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'PullKeyExpireTime',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'default' => '3600',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'PushKeyExpireTime',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'default' => '3600',
],
],
[
'name' => 'PushAuthKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'PullAuthKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'SubStreamName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'DeviceName' => [
'type' => 'string',
],
'StreamName' => [
'type' => 'string',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParameterError',
'errorMessage' => 'Request parameter error:%s',
],
[
'errorCode' => 'iot.vision.DeviceNameDuplicate',
'errorMessage' => 'Device name duplicate.',
],
[
'errorCode' => 'iot.vision.StreamNameDuplicate',
'errorMessage' => 'Stream name duplicate.',
],
[
'errorCode' => 'iot.vision.RequestError',
'errorMessage' => 'Request error.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'DeleteRtmpDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParameterError',
'errorMessage' => 'Request parameter error:%s',
],
[
'errorCode' => 'iot.vision.RequestError',
'errorMessage' => 'Request error.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'DeleteRtmpKey' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '1',
'minimum' => '0',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParameterError',
'errorMessage' => 'Request parameter error:%s',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'QueryRtmpKey' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'PullAuthKey' => [
'type' => 'string',
],
'PullKeyExpireTime' => [
'type' => 'integer',
'format' => 'int32',
],
'PushKeyExpireTime' => [
'type' => 'integer',
'format' => 'int32',
],
'StreamName' => [
'type' => 'string',
],
'PushAuthKey' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParameterError',
'errorMessage' => 'Request parameter error:%s',
],
[
'errorCode' => 'iot.vision.RtmpKeyNotSet',
'errorMessage' => 'Rtmp key not set.',
],
[
'errorCode' => 'iot.vision.RequestError',
'errorMessage' => 'Request error.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'QueryVisionDeviceInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'Description' => [
'type' => 'string',
],
'DeviceType' => [
'type' => 'integer',
'format' => 'int32',
],
'GbDeviceInfo' => [
'type' => 'object',
'properties' => [
'GbId' => [
'type' => 'string',
],
'Password' => [
'type' => 'string',
],
'NickName' => [
'type' => 'string',
],
'SubProductKey' => [
'type' => 'string',
],
'DeviceProtocol' => [
'type' => 'integer',
'format' => 'int32',
],
'NetProtocol' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
'RtmpDeviceInfo' => [
'type' => 'object',
'properties' => [
'StreamStatus' => [
'type' => 'integer',
'format' => 'int32',
],
'PushKeyExpireTime' => [
'type' => 'integer',
'format' => 'int32',
],
'StreamName' => [
'type' => 'string',
],
'PushAuthKey' => [
'type' => 'string',
],
'PullAuthKey' => [
'type' => 'string',
],
'PullKeyExpireTime' => [
'type' => 'integer',
'format' => 'int32',
],
'PushUrlSample' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParameterError',
'errorMessage' => 'Request parameter error:%s',
],
[
'errorCode' => 'iot.vision.RequestError',
'errorMessage' => 'Request error.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'UpdateRtmpKey' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'PullKeyExpireTime',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'PushKeyExpireTime',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
],
],
[
'name' => 'PushAuthKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'PullAuthKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParameterError',
'errorMessage' => 'Request parameter error:%s',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
],
'CreateGbDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'GbId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'DeviceType',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'default' => '1',
],
],
[
'name' => 'SubProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'MediaNetProtocol',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'DeviceName' => [
'type' => 'string',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.common.RamActionPermissionDeny',
'errorMessage' => 'You do not have the RAM permission.',
],
[
'errorCode' => 'iot.vision.GbServiceNotEnabled',
'errorMessage' => 'The GB28181 service has not been enabled.',
],
[
'errorCode' => 'iot.vision.GbIdDuplicate',
'errorMessage' => 'The GB28181 deviceId is duplicated.',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
],
],
],
'DeleteGbDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.common.RamActionPermissionDeny',
'errorMessage' => 'You do not have the RAM permission.',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
],
],
],
'EnableGbSubDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'SubDeviceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'DeviceName' => [
'type' => 'string',
],
'ProductKey' => [
'type' => 'string',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.common.RamActionPermissionDeny',
'errorMessage' => 'You do not have the RAM permission.',
],
[
'errorCode' => 'iot.vision.GbServiceNotEnabled',
'errorMessage' => 'The GB28181 service has not been enabled.',
],
[
'errorCode' => 'iot.vision.GbIdDuplicate',
'errorMessage' => 'The GB28181 deviceId is duplicated.',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
],
],
],
'QueryGbSubDeviceList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'default' => '10',
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'PageStart',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '512',
'minimum' => '1',
'default' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
'Data' => [
'type' => 'object',
'properties' => [
'Total' => [
'type' => 'integer',
'format' => 'int32',
],
'GbSubDeviceList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ProductKey' => [
'type' => 'string',
],
'DeviceName' => [
'type' => 'string',
],
'DeviceId' => [
'type' => 'string',
],
'DeviceEnable' => [
'type' => 'integer',
'format' => 'int32',
],
'IotId' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.common.RamActionPermissionDeny',
'errorMessage' => 'You do not have the RAM permission.',
],
[
'errorCode' => 'iot.vision.GbServiceNotEnabled',
'errorMessage' => 'The GB28181 service has not been enabled.',
],
[
'errorCode' => 'iot.vision.GbIdDuplicate',
'errorMessage' => 'The GB28181 deviceId is duplicated.',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
],
],
],
'RefreshGbSubDeviceList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.common.RamActionPermissionDeny',
'errorMessage' => 'You do not have the RAM permission.',
],
[
'errorCode' => 'iot.vision.GbServiceNotEnabled',
'errorMessage' => 'The GB28181 service has not been enabled.',
],
[
'errorCode' => 'iot.vision.GbIdDuplicate',
'errorMessage' => 'The GB28181 deviceId is duplicated.',
],
[
'errorCode' => 'iot.vision.RefreshTooFrequently',
'errorMessage' => 'Refresh too frequently.',
],
[
'errorCode' => 'iot.vision.DeviceOffline',
'errorMessage' => 'Device is offline.',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
],
],
],
'UpdateGbDevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'GbId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DeviceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => [
'type' => 'string',
],
'ErrorMessage' => [
'type' => 'string',
],
'RequestId' => [
'type' => 'string',
],
'Success' => [
'type' => 'boolean',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.common.RamActionPermissionDeny',
'errorMessage' => 'You do not have the RAM permission.',
],
[
'errorCode' => 'iot.vision.GbIdDuplicate',
'errorMessage' => 'The GB28181 deviceId is duplicated.',
],
],
403 => [
[
'errorCode' => 'iot.lv.requestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.lv.requestAuthError',
'errorMessage' => 'Request auth error.',
],
],
],
],
'CreateStreamPushJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'ProductKey',
'in' => 'query',
'schema' => [
'description' => '',
'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' => 'd7XmBoJhAr88C6PelXDF00****',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iot-cn-n6w1y59****',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
[
'name' => 'PushUrl',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'rtmp://****',
],
],
[
'name' => 'JobType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
],
'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' => [
'JobId' => [
'description' => '',
'type' => 'string',
'example' => '23***********',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.StreamPushFailed',
'errorMessage' => 'Stream push failed.',
],
[
'errorCode' => 'iot.vision.DeviceOffline',
'errorMessage' => 'Device is offline.',
],
[
'errorCode' => 'iot.vision.DeviceNotStreaming',
'errorMessage' => 'Device is not streaming.',
],
[
'errorCode' => 'iot.vision.ConcurrencyExceedLimit',
'errorMessage' => 'Concurrency exceed the limit.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"403\\",\\n \\"ErrorMessage\\": \\"Request forbidden.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobId\\": \\"23***********\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n 23***********\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'CreateStreamPushJob',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateStreamSnapshotJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'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' => 'd7XmBoJhAr88C6PelXDF00****',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iot-cn-n6w1y59****',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
[
'name' => 'SnapshotInterval',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '1800',
'minimum' => '60',
'example' => '600',
],
],
],
'responses' => [
200 => [
'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',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.NoStorageQuota',
'errorMessage' => 'No storage quota.',
],
[
'errorCode' => 'iot.vision.RequestError',
'errorMessage' => 'Request error.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"403\\",\\n \\"ErrorMessage\\": \\"Request auth failed.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'CreateStreamSnapshotJob',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteStreamPushJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'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' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '23******',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'd7XmBoJhAr88C6PelXDF00****',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iot-cn-n6w1y59****',
],
],
],
'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',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.RequestError',
'errorMessage' => 'Request error.',
],
[
'errorCode' => 'iot.vision.JobNotExist',
'errorMessage' => 'Job not exist or expired.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'DeleteStreamPushJob',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteStreamSnapshotJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'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' => 'd7XmBoJhAr88C6PelXDF00****',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iot-cn-n6w1y59****',
],
],
[
'name' => 'StreamType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'default' => '0',
],
],
],
'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',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.RequestError',
'errorMessage' => 'Request error.',
],
[
'errorCode' => 'iot.vision.JobNotExist',
'errorMessage' => 'Job not exist or expired.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'DeleteStreamSnapshotJob',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryStreamPushJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'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' => 'JobId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '23*********',
],
],
[
'name' => 'IotId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'd7XmBoJhAr88C6PelXDF00****',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iot-cn-n6w1y59****',
],
],
],
'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',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.RequestError',
'errorMessage' => 'Request error.',
],
[
'errorCode' => 'iot.vision.JobNotExist',
'errorMessage' => 'Job not exist or expired.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobType\\": 1,\\n \\"PushUrl\\": \\"rtmp://****\\",\\n \\"StreamType\\": 1,\\n \\"CreateTime\\": 1581595942,\\n \\"PushStatus\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n 1\\n 1\\n 1\\n 1581595942\\n rtmp://****\\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryStreamPushJob',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryStreamPushJobList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'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' => 'd7XmBoJhAr88C6PelXDF00****',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iot-cn-n6w1y59****',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'JobType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
],
'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',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.RequestError',
'errorMessage' => 'Request error.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Request parameter error.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Total\\": 10,\\n \\"JobList\\": [\\n {\\n \\"PushUrl\\": \\"rtmp://****\\",\\n \\"StreamType\\": 0,\\n \\"JobId\\": \\"23********\\",\\n \\"CreateTime\\": 1581595942,\\n \\"PushStatus\\": 1,\\n \\"JobType\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n 1\\n \\n 1\\n 0\\n 1\\n 1581595942\\n rtmp://****\\n 23********\\n \\n\\n200\\ntrue\\n","errorExample":""}]',
'title' => 'QueryStreamPushJobList',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryStreamSnapshotJob' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'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' => 'd7XmBoJhAr88C6PelXDF00****',
],
],
[
'name' => 'IotInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'iot-cn-n6w1y59****',
],
],
],
'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',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'iot.vision.RequestParamError',
'errorMessage' => 'Request parameter error.',
],
[
'errorCode' => 'iot.vision.RequestFailed',
'errorMessage' => 'Request failed.',
],
[
'errorCode' => 'iot.vision.RequestError',
'errorMessage' => 'Request error.',
],
],
403 => [
[
'errorCode' => 'iot.vision.RequestAuthFailed',
'errorMessage' => 'Request auth failed.',
],
[
'errorCode' => 'iot.vision.RequestForbidden',
'errorMessage' => 'Request forbidden.',
],
],
429 => [
[
'errorCode' => 'iot.vision.RequestTrafficControl',
'errorMessage' => 'Request traffic control.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"403\\",\\n \\"ErrorMessage\\": \\"Request forbidden.\\",\\n \\"RequestId\\": \\"E55***B7-4***-4***-8***-D3******F565\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"JobList\\": [\\n {\\n \\"StreamType\\": 0,\\n \\"SnapshotInterval\\": 600\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\nE55***B7-4***-4***-8***-D3******F565\\n\\n \\n 600\\n 0\\n \\n\\n200\\ntrue\\n","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',
],
],
];