{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-linkvisual/add-event-record-plan-device":{"post":{"operationId":"cloud_aliyun_linkvisual_add_event_record_plan_device","summary":"Adds a smart alert event recording plan for an IPC device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PlanId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value exists, you…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"StreamType":{"type":"integer","description":"The stream type. Valid values: 0 (default): main stream. 1: sub stream"},"PlanId":{"type":"string","description":"The ID of the smart alert event recording plan. You can call https://help.aliyun.com/document_detail/107907.html to query the plan ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/add-face-device-group":{"post":{"operationId":"cloud_aliyun_linkvisual_add_face_device_group","summary":"Creates a device group for the face image library","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","DeviceGroupName"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The business isolation ID, which is used for data isolation between different business applications under the same Alibaba Cloud account.…"},"DeviceGroupName":{"type":"string","description":"The device group name. Specify a custom value. The value can be up to 128 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/add-face-device-to-device-group":{"post":{"operationId":"cloud_aliyun_linkvisual_add_face_device_to_device_group","summary":"Adds a device to a device group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","ProductKey","DeviceName","DeviceGroupId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"IotInstanceId":{"type":"string","description":"The instance ID"},"ProductKey":{"type":"string","description":"The product key"},"DeviceName":{"type":"string","description":"The device name"},"DeviceGroupId":{"type":"string","description":"The device group ID. You can obtain this ID by calling the AddFaceDeviceGroup operation"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/add-face-user":{"post":{"operationId":"cloud_aliyun_linkvisual_add_face_user","summary":"Adds a user to the face database","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","FacePicUrl","CustomUserId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The business isolation ID, which is used for data isolation between different business applications under the same Alibaba Cloud account.…"},"FacePicUrl":{"type":"string","description":"The URL download address of the user's face image. Only images in JPEG and JPG formats are supported, and the image URL cannot contain…"},"CustomUserId":{"type":"string","description":"The user identity ID. The value can contain uppercase letters and digits. Set this to the user's ID card number or student ID"},"Name":{"type":"string","description":"The username. The value can contain Chinese characters, uppercase and lowercase letters, digits, underscores (_), and hyphens (-), and…"},"Params":{"type":"string","description":"The custom user parameters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/add-face-user-group":{"post":{"operationId":"cloud_aliyun_linkvisual_add_face_user_group","summary":"Creates a user group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserGroupName"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The business isolation ID, which is used for data isolation between different business applications under the same Alibaba Cloud account.…"},"UserGroupName":{"type":"string","description":"The name of the user group. Specify a custom value. The name can be up to 128 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/add-face-user-group-and-device-group-relation":{"post":{"operationId":"cloud_aliyun_linkvisual_add_face_user_group_and_device_group_relation","summary":"Adds a face synchronization relationship between a user group and a device group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserGroupId","DeviceGroupId","Relation"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"IotInstanceId":{"type":"string","description":"The instance ID"},"UserGroupId":{"type":"string","description":"The user group ID"},"DeviceGroupId":{"type":"string","description":"The device group ID"},"Relation":{"type":"string","description":"The face synchronization relationship"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/add-face-user-picture":{"post":{"operationId":"cloud_aliyun_linkvisual_add_face_user_picture","summary":"Adds a face image for a user in the face database","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserId","FacePicUrl"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set…"},"UserId":{"type":"string","description":"The user ID. Set this parameter to the UserId value that you obtained and saved locally after calling the…"},"FacePicUrl":{"type":"string","description":"The URL download address of the face image. Only images in JPEG and JPG formats are supported. The image URL cannot contain Chinese…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/add-face-user-to-user-group":{"post":{"operationId":"cloud_aliyun_linkvisual_add_face_user_to_user_group","summary":"Adds a user to a user group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserId","UserGroupId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The business isolation ID, which is used for data isolation between different business applications under the same Alibaba Cloud account.…"},"UserId":{"type":"string","description":"The user ID. Specify the user ID that you obtained and saved locally after calling the https://help.aliyun.com/document_detail/288338.html…"},"UserGroupId":{"type":"string","description":"The user group ID. Specify the user group ID that you obtained and saved locally after calling the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/add-record-plan-device":{"post":{"operationId":"cloud_aliyun_linkvisual_add_record_plan_device","summary":"Adds a continuous recording plan to an IPC device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StreamType","PlanId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value exists, you…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"StreamType":{"type":"integer","description":"The stream type. Valid values: 0 (default): main stream. 1: sub stream"},"PlanId":{"type":"string","description":"The recording plan ID. You can call https://help.aliyun.com/document_detail/107896.html to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/batch-query-vision-device-info":{"post":{"operationId":"cloud_aliyun_linkvisual_batch_query_vision_device_info","summary":"BatchQueryVisionDeviceInfo","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"},"DeviceNameList":{"type":"string","description":"The DeviceNameList (JSON-encoded)"},"IotIdList":{"type":"string","description":"The IotIdList (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/bind-picture-search-app-with-devices":{"post":{"operationId":"cloud_aliyun_linkvisual_bind_picture_search_app_with_devices","summary":"Binds devices to an image search instance in batches","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppInstanceId","DeviceIotIds"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"AppInstanceId":{"type":"string","description":"Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID"},"IotInstanceId":{"type":"string","description":"The instance ID. Enterprise Enterprise instance: This parameter is required. You can view the ID of your Enterprise Enterprise instance on…"},"DeviceIotIds":{"type":"string","description":"The list of device IotIds. You can specify the IotId of a V series edge gateway or camera. The IotId is the ID issued by IoT Platform for…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/check-face-user-do-exist-on-device":{"post":{"operationId":"cloud_aliyun_linkvisual_check_face_user_do_exist_on_device","summary":"Checks whether the face data of a specified user is successfully synced to a device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserId","ProductKey","DeviceName"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"IotInstanceId":{"type":"string","description":"The isolation ID"},"UserId":{"type":"string","description":"The user ID"},"ProductKey":{"type":"string","description":"The ProductKey of the IoT Platform product"},"DeviceName":{"type":"string","description":"The device name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/clear-face-device-db":{"post":{"operationId":"cloud_aliyun_linkvisual_clear_face_device_db","summary":"Clears all face image libraries under a specified business isolation ID on a V-series edge all-in-one device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","ProductKey","DeviceName"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The business isolation ID"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value exists, you…"},"ProductKey":{"type":"string","description":"The unique identifier of the product to which the device corresponding to the V-series edge all-in-one device belongs. On the Host Details…"},"DeviceName":{"type":"string","description":"The name of the device corresponding to the V-series edge all-in-one device. On the Host Details page of the V-series edge all-in-one…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/create-event-record-plan":{"post":{"operationId":"cloud_aliyun_linkvisual_create_event_record_plan","summary":"Creates an intelligent alert event recording plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","RecordDuration","TemplateId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"Name":{"type":"string","description":"The name of the recording plan. The name must be fewer than 48 characters in length and can contain letters, digits, and the following…"},"EventTypes":{"type":"string","description":"The intelligent alert event type. To specify all intelligent alert event types, set this parameter to 0. To specify multiple intelligent…"},"PreRecordDuration":{"type":"integer","description":"The pre-recording duration. Unit: seconds. Default value: 0. Maximum value: 10"},"RecordDuration":{"type":"integer","description":"The recording duration, including the pre-recording duration. Unit: seconds. Valid values: 10 to 60"},"TemplateId":{"type":"string","description":"The ID of the time template. You can call https://help.aliyun.com/document_detail/107890.html to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/create-gb-device":{"post":{"operationId":"cloud_aliyun_linkvisual_create_gb_device","summary":"CreateGbDevice","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductKey","GbId","Password","IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"Description":{"type":"string","description":"The Description"},"ProductKey":{"type":"string","description":"The ProductKey"},"DeviceName":{"type":"string","description":"The DeviceName"},"GbId":{"type":"string","description":"The GbId"},"Password":{"type":"string","description":"The Password"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"},"DeviceType":{"type":"integer","description":"The DeviceType"},"SubProductKey":{"type":"string","description":"The SubProductKey"},"MediaNetProtocol":{"type":"string","description":"The MediaNetProtocol"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/create-local-file-upload-job":{"post":{"operationId":"cloud_aliyun_linkvisual_create_local_file_upload_job","summary":"Creates a local recording upload task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"TimeSlot":{"type":"string","description":"The list of time slots (JSON-encoded)"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value exists, you…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/create-local-record-download-by-time-job":{"post":{"operationId":"cloud_aliyun_linkvisual_create_local_record_download_by_time_job","summary":"Creates a task to download local recordings by time","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId","BeginTime","EndTime"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the video device belongs. You can view information about all products under the current instance on…"},"DeviceName":{"type":"string","description":"The device name of the video device. You can view the DeviceName of devices under a specified product on the Devices page of the IoT…"},"Speed":{"type":"number","description":"The upload speed multiplier of the device. Default value: 1.0. Valid values: 0.125 to 8.0"},"BeginTime":{"type":"integer","description":"The start time. The value is a 10-digit UNIX timestamp. Unit: seconds. Valid values: 0 to 2147483647"},"IotId":{"type":"string","description":"The device ID of the video device. You can call the https://help.aliyun.com/document_detail/69594.html operation to query the device ID.…"},"EndTime":{"type":"integer","description":"The end time. The value is a 10-digit UNIX timestamp. Unit: seconds. Valid values: 0 to 2147483647. The value must be greater than the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/create-picture-search-app":{"post":{"operationId":"cloud_aliyun_linkvisual_create_picture_search_app","summary":"Creates an image search application instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","Desc"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"Name":{"type":"string","description":"The name of the image search application instance. The name can contain Chinese characters, letters, digits, underscores (_), and hyphens…"},"Desc":{"type":"string","description":"The description of the image search application instance. The description can contain Chinese characters, letters, digits, underscores…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If the ID value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/create-picture-search-job":{"post":{"operationId":"cloud_aliyun_linkvisual_create_picture_search_job","summary":"Creates an integrated image-to-image search task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppInstanceId","SearchPicUrl","StartTime","EndTime","Threshold"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"AppInstanceId":{"type":"string","description":"Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID"},"SearchPicUrl":{"type":"string","description":"The URL of the image to be searched"},"StartTime":{"type":"integer","description":"The start time of the search range. The value is a 13-digit UNIX timestamp. Unit: milliseconds"},"EndTime":{"type":"integer","description":"The end time of the search range. The value is a 13-digit UNIX timestamp. Unit: milliseconds"},"Threshold":{"type":"number","description":"The face search threshold. Valid values: 0 to 1. To ensure the accuracy of search results, set this parameter to a value between 0.3 and 0.6"},"BodyThreshold":{"type":"number","description":"The body search threshold. Valid values: 0 to 1. To ensure the accuracy of search results, set this parameter to a value greater than or…"},"PictureSearchType":{"type":"integer","description":"The search type. Valid values: 1: face 0: body Default value: 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/create-record-download-by-time-job":{"post":{"operationId":"cloud_aliyun_linkvisual_create_record_download_by_time_job","summary":"Creates a task to download cloud recordings by time","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId","BeginTime","EndTime"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the video device belongs. You can view the information of all products under the current instance…"},"DeviceName":{"type":"string","description":"The device name of the video device. You can view the DeviceName of devices under a specified product on the Devices page of the IoT…"},"StreamType":{"type":"integer","description":"The stream type. Valid values: 0 (default): main stream. 1: sub stream"},"BeginTime":{"type":"integer","description":"The start time. The value is a 10-digit UNIX timestamp. Unit: seconds. Valid values: 0 to 2147483647"},"RecordType":{"type":"integer","description":"The recording type. Valid values: 0: continuous recording. 1: event recording. 2: active recording. 4: local-to-cloud recording. Empty:…"},"IotId":{"type":"string","description":"The device ID of the video device. You can call the https://help.aliyun.com/document_detail/69594.html operation to query the device ID.…"},"EndTime":{"type":"integer","description":"The end time. The value is a 10-digit UNIX timestamp. Unit: seconds. Valid values: 0 to 2147483647. The value must be greater than the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/create-record-plan":{"post":{"operationId":"cloud_aliyun_linkvisual_create_record_plan","summary":"Creates a recording plan based on a time template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","TemplateId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"Name":{"type":"string","description":"The name of the recording plan. The name must be fewer than 48 characters in length and can contain letters, digits, and the following…"},"TemplateId":{"type":"string","description":"The ID of the time template associated with the recording plan. You can call https://help.aliyun.com/document_detail/107888.html to query…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/create-rtmp-device":{"post":{"operationId":"cloud_aliyun_linkvisual_create_rtmp_device","summary":"CreateRtmpDevice","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProductKey","IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PullKeyExpireTime":{"type":"integer","description":"The PullKeyExpireTime"},"Description":{"type":"string","description":"The Description"},"ProductKey":{"type":"string","description":"The ProductKey"},"DeviceName":{"type":"string","description":"The DeviceName"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"},"PushKeyExpireTime":{"type":"integer","description":"The PushKeyExpireTime"},"PushAuthKey":{"type":"string","description":"The PushAuthKey"},"PullAuthKey":{"type":"string","description":"The PullAuthKey"},"SubStreamName":{"type":"string","description":"The SubStreamName"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/create-stream-push-job":{"post":{"operationId":"cloud_aliyun_linkvisual_create_stream_push_job","summary":"Creates a video stream push job","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId","PushUrl"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the device belongs. You can view the ProductKey on the Products page of the IoT Platform console or…"},"DeviceName":{"type":"string","description":"The name of the device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this parameter, you…"},"IotId":{"type":"string","description":"The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console"},"StreamType":{"type":"integer","description":"The stream type. 0 (default): main stream. 1: sub stream"},"PushUrl":{"type":"string","description":"The push URL. The maximum length is 500 bytes"},"JobType":{"type":"integer","description":"The type of the push job. 1 (default): continuous job. 2: trigger-based job that ends after an interruption"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/create-stream-snapshot-job":{"post":{"operationId":"cloud_aliyun_linkvisual_create_stream_snapshot_job","summary":"Creates a cloud snapshot task for a device stream","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId","SnapshotInterval"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the device belongs. You can view the ProductKey on the Products page of the IoT Platform console,…"},"DeviceName":{"type":"string","description":"The name of the device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this parameter, you…"},"IotId":{"type":"string","description":"The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console"},"StreamType":{"type":"integer","description":"The stream type. 0 (default): main stream. 1: sub stream"},"SnapshotInterval":{"type":"integer","description":"The interval between snapshots. Valid values: 60 to 1800. Unit: seconds"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/create-time-template":{"post":{"operationId":"cloud_aliyun_linkvisual_create_time_template","summary":"Creates a time template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","AllDay"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"TimeSections":{"type":"string","description":"The list of time ranges (JSON-encoded)"},"Name":{"type":"string","description":"The name of the time template. The name must be fewer than 48 characters in length and can contain letters, digits, and the following…"},"AllDay":{"type":"integer","description":"Specifies whether to enable 24/7 recording. Valid values: 1: Yes. 0: No. You must configure the TimeSections.N.DayOfWeek,…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-event-record-plan":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_event_record_plan","summary":"Deletes an intelligent event recording plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PlanId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PlanId":{"type":"string","description":"The ID of the intelligent alert event recording plan. You can call https://help.aliyun.com/document_detail/107907.html to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-event-record-plan-device":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_event_record_plan_device","summary":"Deletes an IPC device associated with an intelligent alert event recording plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"StreamType":{"type":"integer","description":"The stream type. Valid values: 0 (default): main stream. 1: sub stream"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-face-device-group":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_face_device_group","summary":"Deletes a device group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","DeviceGroupId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"DeviceGroupId":{"type":"string","description":"The device group ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-face-user":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_face_user","summary":"Deletes a user from the face management service","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The business isolation ID"},"UserId":{"type":"string","description":"The unique user ID in the face service"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-face-user-group":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_face_user_group","summary":"Deletes a specified user group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserGroupId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set…"},"UserGroupId":{"type":"string","description":"The user group ID. Set this parameter to the user group ID that you obtained and saved locally after calling the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-face-user-group-and-device-group-relation":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_face_user_group_and_device_group_relation","summary":"Deletes the face synchronization relationship between a user group and a device group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","ControlId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set…"},"ControlId":{"type":"string","description":"The control ID of the synchronization relationship between the user group and the device group. Set this parameter to the value of…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-face-user-picture":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_face_user_picture","summary":"Deletes a specified face image from a user in the face database","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserId","FacePicMd5"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set…"},"UserId":{"type":"string","description":"The user ID. Set this parameter to the UserId value that you obtained and saved locally after calling the…"},"FacePicMd5":{"type":"string","description":"The unique identifier of the user's face image. Set this parameter to the Data value that you obtained and saved locally after calling the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-gb-device":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_gb_device","summary":"DeleteGbDevice","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey"},"DeviceName":{"type":"string","description":"The DeviceName"},"IotId":{"type":"string","description":"The IotId"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-local-file-upload-job":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_local_file_upload_job","summary":"Stops a local recording upload task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value exists, you…"},"JobId":{"type":"string","description":"The ID of the local recording upload task, which is generated by https://help.aliyun.com/document_detail/363002.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-picture":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_picture","summary":"Deletes cloud-stored pictures in batches by picture IDs for a specified IPC device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PictureIdList"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PictureIdList":{"type":"string","description":"The list of picture IDs. Picture IDs are generated when you call https://help.aliyun.com/document_detail/107914.html. A maximum of 50…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page of the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-record":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_record","summary":"Deletes video recording files stored in the cloud","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileNameList"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"FileNameList":{"type":"string","description":"The list of recording file names to delete. You can obtain recording file names by calling…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value is…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-record-plan":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_record_plan","summary":"Deletes a recording plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PlanId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PlanId":{"type":"string","description":"The ID of the recording plan. You can call https://help.aliyun.com/document_detail/107896.html to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-record-plan-device":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_record_plan_device","summary":"Deletes the recording plan associated with an IPC device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StreamType"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"StreamType":{"type":"integer","description":"The stream type. Valid values: 0: main stream. 1: sub stream"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-rtmp-device":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_rtmp_device","summary":"DeleteRtmpDevice","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey"},"DeviceName":{"type":"string","description":"The DeviceName"},"IotId":{"type":"string","description":"The IotId"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-rtmp-key":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_rtmp_key","summary":"DeleteRtmpKey","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Type","IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"Type":{"type":"integer","description":"The Type"},"ProductKey":{"type":"string","description":"The ProductKey"},"DeviceName":{"type":"string","description":"The DeviceName"},"IotId":{"type":"string","description":"The IotId"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-stream-push-job":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_stream_push_job","summary":"Deletes a video stream pushing job","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId","IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the device belongs. You can view the ProductKey on the Products page of the IoT Platform console or…"},"DeviceName":{"type":"string","description":"The DeviceName of the device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this parameter,…"},"JobId":{"type":"string","description":"The job ID"},"IotId":{"type":"string","description":"The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-stream-snapshot-job":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_stream_snapshot_job","summary":"Deletes a video snapshot task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the device belongs. You can view the ProductKey on the Products page of the IoT Platform console or…"},"DeviceName":{"type":"string","description":"The name of the device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this parameter, you…"},"IotId":{"type":"string","description":"The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console"},"StreamType":{"type":"integer","description":"The stream type. 0 (default): main stream. 1: sub stream"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/delete-time-template":{"post":{"operationId":"cloud_aliyun_linkvisual_delete_time_template","summary":"Deletes a time template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TemplateId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"TemplateId":{"type":"string","description":"The ID of the time template. You can call https://help.aliyun.com/document_detail/107890.html to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/detect-user-face-by-url":{"post":{"operationId":"cloud_aliyun_linkvisual_detect_user_face_by_url","summary":"DetectUserFaceByUrl","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FacePicUrl"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"FacePicUrl":{"type":"string","description":"The FacePicUrl"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/enable-gb-sub-device":{"post":{"operationId":"cloud_aliyun_linkvisual_enable_gb_sub_device","summary":"EnableGbSubDevice","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SubDeviceId","IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"SubDeviceId":{"type":"string","description":"The SubDeviceId"},"ProductKey":{"type":"string","description":"The ProductKey"},"DeviceName":{"type":"string","description":"The DeviceName"},"IotId":{"type":"string","description":"The IotId"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/get-picture-search-job-status":{"post":{"operationId":"cloud_aliyun_linkvisual_get_picture_search_job_status","summary":"Retrieves the status of an integrated image search task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppInstanceId","JobId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"AppInstanceId":{"type":"string","description":"Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID"},"JobId":{"type":"string","description":"The ID of the image search task. You can call https://help.aliyun.com/document_detail/206778.html to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/picture-search-picture":{"post":{"operationId":"cloud_aliyun_linkvisual_picture_search_picture","summary":"Starts an image search application instance to perform image-to-text search","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppInstanceId","PageSize","CurrentPage","SearchPicUrl","StartTime","EndTime","Threshold","ContainPicUrl"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"AppInstanceId":{"type":"string","description":"Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID"},"PageSize":{"type":"integer","description":"The number of entries per page. Maximum value: 10"},"CurrentPage":{"type":"integer","description":"The page number to return. Pages start from page 1"},"SearchPicUrl":{"type":"string","description":"The URL of the image to search"},"StartTime":{"type":"integer","description":"The beginning of the search time range. The value is a 13-digit UNIX timestamp. Unit: milliseconds"},"EndTime":{"type":"integer","description":"The end of the search time range. The value is a 13-digit UNIX timestamp. Unit: milliseconds"},"Threshold":{"type":"number","description":"The search threshold. Valid values: 0 to 1. Set the search threshold to 0.3 or higher to ensure matching with the detection object"},"ContainPicUrl":{"type":"string","description":"Specifies whether the response contains photo URLs. The response is returned regardless of whether this parameter is set to true or false"},"PictureSearchType":{"type":"integer","description":"The search type. Valid values: 1 (default): face. 0: human body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-car-process-events":{"post":{"operationId":"cloud_aliyun_linkvisual_query_car_process_events","summary":"Queries the list of intelligent alert events for vehicle operations","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CurrentPage","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value is…"},"SubIotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"SubProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"SubDeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"BeginTime":{"type":"integer","description":"The start time of the query range. The value is a 13-digit timestamp in milliseconds"},"EndTime":{"type":"integer","description":"The end time of the query range. The value is a 13-digit timestamp in milliseconds"},"CurrentPage":{"type":"integer","description":"The page number to return. Pages start from page 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Minimum value: 1. Maximum value: 20. Default value: 10"},"PlateNo":{"type":"string","description":"The license plate number. A maximum of 15 characters is supported"},"ActionType":{"type":"integer","description":"The action type of the vehicle. Valid values: 1: entering 2: staying 3: leaving"},"AreaIndex":{"type":"integer","description":"The detection box of the IPC device. You can call the https://help.aliyun.com/document_detail/69584.html operation to query the number of…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-device-event":{"post":{"operationId":"cloud_aliyun_linkvisual_query_device_event","summary":"Queries the list of intelligent alert events for an IPC device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BeginTime","EndTime"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The name of the IPC device. You can view DeviceName on the Devices page in the IoT Platform console. If you specify this parameter, you…"},"IotId":{"type":"string","description":"The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"EventType":{"type":"integer","description":"The type of intelligent alert event: Set to all intelligent alert events: 0. Set to a specific intelligent alert event: enter the serial…"},"BeginTime":{"type":"integer","description":"The start time of the query range. The value is a 13-digit timestamp in milliseconds"},"EndTime":{"type":"integer","description":"The end time of the query range. The value is a 13-digit timestamp in milliseconds"},"CurrentPage":{"type":"integer","description":"The page number to start displaying from in the returned results. Pages start from 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-device-event-picture":{"post":{"operationId":"cloud_aliyun_linkvisual_query_device_event_picture","summary":"Retrieves the image captured and uploaded by an IPC device when an intelligent alert event is triggered","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EventId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"EventId":{"type":"string","description":"The ID of the intelligent alert event. You can obtain this ID by calling the https://help.aliyun.com/document_detail/107916.html operation"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-device-event-record":{"post":{"operationId":"cloud_aliyun_linkvisual_query_device_event_record","summary":"Retrieves the recording file URL for a specified intelligent alert event from an IPC device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EventId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page of the IoT Platform…"},"DeviceName":{"type":"string","description":"The name of the IPC device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this parameter,…"},"IotId":{"type":"string","description":"The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"EventId":{"type":"string","description":"The ID of the intelligent alert event. You can obtain this ID by calling the https://help.aliyun.com/document_detail/107916.html operation"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page of the IoT Platform console. If an ID value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-device-picture-by-list":{"post":{"operationId":"cloud_aliyun_linkvisual_query_device_picture_by_list","summary":"Retrieves image URLs based on a list of image IDs","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PictureIdList"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page of the IoT Platform…"},"DeviceName":{"type":"string","description":"The name of the IPC device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this parameter,…"},"IotId":{"type":"string","description":"The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"ThumbWidth":{"type":"integer","description":"The width of the target thumbnail. Unit: px. Valid values: 1 to 4096"},"ExpireTime":{"type":"integer","description":"The expiration time of the image URL. Unit: minutes"},"PictureType":{"type":"integer","description":"The image type. Valid values: 0: thumbnail. 1: original image. 2 (default): all"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page of the IoT Platform console. If an ID value exists, you…"},"PictureIdList":{"type":"string","description":"The list of image IDs. Image IDs are generated when you call https://help.aliyun.com/document_detail/107914.html. A maximum of 50 image…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-device-picture-file":{"post":{"operationId":"cloud_aliyun_linkvisual_query_device_picture_file","summary":"Queries the picture information captured by an IPC device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CaptureId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page of the IoT Platform…"},"DeviceName":{"type":"string","description":"The name of the IPC device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this parameter,…"},"IotId":{"type":"string","description":"The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"CaptureId":{"type":"string","description":"The ID of the picture generated when a capture event occurs: For pictures captured by active triggering, refer to…"},"ThumbWidth":{"type":"integer","description":"The width of the target thumbnail, in pixels. Valid values: 1 to 4096"},"ExpireTime":{"type":"integer","description":"The expiration time of the picture URL, in minutes. Valid values: 1 to 43200"},"PictureType":{"type":"integer","description":"The picture type. Valid values: 0: thumbnail. 1: original picture. 2 (default): all"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-device-picture-life-cycle":{"post":{"operationId":"cloud_aliyun_linkvisual_query_device_picture_life_cycle","summary":"Queries the cloud storage image lifecycle of an IPC device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-device-record-life-cycle":{"post":{"operationId":"cloud_aliyun_linkvisual_query_device_record_life_cycle","summary":"Retrieves the recording lifecycle of IPC devices, which is the duration that recording files are stored in…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DeviceList"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"DeviceList":{"type":"string","description":"The list of IotId values for IPC devices. An IotId is the ID issued by IoT Platform for the device and serves as the unique identifier of…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-device-vod-url":{"post":{"operationId":"cloud_aliyun_linkvisual_query_device_vod_url","summary":"Retrieves the URL of a recording file by file name from the storage card of a local network video recorder…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileName"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"FileName":{"type":"string","description":"The recording file name. You can call the https://help.aliyun.com/document_detail/69584.html operation provided by IoT Platform to query…"},"Scheme":{"type":"string","description":"The protocol type. Valid values: rtmp: RTMP protocol. flv: HTTP-FLV protocol. hls: HLS protocol. For more information about the limits on…"},"SeekTime":{"type":"integer","description":"The offset from the recording start time BeginTime, in seconds. Default value: 0"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value exists, you…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"EnableStun":{"type":"string","description":"The EnableStun"},"ShouldEncrypt":{"type":"string","description":"Specifies whether to encrypt the URL. Valid values: true: Encrypted. false (default): Not encrypted"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"UrlValidDuration":{"type":"integer","description":"The validity period of the URL. Valid values: 10 to 14400. Unit: seconds. Default value: 10"},"PlayUnLimited":{"type":"string","description":"Specifies whether the playback URL can be used an unlimited number of times. Valid values: true: The URL can be used an unlimited number…"},"EncryptType":{"type":"integer","description":"The encryption type. Currently, only I-frame encryption is supported. Set the value to 0"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-device-vod-url-by-time":{"post":{"operationId":"cloud_aliyun_linkvisual_query_device_vod_url_by_time","summary":"Retrieves the playback URL of a recording file within a specified time range from the storage card of a…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BeginTime","EndTime"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"Scheme":{"type":"string","description":"The protocol type. Valid values: rtmp: RTMP protocol. flv: HTTP-FLV protocol. hls: HLS protocol. For more information about the limits of…"},"SeekTime":{"type":"integer","description":"The offset from the recording start time specified by BeginTime. Unit: seconds. Default value: 0"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If this ID value exists,…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"EnableStun":{"type":"string","description":"The EnableStun"},"ShouldEncrypt":{"type":"string","description":"Specifies whether to encrypt the stream. Valid values: true: Encrypted. false (default): Not encrypted"},"BeginTime":{"type":"integer","description":"The recording start time. The value is a 10-digit UNIX timestamp. Unit: seconds"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"UrlValidDuration":{"type":"integer","description":"The validity period of the URL. Valid values: 10 to 14400. Unit: seconds. Default value: 10"},"PlayUnLimited":{"type":"string","description":"Specifies whether the playback URL can be used an unlimited number of times. Valid values: true: The URL can be used an unlimited number…"},"EndTime":{"type":"integer","description":"The recording end time. The value is a 10-digit UNIX timestamp. Unit: seconds"},"EncryptType":{"type":"integer","description":"The encryption type. Currently, only I-frame encryption is supported. Set the value to 0"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-event-record-plan-detail":{"post":{"operationId":"cloud_aliyun_linkvisual_query_event_record_plan_detail","summary":"Queries the details of an intelligent alert event recording plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PlanId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PlanId":{"type":"string","description":"The ID of the intelligent alert event recording plan. You can call https://help.aliyun.com/document_detail/107907.html to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-event-record-plan-device-by-device":{"post":{"operationId":"cloud_aliyun_linkvisual_query_event_record_plan_device_by_device","summary":"Queries the intelligent alert event recording plan of an IPC device by device ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If the ID value exists, you…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"StreamType":{"type":"integer","description":"The stream type. Valid values: 0 (default): main stream 1: sub stream"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-event-record-plan-device-by-plan":{"post":{"operationId":"cloud_aliyun_linkvisual_query_event_record_plan_device_by_plan","summary":"Queries the list of cameras associated with an intelligent alert event recording plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PlanId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PlanId":{"type":"string","description":"The ID of the intelligent alert event recording plan. You can call https://help.aliyun.com/document_detail/107907.html to query the ID"},"CurrentPage":{"type":"integer","description":"The page number to return. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-event-record-plans":{"post":{"operationId":"cloud_aliyun_linkvisual_query_event_record_plans","summary":"Queries the list of intelligent alert event recording plans","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"CurrentPage":{"type":"integer","description":"The page number to return. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-face-all-device-group":{"post":{"operationId":"cloud_aliyun_linkvisual_query_face_all_device_group","summary":"Queries all device groups","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","PageSize","PageNo"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"IotInstanceId":{"type":"string","description":"The instance ID"},"PageSize":{"type":"integer","description":"The page size"},"PageNo":{"type":"integer","description":"The page number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-face-all-user-group":{"post":{"operationId":"cloud_aliyun_linkvisual_query_face_all_user_group","summary":"Queries all user groups","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","PageSize","PageNo"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"PageSize":{"type":"integer","description":"The page size"},"PageNo":{"type":"integer","description":"The page number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-face-all-user-group-and-device-group-relation":{"post":{"operationId":"cloud_aliyun_linkvisual_query_face_all_user_group_and_device_group_relation","summary":"Queries the user groups and device groups that have face synchronization relationships","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","PageSize","PageNo"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"PageSize":{"type":"integer","description":"The page size"},"PageNo":{"type":"integer","description":"The page number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-face-all-user-ids-by-group-id":{"post":{"operationId":"cloud_aliyun_linkvisual_query_face_all_user_ids_by_group_id","summary":"Queries all users in a user group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserGroupId","PageSize","PageNo"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"UserGroupId":{"type":"string","description":"The user group ID"},"PageSize":{"type":"integer","description":"The page size"},"PageNo":{"type":"integer","description":"The page number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-face-custom-user-id-by-user-id":{"post":{"operationId":"cloud_aliyun_linkvisual_query_face_custom_user_id_by_user_id","summary":"Queries the user ID in the caller's service based on the user ID from the face image library synchronization…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"UserId":{"type":"string","description":"The user ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-face-device-groups-by-device":{"post":{"operationId":"cloud_aliyun_linkvisual_query_face_device_groups_by_device","summary":"Queries the device groups to which a device belongs","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","IotInstanceId","ProductKey","DeviceName","PageSize","PageNo"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"IotInstanceId":{"type":"string","description":"The instance ID"},"ProductKey":{"type":"string","description":"The product key"},"DeviceName":{"type":"string","description":"The device name"},"PageSize":{"type":"integer","description":"The page size"},"PageNo":{"type":"integer","description":"The page number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-face-user":{"post":{"operationId":"cloud_aliyun_linkvisual_query_face_user","summary":"Queries the details of a user","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"UserId":{"type":"string","description":"The user ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-face-user-batch":{"post":{"operationId":"cloud_aliyun_linkvisual_query_face_user_batch","summary":"Queries user information in batches based on a list of user IDs","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserIdList","IsolationId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"UserIdList":{"type":"string","description":"The list of user IDs. Specify the user IDs that you obtained and saved locally after calling the…"},"IsolationId":{"type":"string","description":"The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-face-user-by-name":{"post":{"operationId":"cloud_aliyun_linkvisual_query_face_user_by_name","summary":"Queries face data by face name","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","PageSize","PageNo"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set…"},"Name":{"type":"string","description":"The username. The username can contain Chinese characters, letters, digits, underscores (_), and hyphens (-), and can be up to 64…"},"Params":{"type":"string","description":"The custom user parameter. Exact match is supported, but fuzzy match is not supported"},"PageSize":{"type":"integer","description":"The number of records per page. Maximum value: 50. Minimum value: 1"},"PageNo":{"type":"integer","description":"The page number to return. Minimum value: 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-face-user-group":{"post":{"operationId":"cloud_aliyun_linkvisual_query_face_user_group","summary":"Queries the user groups to which a user belongs","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserId","PageSize","PageNo"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"UserId":{"type":"string","description":"The user ID"},"PageSize":{"type":"integer","description":"The page size"},"PageNo":{"type":"integer","description":"The page number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-face-user-group-and-device-group-relation":{"post":{"operationId":"cloud_aliyun_linkvisual_query_face_user_group_and_device_group_relation","summary":"Queries the face synchronization relationship between a user group and a device group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","ControlId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"ControlId":{"type":"string","description":"The control ID of the face synchronization relationship between the user group and the device group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-face-user-id-by-custom-user-id":{"post":{"operationId":"cloud_aliyun_linkvisual_query_face_user_id_by_custom_user_id","summary":"Queries the user ID in the face image library synchronization service based on the user ID in the caller's…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","CustomUserId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"CustomUserId":{"type":"string","description":"The user ID in the caller's system"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-gb-sub-device-list":{"post":{"operationId":"cloud_aliyun_linkvisual_query_gb_sub_device_list","summary":"QueryGbSubDeviceList","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PageSize":{"type":"integer","description":"The PageSize"},"ProductKey":{"type":"string","description":"The ProductKey"},"DeviceName":{"type":"string","description":"The DeviceName"},"IotId":{"type":"string","description":"The IotId"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"},"PageStart":{"type":"integer","description":"The PageStart"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-live-streaming":{"post":{"operationId":"cloud_aliyun_linkvisual_query_live_streaming","summary":"Retrieves the live streaming URL of an IPC device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"Scheme":{"type":"string","description":"The playback protocol type. Valid values: rtmp (default): RTMP protocol. hls: HLS protocol. flv: HTTP-FLV protocol"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value is…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this parameter,…"},"EnableStun":{"type":"string","description":"The EnableStun"},"StreamType":{"type":"integer","description":"The stream type. Valid values: 0 (default): main stream. 1: sub stream"},"CacheDuration":{"type":"integer","description":"The duration of video cached data. Valid values: 0 to 10000. Unit: milliseconds. Default value: 0"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"ShouldEncrypt":{"type":"string","description":"Specifies whether to enable encryption. Valid values: true: Enable encryption. false (default): Disable encryption"},"UrlValidDuration":{"type":"integer","description":"The validity period of the URL. Valid values: 10 to 14400. Unit: seconds. Default value: 10"},"PlayUnLimited":{"type":"string","description":"Specifies whether the playback URL can be used an unlimited number of times within the validity period. Valid values: true: Allowed. false…"},"EncryptType":{"type":"integer","description":"The encryption type. Valid values: 1 (default): keyframe encryption. 0: no encryption"},"ForceIFrame":{"type":"string","description":"Specifies whether to send a forced I-frame command to the device. Valid values: true: Send the command. false (default): Do not send the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-local-file-upload-job":{"post":{"operationId":"cloud_aliyun_linkvisual_query_local_file_upload_job","summary":"Queries the task result of a local video upload node","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value…"},"JobId":{"type":"string","description":"The ID of the local video upload task. Created by calling https://help.aliyun.com/document_detail/363002.html"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-month-record":{"post":{"operationId":"cloud_aliyun_linkvisual_query_month_record","summary":"Queries whether an IPC device has recordings for each day of a specified month","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Month"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page of the IoT Platform…"},"DeviceName":{"type":"string","description":"The name of the IPC device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this parameter,…"},"IotId":{"type":"string","description":"The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"Month":{"type":"string","description":"The month to query, in the format of YYYYMM"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page of the IoT Platform console. If an ID value exists, you…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-picture-files":{"post":{"operationId":"cloud_aliyun_linkvisual_query_picture_files","summary":"Retrieves a list of images","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BeginTime","EndTime"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page of the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"BeginTime":{"type":"integer","description":"The start time of the query range. The value is a 13-digit UNIX timestamp in milliseconds"},"EndTime":{"type":"integer","description":"The end time of the query range. The value is a 13-digit UNIX timestamp in milliseconds"},"CurrentPage":{"type":"integer","description":"The page number to return. Pages start from 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 50"},"PictureType":{"type":"integer","description":"The image type. Valid values: 0: thumbnail. 1: original image. 2 (default): all"},"PictureSource":{"type":"integer","description":"The image source. Valid values: 0 (default): all events. 1: alert event capture. 2: active capture. 3: other. 4: cloud screenshot"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page of the IoT Platform console. If an ID value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-picture-search-aiboxes":{"post":{"operationId":"cloud_aliyun_linkvisual_query_picture_search_aiboxes","summary":"Queries the list of V-series edge all-in-one devices bound to an image search application instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppInstanceId","PageSize","CurrentPage"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"AppInstanceId":{"type":"string","description":"Instance ID of the image search application instance. You can call the https://help.aliyun.com/document_detail/206608.html operation to…"},"PageSize":{"type":"integer","description":"The number of records per page in the response. Maximum value: 30. Minimum value: 1. Default value: 10"},"CurrentPage":{"type":"integer","description":"Specifies the page number to start displaying from in the response. Minimum value: 1"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view your instance ID on the Overview page in the IoT Platform console. If the public instance does not have an…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-picture-search-apps":{"post":{"operationId":"cloud_aliyun_linkvisual_query_picture_search_apps","summary":"Queries the list of created image-to-text search application instances","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PageSize","CurrentPage"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PageSize":{"type":"integer","description":"The number of records per page in the response. Maximum value: 50. Minimum value: 1. Default value: 20"},"CurrentPage":{"type":"integer","description":"The page number to start displaying from in the response. Minimum value: 1"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-picture-search-devices":{"post":{"operationId":"cloud_aliyun_linkvisual_query_picture_search_devices","summary":"Queries the list of devices bound to an image search application instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppInstanceId","PageSize","CurrentPage"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"AppInstanceId":{"type":"string","description":"Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID"},"PageSize":{"type":"integer","description":"The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10"},"CurrentPage":{"type":"integer","description":"The page number to return. Pages start from page 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-picture-search-job":{"post":{"operationId":"cloud_aliyun_linkvisual_query_picture_search_job","summary":"Queries the list of integrated image-to-text search tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppInstanceId","PageSize","CurrentPage"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"AppInstanceId":{"type":"string","description":"Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID"},"JobStatus":{"type":"integer","description":"The job status. Valid values: 0: init 1: no data 2: running 3: succeeded 4: failed If this parameter is not set, all statuses are selected"},"PageSize":{"type":"integer","description":"The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10"},"CurrentPage":{"type":"integer","description":"The page number to start displaying from in the returned results. Pages start from 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-picture-search-job-result":{"post":{"operationId":"cloud_aliyun_linkvisual_query_picture_search_job_result","summary":"Queries the image search results of an integrated image-based search task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppInstanceId","JobId","PageSize","CurrentPage"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"AppInstanceId":{"type":"string","description":"Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID"},"JobId":{"type":"string","description":"The ID of the integrated image-based search task. You can call https://help.aliyun.com/document_detail/206778.html to query the ID"},"PageSize":{"type":"integer","description":"The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10"},"CurrentPage":{"type":"integer","description":"Specifies the page number to start displaying from in the returned results. Pages start from 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-record":{"post":{"operationId":"cloud_aliyun_linkvisual_query_record","summary":"Queries the list of cloud recordings","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BeginTime","EndTime"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"StreamType":{"type":"integer","description":"The stream type. Valid values: 0 (default): main stream. 1: sub stream"},"BeginTime":{"type":"integer","description":"The start time of the query range. The value is a 10-digit UNIX timestamp, in seconds"},"EndTime":{"type":"integer","description":"The end time of the query range. The value is a 10-digit UNIX timestamp, in seconds"},"RecordType":{"type":"integer","description":"The recording type. Valid values: 0: continuous recording. 1: intelligent alert event recording. 2 (default): active recording. If this…"},"CurrentPage":{"type":"integer","description":"The page number to start displaying results from. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 50"},"NeedSnapshot":{"type":"string","description":"Specifies whether a thumbnail is required. Valid values: true: Required. false (default): Not required"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview tab in the IoT Platform console. If an ID value exists, you…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-record-by-record-id":{"post":{"operationId":"cloud_aliyun_linkvisual_query_record_by_record_id","summary":"Queries the URL of a recording file by recording file ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RecordId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page of the IoT Platform…"},"DeviceName":{"type":"string","description":"The name of the IPC device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this parameter,…"},"IotId":{"type":"string","description":"The ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device. You can…"},"RecordId":{"type":"string","description":"The ID of the recording file. You can call https://help.aliyun.com/document_detail/107922.html to query the ID"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page of the IoT Platform console. If an ID value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-record-download-job-by-id":{"post":{"operationId":"cloud_aliyun_linkvisual_query_record_download_job_by_id","summary":"Queries the details of a cloud recording download task by task ID, including the start time, recording…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId","JobId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console"},"JobId":{"type":"string","description":"The ID of the cloud recording download task"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-record-download-job-list":{"post":{"operationId":"cloud_aliyun_linkvisual_query_record_download_job_list","summary":"Queries the list of cloud recording download tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console"},"PageSize":{"type":"integer","description":"The number of devices to display on each page in the response. Maximum value: 50"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the video device belongs. You can view the information of all products under the current instance…"},"DeviceName":{"type":"string","description":"The device name of the video device. You can view the DeviceName of devices under a specified product on the Devices page of the IoT…"},"IotId":{"type":"string","description":"The device ID of the video device. You can call the https://help.aliyun.com/document_detail/69594.html operation to query the device ID.…"},"CurrentPage":{"type":"integer","description":"The page number from which to start displaying the results. Pages start from page 1 by default"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-record-download-url":{"post":{"operationId":"cloud_aliyun_linkvisual_query_record_download_url","summary":"Requests the download URL of a cloud recording file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileName"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"FileName":{"type":"string","description":"The name of the recording file. You can call https://help.aliyun.com/document_detail/107922.html to query the file name"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If the ID value is…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-record-plan-detail":{"post":{"operationId":"cloud_aliyun_linkvisual_query_record_plan_detail","summary":"Queries the details of a recording plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PlanId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PlanId":{"type":"string","description":"The ID of the recording plan. You can call https://help.aliyun.com/document_detail/107896.html to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-record-plan-device-by-device":{"post":{"operationId":"cloud_aliyun_linkvisual_query_record_plan_device_by_device","summary":"Queries the recording plan of a video device based on the device ID of an IPC","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StreamType"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value exists, you…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"StreamType":{"type":"integer","description":"The stream type. Valid values: 0: main stream 1: sub stream"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-record-plan-device-by-plan":{"post":{"operationId":"cloud_aliyun_linkvisual_query_record_plan_device_by_plan","summary":"Queries the devices associated with a recording plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PlanId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PlanId":{"type":"string","description":"The ID of the recording plan. You can call https://help.aliyun.com/document_detail/107896.html to query the ID"},"CurrentPage":{"type":"integer","description":"The page number to return. Pages start from page 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-record-plans":{"post":{"operationId":"cloud_aliyun_linkvisual_query_record_plans","summary":"Queries the list of recording plans","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"CurrentPage":{"type":"integer","description":"The page number to display from the returned results. Pages start from 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-record-url":{"post":{"operationId":"cloud_aliyun_linkvisual_query_record_url","summary":"Queries the playback URL of a cloud recording file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileName"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"FileName":{"type":"string","description":"The name of the cloud recording file. You can call https://help.aliyun.com/document_detail/107922.html to query the file name"},"SeekTime":{"type":"integer","description":"The playback offset time of the recording, in seconds. Default value: 0"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value exists, you…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"UrlValidDuration":{"type":"integer","description":"The validity period of the URL, in seconds. Valid values: 10 to 3600"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-record-url-by-time":{"post":{"operationId":"cloud_aliyun_linkvisual_query_record_url_by_time","summary":"Retrieves the playback URL of recording files within a specified time range","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BeginTime","EndTime"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value exists, you…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"StreamType":{"type":"integer","description":"The stream type. Valid values: 0 (default): main stream 1: sub stream"},"BeginTime":{"type":"integer","description":"The start time of the query range. The value is a 10-digit UNIX timestamp, in seconds. Minimum value: 0. Maximum value: 2147483647"},"EndTime":{"type":"integer","description":"The end time of the query range. The value is a 10-digit UNIX timestamp, in seconds. Minimum value: 0. Maximum value: 2147483647"},"UrlValidDuration":{"type":"integer","description":"The validity period of the URL. Valid values: 10 to 3600. Unit: seconds"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-rtmp-key":{"post":{"operationId":"cloud_aliyun_linkvisual_query_rtmp_key","summary":"QueryRtmpKey","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey"},"DeviceName":{"type":"string","description":"The DeviceName"},"IotId":{"type":"string","description":"The IotId"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-stream-push-job":{"post":{"operationId":"cloud_aliyun_linkvisual_query_stream_push_job","summary":"Queries the details of a video stream push job, including the creation time, current push status, job type,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId","IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the device belongs. You can view the ProductKey on the Products page of the IoT Platform console or…"},"DeviceName":{"type":"string","description":"The name of the device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this parameter, you…"},"JobId":{"type":"string","description":"The job ID"},"IotId":{"type":"string","description":"The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-stream-push-job-list":{"post":{"operationId":"cloud_aliyun_linkvisual_query_stream_push_job_list","summary":"Queries the list and details of video stream push jobs, including the creation time, current push status,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PageSize":{"type":"integer","description":"The number of records to display on each page of the returned results. Maximum value: 100. Default value: 10"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the device belongs. You can view the ProductKey on the Products page of the IoT Platform console,…"},"DeviceName":{"type":"string","description":"The name of the device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this parameter, you…"},"IotId":{"type":"string","description":"The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console"},"CurrentPage":{"type":"integer","description":"The page number of the returned results to display. Default value: 1"},"JobType":{"type":"integer","description":"The type of the stream push job. 1 (default): continuous job. 2: trigger-based job that ends after interruption"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-stream-snapshot-job":{"post":{"operationId":"cloud_aliyun_linkvisual_query_stream_snapshot_job","summary":"Queries the list and details of cloud snapshot tasks, including the snapshot interval and stream type","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the device belongs. You can view the ProductKey on the Products page of the IoT Platform console,…"},"DeviceName":{"type":"string","description":"The DeviceName of the device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this parameter,…"},"IotId":{"type":"string","description":"The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-time-template":{"post":{"operationId":"cloud_aliyun_linkvisual_query_time_template","summary":"Queries the time template information of a device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"CurrentPage":{"type":"integer","description":"The page number to return. Pages start from page 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-time-template-detail":{"post":{"operationId":"cloud_aliyun_linkvisual_query_time_template_detail","summary":"Queries the details of a specified time template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TemplateId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"TemplateId":{"type":"string","description":"The ID of the time template. You can call https://help.aliyun.com/document_detail/107890.html to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-vision-device-info":{"post":{"operationId":"cloud_aliyun_linkvisual_query_vision_device_info","summary":"QueryVisionDeviceInfo","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey"},"DeviceName":{"type":"string","description":"The DeviceName"},"IotId":{"type":"string","description":"The IotId"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/query-voice-intercom":{"post":{"operationId":"cloud_aliyun_linkvisual_query_voice_intercom","summary":"Retrieves the voice intercom address of an IPC device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"Scheme":{"type":"string","description":"The connection protocol type for voice intercom. Valid values: ws: WebSocket connection protocol. The web voice call address obtained by…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value exists, you…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the information of all products under the current account on…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/refresh-gb-sub-device-list":{"post":{"operationId":"cloud_aliyun_linkvisual_refresh_gb_sub_device_list","summary":"RefreshGbSubDeviceList","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey"},"DeviceName":{"type":"string","description":"The DeviceName"},"IotId":{"type":"string","description":"The IotId"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/remove-face-device-from-device-group":{"post":{"operationId":"cloud_aliyun_linkvisual_remove_face_device_from_device_group","summary":"Removes a device from a device group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","ProductKey","DeviceName","DeviceGroupId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"IotInstanceId":{"type":"string","description":"The instance ID"},"ProductKey":{"type":"string","description":"The ProductKey of the product on IoT Platform"},"DeviceName":{"type":"string","description":"The device name"},"DeviceGroupId":{"type":"string","description":"The device group ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/remove-face-user-from-user-group":{"post":{"operationId":"cloud_aliyun_linkvisual_remove_face_user_from_user_group","summary":"Removes a user from a user group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserId","UserGroupId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID"},"UserId":{"type":"string","description":"The user ID"},"UserGroupId":{"type":"string","description":"The user group ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/set-device-picture-life-cycle":{"post":{"operationId":"cloud_aliyun_linkvisual_set_device_picture_life_cycle","summary":"Sets the cloud storage image lifecycle for an IPC device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Day"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value exists, you…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the information about all products under the current account…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"Day":{"type":"integer","description":"The storage duration of images in the cloud. Unit: days"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/set-device-record-life-cycle":{"post":{"operationId":"cloud_aliyun_linkvisual_set_device_record_life_cycle","summary":"Sets the recording lifecycle of an IPC device, which specifies the number of days that recording files are…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Day"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value is…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"Day":{"type":"integer","description":"The recording lifecycle, which specifies the number of days that recording files are retained in the cloud. You must set the recording…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/stop-live-streaming":{"post":{"operationId":"cloud_aliyun_linkvisual_stop_live_streaming","summary":"Stops an IPC device from pushing streams","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by the IoT platform for the device and serves as the unique identifier of the…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page of the IoT platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page of the IoT platform console. If you specify this…"},"StreamType":{"type":"integer","description":"The stream type. Valid values: 0 (default): main stream. 1: sub stream"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT platform console. If an ID value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/stop-triggered-record":{"post":{"operationId":"cloud_aliyun_linkvisual_stop_triggered_record","summary":"Stops an IPC device from actively triggering recording","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RecordId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value…"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"RecordId":{"type":"string","description":"The recording ID. You can call https://help.aliyun.com/document_detail/107915.html to query the ID"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/transfer-device-instance":{"post":{"operationId":"cloud_aliyun_linkvisual_transfer_device_instance","summary":"Migrates a device to a different instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DeviceNameList","ProductKey","TargetInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"DeviceNameList":{"type":"string","description":"The list of device names to be migrated. A maximum of 100 device names can be specified (JSON-encoded)"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the device belongs. This is the unique identifier generated by IoT Platform when the product is…"},"SourceInstanceId":{"type":"string","description":"The ID of the source instance to which the device belongs: Public instance ID: iotx-oxssharez200. > Currently, only the China (Shanghai)…"},"TargetInstanceId":{"type":"string","description":"The ID of the target instance to which the device is migrated. Only Enterprise instances are supported as the target instance. You can log…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/trigger-capture-picture":{"post":{"operationId":"cloud_aliyun_linkvisual_trigger_capture_picture","summary":"Triggers an IPC device to capture an image and upload it to the cloud","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page of the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page of the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page of the IoT Platform console. If an ID value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/trigger-record":{"post":{"operationId":"cloud_aliyun_linkvisual_trigger_record","summary":"Triggers a specified IPC device to immediately start recording and upload the recording file to the cloud","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["RecordDuration"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"ProductKey":{"type":"string","description":"The ProductKey of the product to which the IPC device belongs. You can view the ProductKey on the Products page in the IoT Platform…"},"DeviceName":{"type":"string","description":"The device name of the IPC device. You can view the DeviceName on the Devices page in the IoT Platform console. If you specify this…"},"IotId":{"type":"string","description":"The device ID of the IPC device. This is the ID issued by IoT Platform for the device and serves as the unique identifier of the device.…"},"StreamType":{"type":"integer","description":"The stream type. Valid values: 0 (default): main stream. 1: sub stream"},"PreRecordDuration":{"type":"integer","description":"The pre-recording duration. Valid values: 0 to 10. Unit: seconds. The pre-recording duration is generated only when the device supports…"},"RecordDuration":{"type":"integer","description":"The recording duration, including the pre-recording duration. Valid values: 10 to 7200. Unit: seconds. The maximum length of a single…"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Overview page in the IoT Platform console. If an ID value exists, you…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/unbind-picture-search-app-with-devices":{"post":{"operationId":"cloud_aliyun_linkvisual_unbind_picture_search_app_with_devices","summary":"Unbinds devices from an image-to-text search application instance in batches","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppInstanceId","DeviceIotIds"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"AppInstanceId":{"type":"string","description":"Instance ID of the image-to-text search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query…"},"IotInstanceId":{"type":"string","description":"The instance ID. Enterprise Enterprise instance: This parameter is required. You can view the ID of your Enterprise Enterprise instance on…"},"DeviceIotIds":{"type":"string","description":"The list of device IotIds. You can specify the IotId of a V series edge server or a camera. The IotId is the unique identifier of the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/update-event-record-plan":{"post":{"operationId":"cloud_aliyun_linkvisual_update_event_record_plan","summary":"Updates the recording plan for intelligent alert events","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PlanId","Name","RecordDuration","TemplateId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PlanId":{"type":"string","description":"The ID of the intelligent alert event recording plan. You can call https://help.aliyun.com/document_detail/107907.html to query the ID"},"Name":{"type":"string","description":"The name of the intelligent alert event recording plan. The name must be less than 48 characters in length and can contain letters,…"},"EventTypes":{"type":"string","description":"The intelligent alert event types. To specify all intelligent alert event types, set this parameter to 0. To specify multiple intelligent…"},"PreRecordDuration":{"type":"integer","description":"The pre-recording duration. Valid values: 0 to 10. Unit: seconds. The pre-recording duration is generated only when the device supports…"},"RecordDuration":{"type":"integer","description":"The recording duration, including the pre-recording duration. Valid values: 10 to 60. Unit: seconds"},"TemplateId":{"type":"string","description":"The ID of the time template. You can call https://help.aliyun.com/document_detail/107890.html to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/update-face-user":{"post":{"operationId":"cloud_aliyun_linkvisual_update_face_user","summary":"Updates user information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","UserId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The isolation ID. Used for data isolation between different applications under a tenant. For example, if a user has businesses in both…"},"UserId":{"type":"string","description":"The user ID"},"Name":{"type":"string","description":"The username"},"Params":{"type":"string","description":"The user information"},"FacePicUrl":{"type":"string","description":"The URL for downloading the image. Currently, JPG and JPEG format images are supported"},"CustomUserId":{"type":"string","description":"The unique ID of the user in the caller's business system, such as an ID card number or student ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/update-face-user-group-and-device-group-relation":{"post":{"operationId":"cloud_aliyun_linkvisual_update_face_user_group_and_device_group_relation","summary":"Updates the face synchronization relationship between a user group and a device group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IsolationId","ControlId","Relation"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IsolationId":{"type":"string","description":"The business isolation ID that isolates data between different business applications under the same Alibaba Cloud account. Set this…"},"ControlId":{"type":"string","description":"The control ID of the synchronization relationship between the user group and the device group. Set this parameter to the ControlId value…"},"Relation":{"type":"string","description":"The face synchronization relationship. Currently, only SYNC_INFO_PICTURE is supported, which indicates that user photos and user…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/update-gb-device":{"post":{"operationId":"cloud_aliyun_linkvisual_update_gb_device","summary":"UpdateGbDevice","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"Description":{"type":"string","description":"The Description"},"ProductKey":{"type":"string","description":"The ProductKey"},"GbId":{"type":"string","description":"The GbId"},"DeviceName":{"type":"string","description":"The DeviceName"},"Password":{"type":"string","description":"The Password"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"},"IotId":{"type":"string","description":"The IotId"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/update-instance-internet-protocol":{"post":{"operationId":"cloud_aliyun_linkvisual_update_instance_internet_protocol","summary":"Sets the IP protocol version supported by an instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId","IpVersion"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"IotInstanceId":{"type":"string","description":"The instance ID. You can view the ID of the current instance on the Instance Overview page in the IoT Platform console. If an ID value is…"},"IpVersion":{"type":"string","description":"The IP protocol version. Valid values: IPv4 (default) IPv6 When the IP protocol version is set to IPv6, streaming media-related addresses…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/update-picture-search-app":{"post":{"operationId":"cloud_aliyun_linkvisual_update_picture_search_app","summary":"Modifies the information of an image search application instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppInstanceId","Name","Description"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"AppInstanceId":{"type":"string","description":"Instance ID of the image search application instance. You can call [QueryPictureSearchApps](206608) to query instance ID"},"Name":{"type":"string","description":"The name of the image search application instance. The name can contain Chinese characters, letters, digits, underscores (_), and hyphens…"},"Description":{"type":"string","description":"The description of the image search application instance. The description can contain Chinese characters, letters, digits, underscores…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/update-record-plan":{"post":{"operationId":"cloud_aliyun_linkvisual_update_record_plan","summary":"Updates a recording plan","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PlanId","Name","TemplateId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PlanId":{"type":"string","description":"The ID of the recording plan. You can call https://help.aliyun.com/document_detail/107896.html to query the ID"},"Name":{"type":"string","description":"The name of the recording plan. The name must be fewer than 48 characters in length and can contain letters, digits, and the following…"},"TemplateId":{"type":"string","description":"The ID of the time template to associate with the recording plan. You can call https://help.aliyun.com/document_detail/107890.html to…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/update-rtmp-key":{"post":{"operationId":"cloud_aliyun_linkvisual_update_rtmp_key","summary":"UpdateRtmpKey","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IotInstanceId"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"PullKeyExpireTime":{"type":"integer","description":"The PullKeyExpireTime"},"ProductKey":{"type":"string","description":"The ProductKey"},"DeviceName":{"type":"string","description":"The DeviceName"},"IotInstanceId":{"type":"string","description":"The IotInstanceId"},"PushKeyExpireTime":{"type":"integer","description":"The PushKeyExpireTime"},"PushAuthKey":{"type":"string","description":"The PushAuthKey"},"IotId":{"type":"string","description":"The IotId"},"PullAuthKey":{"type":"string","description":"The PullAuthKey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/update-time-template":{"post":{"operationId":"cloud_aliyun_linkvisual_update_time_template","summary":"Updates a time template","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TemplateId","AllDay"],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"},"TimeSections":{"type":"string","description":"The list of time sections (JSON-encoded)"},"TemplateId":{"type":"string","description":"The ID of the time template. You can call https://help.aliyun.com/document_detail/107890.html to query the ID"},"Name":{"type":"string","description":"The name of the time template. The name must be fewer than 48 characters in length and can contain letters, digits, and the following…"},"AllDay":{"type":"integer","description":"Specifies whether to enable 24/7 recording. Valid values: 1: Yes. 0: No. For detailed configurations, see the TimeSections.N.DayOfWeek,…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-linkvisual/version":{"post":{"operationId":"cloud_aliyun_linkvisual_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://linkvisual.aliyuncs.com","https://linkvisual.ap-northeast-1.aliyuncs.com","https://linkvisual.cn-hangzhou.aliyuncs.com","https://linkvisual.cn-shanghai.aliyuncs.com"],"default":"https://linkvisual.aliyuncs.com","description":"Regional endpoint, for example https://linkvisual.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}