# Alibaba Cloud LinkVisual API

> Alibaba Cloud LinkVisual API on Apizie: 123 endpoints (Adds a smart alert event recording plan for an IPC device, Creates a device group for the face image library, Adds a device to a device group, Adds a user to the face database, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-linkvisual`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/linkvisual
- Page: https://zieapi.vercel.app/api/cloud/aliyun-linkvisual
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-linkvisual/openapi.json

Alibaba Cloud OpenAPI for LinkVisual (linkvisual, version 2018-01-20). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a smart alert event recording plan for an IPC device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/add-event-record-plan-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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 | integer | no | The stream type. Valid values: 0 (default): main stream. 1: sub stream |
| PlanId | string | yes | 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 |

### Creates a device group for the face image library
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/add-face-device-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The business isolation ID, which is used for data isolation between different business applications under the same Alibaba Cloud account.… |
| DeviceGroupName | string | yes | The device group name. Specify a custom value. The value can be up to 128 characters in length |

### Adds a device to a device group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/add-face-device-to-device-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| IotInstanceId | string | no | The instance ID |
| ProductKey | string | yes | The product key |
| DeviceName | string | yes | The device name |
| DeviceGroupId | string | yes | The device group ID. You can obtain this ID by calling the AddFaceDeviceGroup operation |

### Adds a user to the face database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/add-face-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The business isolation ID, which is used for data isolation between different business applications under the same Alibaba Cloud account.… |
| FacePicUrl | string | yes | 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 | string | yes | 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 | string | no | The username. The value can contain Chinese characters, uppercase and lowercase letters, digits, underscores (_), and hyphens (-), and… |
| Params | string | no | The custom user parameters |

### Creates a user group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/add-face-user-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The business isolation ID, which is used for data isolation between different business applications under the same Alibaba Cloud account.… |
| UserGroupName | string | yes | The name of the user group. Specify a custom value. The name can be up to 128 characters in length |

### Adds a face synchronization relationship between a user group and a device group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/add-face-user-group-and-device-group-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| IotInstanceId | string | no | The instance ID |
| UserGroupId | string | yes | The user group ID |
| DeviceGroupId | string | yes | The device group ID |
| Relation | string | yes | The face synchronization relationship |

### Adds a face image for a user in the face database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/add-face-user-picture` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set… |
| UserId | string | yes | The user ID. Set this parameter to the UserId value that you obtained and saved locally after calling the… |
| FacePicUrl | string | yes | The URL download address of the face image. Only images in JPEG and JPG formats are supported. The image URL cannot contain Chinese… |

### Adds a user to a user group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/add-face-user-to-user-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The business isolation ID, which is used for data isolation between different business applications under the same Alibaba Cloud account.… |
| UserId | string | yes | 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 | string | yes | The user group ID. Specify the user group ID that you obtained and saved locally after calling the… |

### Adds a continuous recording plan to an IPC device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/add-record-plan-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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 | integer | yes | The stream type. Valid values: 0 (default): main stream. 1: sub stream |
| PlanId | string | yes | The recording plan ID. You can call https://help.aliyun.com/document_detail/107896.html to query the ID |

### BatchQueryVisionDeviceInfo
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/batch-query-vision-device-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | The ProductKey |
| IotInstanceId | string | yes | The IotInstanceId |
| DeviceNameList | string | no | The DeviceNameList (JSON-encoded) |
| IotIdList | string | no | The IotIdList (JSON-encoded) |

### Binds devices to an image search instance in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/bind-picture-search-app-with-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| AppInstanceId | string | yes | Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID |
| IotInstanceId | string | no | The instance ID. Enterprise Enterprise instance: This parameter is required. You can view the ID of your Enterprise Enterprise instance on… |
| DeviceIotIds | string | yes | 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… |

### Checks whether the face data of a specified user is successfully synced to a device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/check-face-user-do-exist-on-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| IotInstanceId | string | no | The isolation ID |
| UserId | string | yes | The user ID |
| ProductKey | string | yes | The ProductKey of the IoT Platform product |
| DeviceName | string | yes | The device name |

### Clears all face image libraries under a specified business isolation ID on a V-series edge all-in-one device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/clear-face-device-db` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The business isolation ID |
| IotInstanceId | string | no | 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 | string | yes | 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 | string | yes | 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… |

### Creates an intelligent alert event recording plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/create-event-record-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| Name | string | yes | 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 | string | no | The intelligent alert event type. To specify all intelligent alert event types, set this parameter to 0. To specify multiple intelligent… |
| PreRecordDuration | integer | no | The pre-recording duration. Unit: seconds. Default value: 0. Maximum value: 10 |
| RecordDuration | integer | yes | The recording duration, including the pre-recording duration. Unit: seconds. Valid values: 10 to 60 |
| TemplateId | string | yes | The ID of the time template. You can call https://help.aliyun.com/document_detail/107890.html to query the ID |

### CreateGbDevice
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/create-gb-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| Description | string | no | The Description |
| ProductKey | string | yes | The ProductKey |
| DeviceName | string | no | The DeviceName |
| GbId | string | yes | The GbId |
| Password | string | yes | The Password |
| IotInstanceId | string | yes | The IotInstanceId |
| DeviceType | integer | no | The DeviceType |
| SubProductKey | string | no | The SubProductKey |
| MediaNetProtocol | string | no | The MediaNetProtocol |

### Creates a local recording upload task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/create-local-file-upload-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| TimeSlot | string | no | The list of time slots (JSON-encoded) |
| IotInstanceId | string | no | 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… |

### Creates a task to download local recordings by time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/create-local-record-download-by-time-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console |
| ProductKey | string | no | The ProductKey of the product to which the video device belongs. You can view information about all products under the current instance on… |
| DeviceName | string | no | 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 | number | no | The upload speed multiplier of the device. Default value: 1.0. Valid values: 0.125 to 8.0 |
| BeginTime | integer | yes | The start time. The value is a 10-digit UNIX timestamp. Unit: seconds. Valid values: 0 to 2147483647 |
| IotId | string | no | 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 | integer | yes | 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… |

### Creates an image search application instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/create-picture-search-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| Name | string | yes | The name of the image search application instance. The name can contain Chinese characters, letters, digits, underscores (_), and hyphens… |
| Desc | string | yes | The description of the image search application instance. The description can contain Chinese characters, letters, digits, underscores… |
| IotInstanceId | string | no | 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… |

### Creates an integrated image-to-image search task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/create-picture-search-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| AppInstanceId | string | yes | Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID |
| SearchPicUrl | string | yes | The URL of the image to be searched |
| StartTime | integer | yes | The start time of the search range. The value is a 13-digit UNIX timestamp. Unit: milliseconds |
| EndTime | integer | yes | The end time of the search range. The value is a 13-digit UNIX timestamp. Unit: milliseconds |
| Threshold | number | yes | 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 | number | no | 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 | integer | no | The search type. Valid values: 1: face 0: body Default value: 1 |

### Creates a task to download cloud recordings by time
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/create-record-download-by-time-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console |
| ProductKey | string | no | The ProductKey of the product to which the video device belongs. You can view the information of all products under the current instance… |
| DeviceName | string | no | 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 | integer | no | The stream type. Valid values: 0 (default): main stream. 1: sub stream |
| BeginTime | integer | yes | The start time. The value is a 10-digit UNIX timestamp. Unit: seconds. Valid values: 0 to 2147483647 |
| RecordType | integer | no | The recording type. Valid values: 0: continuous recording. 1: event recording. 2: active recording. 4: local-to-cloud recording. Empty:… |
| IotId | string | no | 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 | integer | yes | 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… |

### Creates a recording plan based on a time template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/create-record-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| Name | string | yes | 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 | string | yes | The ID of the time template associated with the recording plan. You can call https://help.aliyun.com/document_detail/107888.html to query… |

### CreateRtmpDevice
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/create-rtmp-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PullKeyExpireTime | integer | no | The PullKeyExpireTime |
| Description | string | no | The Description |
| ProductKey | string | yes | The ProductKey |
| DeviceName | string | no | The DeviceName |
| IotInstanceId | string | yes | The IotInstanceId |
| PushKeyExpireTime | integer | no | The PushKeyExpireTime |
| PushAuthKey | string | no | The PushAuthKey |
| PullAuthKey | string | no | The PullAuthKey |
| SubStreamName | string | no | The SubStreamName |

### Creates a video stream push job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/create-stream-push-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console |
| StreamType | integer | no | The stream type. 0 (default): main stream. 1: sub stream |
| PushUrl | string | yes | The push URL. The maximum length is 500 bytes |
| JobType | integer | no | The type of the push job. 1 (default): continuous job. 2: trigger-based job that ends after an interruption |

### Creates a cloud snapshot task for a device stream
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/create-stream-snapshot-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console |
| StreamType | integer | no | The stream type. 0 (default): main stream. 1: sub stream |
| SnapshotInterval | integer | yes | The interval between snapshots. Valid values: 60 to 1800. Unit: seconds |

### Creates a time template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/create-time-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| TimeSections | string | no | The list of time ranges (JSON-encoded) |
| Name | string | yes | 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 | integer | yes | Specifies whether to enable 24/7 recording. Valid values: 1: Yes. 0: No. You must configure the TimeSections.N.DayOfWeek,… |

### Deletes an intelligent event recording plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-event-record-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PlanId | string | yes | The ID of the intelligent alert event recording plan. You can call https://help.aliyun.com/document_detail/107907.html to query the ID |

### Deletes an IPC device associated with an intelligent alert event recording plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-event-record-plan-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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 | integer | no | The stream type. Valid values: 0 (default): main stream. 1: sub stream |

### Deletes a device group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-face-device-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| DeviceGroupId | string | yes | The device group ID |

### Deletes a user from the face management service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-face-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The business isolation ID |
| UserId | string | yes | The unique user ID in the face service |

### Deletes a specified user group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-face-user-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set… |
| UserGroupId | string | yes | The user group ID. Set this parameter to the user group ID that you obtained and saved locally after calling the… |

### Deletes the face synchronization relationship between a user group and a device group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-face-user-group-and-device-group-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set… |
| ControlId | string | yes | The control ID of the synchronization relationship between the user group and the device group. Set this parameter to the value of… |

### Deletes a specified face image from a user in the face database
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-face-user-picture` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set… |
| UserId | string | yes | The user ID. Set this parameter to the UserId value that you obtained and saved locally after calling the… |
| FacePicMd5 | string | yes | 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… |

### DeleteGbDevice
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-gb-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | The ProductKey |
| DeviceName | string | no | The DeviceName |
| IotId | string | no | The IotId |
| IotInstanceId | string | yes | The IotInstanceId |

### Stops a local recording upload task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-local-file-upload-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | yes | The ID of the local recording upload task, which is generated by https://help.aliyun.com/document_detail/363002.html |

### Deletes cloud-stored pictures in batches by picture IDs for a specified IPC device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-picture` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PictureIdList | string | yes | 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 | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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… |

### Deletes video recording files stored in the cloud
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| FileNameList | string | yes | The list of recording file names to delete. You can obtain recording file names by calling… |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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.… |

### Deletes a recording plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-record-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PlanId | string | yes | The ID of the recording plan. You can call https://help.aliyun.com/document_detail/107896.html to query the ID |

### Deletes the recording plan associated with an IPC device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-record-plan-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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 | integer | yes | The stream type. Valid values: 0: main stream. 1: sub stream |

### DeleteRtmpDevice
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-rtmp-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | The ProductKey |
| DeviceName | string | no | The DeviceName |
| IotId | string | no | The IotId |
| IotInstanceId | string | yes | The IotInstanceId |

### DeleteRtmpKey
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-rtmp-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| Type | integer | yes | The Type |
| ProductKey | string | no | The ProductKey |
| DeviceName | string | no | The DeviceName |
| IotId | string | no | The IotId |
| IotInstanceId | string | yes | The IotInstanceId |

### Deletes a video stream pushing job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-stream-push-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | yes | The job ID |
| IotId | string | no | The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console |

### Deletes a video snapshot task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-stream-snapshot-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console |
| StreamType | integer | no | The stream type. 0 (default): main stream. 1: sub stream |

### Deletes a time template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/delete-time-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| TemplateId | string | yes | The ID of the time template. You can call https://help.aliyun.com/document_detail/107890.html to query the ID |

### DetectUserFaceByUrl
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/detect-user-face-by-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| FacePicUrl | string | yes | The FacePicUrl |

### EnableGbSubDevice
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/enable-gb-sub-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| SubDeviceId | string | yes | The SubDeviceId |
| ProductKey | string | no | The ProductKey |
| DeviceName | string | no | The DeviceName |
| IotId | string | no | The IotId |
| IotInstanceId | string | yes | The IotInstanceId |

### Retrieves the status of an integrated image search task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/get-picture-search-job-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| AppInstanceId | string | yes | Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID |
| JobId | string | yes | The ID of the image search task. You can call https://help.aliyun.com/document_detail/206778.html to query the ID |

### Starts an image search application instance to perform image-to-text search
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/picture-search-picture` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| AppInstanceId | string | yes | Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID |
| PageSize | integer | yes | The number of entries per page. Maximum value: 10 |
| CurrentPage | integer | yes | The page number to return. Pages start from page 1 |
| SearchPicUrl | string | yes | The URL of the image to search |
| StartTime | integer | yes | The beginning of the search time range. The value is a 13-digit UNIX timestamp. Unit: milliseconds |
| EndTime | integer | yes | The end of the search time range. The value is a 13-digit UNIX timestamp. Unit: milliseconds |
| Threshold | number | yes | 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 | string | yes | Specifies whether the response contains photo URLs. The response is returned regardless of whether this parameter is set to true or false |
| PictureSearchType | integer | no | The search type. Valid values: 1 (default): face. 0: human body |

### Queries the list of intelligent alert events for vehicle operations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-car-process-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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 | integer | no | The start time of the query range. The value is a 13-digit timestamp in milliseconds |
| EndTime | integer | no | The end time of the query range. The value is a 13-digit timestamp in milliseconds |
| CurrentPage | integer | yes | The page number to return. Pages start from page 1 |
| PageSize | integer | yes | The number of entries per page. Minimum value: 1. Maximum value: 20. Default value: 10 |
| PlateNo | string | no | The license plate number. A maximum of 15 characters is supported |
| ActionType | integer | no | The action type of the vehicle. Valid values: 1: entering 2: staying 3: leaving |
| AreaIndex | integer | no | 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… |

### Queries the list of intelligent alert events for an IPC device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-device-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| EventType | integer | no | The type of intelligent alert event: Set to all intelligent alert events: 0. Set to a specific intelligent alert event: enter the serial… |
| BeginTime | integer | yes | The start time of the query range. The value is a 13-digit timestamp in milliseconds |
| EndTime | integer | yes | The end time of the query range. The value is a 13-digit timestamp in milliseconds |
| CurrentPage | integer | no | The page number to start displaying from in the returned results. Pages start from 1 |
| PageSize | integer | no | The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10 |
| IotInstanceId | string | no | 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… |

### Retrieves the image captured and uploaded by an IPC device when an intelligent alert event is triggered
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-device-event-picture` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | 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 | string | yes | 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 | string | no | 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… |

### Retrieves the recording file URL for a specified intelligent alert event from an IPC device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-device-event-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| EventId | string | yes | 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 | string | no | 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… |

### Retrieves image URLs based on a list of image IDs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-device-picture-by-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| ThumbWidth | integer | no | The width of the target thumbnail. Unit: px. Valid values: 1 to 4096 |
| ExpireTime | integer | no | The expiration time of the image URL. Unit: minutes |
| PictureType | integer | no | The image type. Valid values: 0: thumbnail. 1: original image. 2 (default): all |
| IotInstanceId | string | no | 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 | string | yes | 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… |

### Queries the picture information captured by an IPC device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-device-picture-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| CaptureId | string | yes | The ID of the picture generated when a capture event occurs: For pictures captured by active triggering, refer to… |
| ThumbWidth | integer | no | The width of the target thumbnail, in pixels. Valid values: 1 to 4096 |
| ExpireTime | integer | no | The expiration time of the picture URL, in minutes. Valid values: 1 to 43200 |
| PictureType | integer | no | The picture type. Valid values: 0: thumbnail. 1: original picture. 2 (default): all |
| IotInstanceId | string | no | 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… |

### Queries the cloud storage image lifecycle of an IPC device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-device-picture-life-cycle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotId | string | yes | 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.… |

### Retrieves the recording lifecycle of IPC devices, which is the duration that recording files are stored in…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-device-record-life-cycle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| DeviceList | string | yes | 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… |

### Retrieves the URL of a recording file by file name from the storage card of a local network video recorder…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-device-vod-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| FileName | string | yes | The recording file name. You can call the https://help.aliyun.com/document_detail/69584.html operation provided by IoT Platform to query… |
| Scheme | string | no | The protocol type. Valid values: rtmp: RTMP protocol. flv: HTTP-FLV protocol. hls: HLS protocol. For more information about the limits on… |
| SeekTime | integer | no | The offset from the recording start time BeginTime, in seconds. Default value: 0 |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | The EnableStun |
| ShouldEncrypt | string | no | Specifies whether to encrypt the URL. Valid values: true: Encrypted. false (default): Not encrypted |
| IotId | string | no | 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 | integer | no | The validity period of the URL. Valid values: 10 to 14400. Unit: seconds. Default value: 10 |
| PlayUnLimited | string | no | 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 | integer | no | The encryption type. Currently, only I-frame encryption is supported. Set the value to 0 |

### Retrieves the playback URL of a recording file within a specified time range from the storage card of a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-device-vod-url-by-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| Scheme | string | no | The protocol type. Valid values: rtmp: RTMP protocol. flv: HTTP-FLV protocol. hls: HLS protocol. For more information about the limits of… |
| SeekTime | integer | no | The offset from the recording start time specified by BeginTime. Unit: seconds. Default value: 0 |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | The EnableStun |
| ShouldEncrypt | string | no | Specifies whether to encrypt the stream. Valid values: true: Encrypted. false (default): Not encrypted |
| BeginTime | integer | yes | The recording start time. The value is a 10-digit UNIX timestamp. Unit: seconds |
| IotId | string | no | 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 | integer | no | The validity period of the URL. Valid values: 10 to 14400. Unit: seconds. Default value: 10 |
| PlayUnLimited | string | no | 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 | integer | yes | The recording end time. The value is a 10-digit UNIX timestamp. Unit: seconds |
| EncryptType | integer | no | The encryption type. Currently, only I-frame encryption is supported. Set the value to 0 |

### Queries the details of an intelligent alert event recording plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-event-record-plan-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PlanId | string | yes | The ID of the intelligent alert event recording plan. You can call https://help.aliyun.com/document_detail/107907.html to query the ID |

### Queries the intelligent alert event recording plan of an IPC device by device ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-event-record-plan-device-by-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | The device ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| StreamType | integer | no | The stream type. Valid values: 0 (default): main stream 1: sub stream |

### Queries the list of cameras associated with an intelligent alert event recording plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-event-record-plan-device-by-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PlanId | string | yes | 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 | integer | no | The page number to return. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10 |

### Queries the list of intelligent alert event recording plans
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-event-record-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| CurrentPage | integer | no | The page number to return. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10 |

### Queries all device groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-face-all-device-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| IotInstanceId | string | no | The instance ID |
| PageSize | integer | yes | The page size |
| PageNo | integer | yes | The page number |

### Queries all user groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-face-all-user-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| PageSize | integer | yes | The page size |
| PageNo | integer | yes | The page number |

### Queries the user groups and device groups that have face synchronization relationships
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-face-all-user-group-and-device-group-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| PageSize | integer | yes | The page size |
| PageNo | integer | yes | The page number |

### Queries all users in a user group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-face-all-user-ids-by-group-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| UserGroupId | string | yes | The user group ID |
| PageSize | integer | yes | The page size |
| PageNo | integer | yes | The page number |

### Queries the user ID in the caller's service based on the user ID from the face image library synchronization…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-face-custom-user-id-by-user-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| UserId | string | yes | The user ID |

### Queries the device groups to which a device belongs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-face-device-groups-by-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| IotInstanceId | string | yes | The instance ID |
| ProductKey | string | yes | The product key |
| DeviceName | string | yes | The device name |
| PageSize | integer | yes | The page size |
| PageNo | integer | yes | The page number |

### Queries the details of a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-face-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| UserId | string | yes | The user ID |

### Queries user information in batches based on a list of user IDs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-face-user-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| UserIdList | string | yes | The list of user IDs. Specify the user IDs that you obtained and saved locally after calling the… |
| IsolationId | string | yes | The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set… |

### Queries face data by face name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-face-user-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The business isolation ID, which is used to isolate data between different business applications under the same Alibaba Cloud account. Set… |
| Name | string | no | The username. The username can contain Chinese characters, letters, digits, underscores (_), and hyphens (-), and can be up to 64… |
| Params | string | no | The custom user parameter. Exact match is supported, but fuzzy match is not supported |
| PageSize | integer | yes | The number of records per page. Maximum value: 50. Minimum value: 1 |
| PageNo | integer | yes | The page number to return. Minimum value: 1 |

### Queries the user groups to which a user belongs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-face-user-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| UserId | string | yes | The user ID |
| PageSize | integer | yes | The page size |
| PageNo | integer | yes | The page number |

### Queries the face synchronization relationship between a user group and a device group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-face-user-group-and-device-group-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| ControlId | string | yes | The control ID of the face synchronization relationship between the user group and the device group |

### Queries the user ID in the face image library synchronization service based on the user ID in the caller's…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-face-user-id-by-custom-user-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| CustomUserId | string | yes | The user ID in the caller's system |

### QueryGbSubDeviceList
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-gb-sub-device-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PageSize | integer | no | The PageSize |
| ProductKey | string | no | The ProductKey |
| DeviceName | string | no | The DeviceName |
| IotId | string | no | The IotId |
| IotInstanceId | string | yes | The IotInstanceId |
| PageStart | integer | no | The PageStart |

### Retrieves the live streaming URL of an IPC device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-live-streaming` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| Scheme | string | no | The playback protocol type. Valid values: rtmp (default): RTMP protocol. hls: HLS protocol. flv: HTTP-FLV protocol |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | The EnableStun |
| StreamType | integer | no | The stream type. Valid values: 0 (default): main stream. 1: sub stream |
| CacheDuration | integer | no | The duration of video cached data. Valid values: 0 to 10000. Unit: milliseconds. Default value: 0 |
| IotId | string | no | The device ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| ShouldEncrypt | string | no | Specifies whether to enable encryption. Valid values: true: Enable encryption. false (default): Disable encryption |
| UrlValidDuration | integer | no | The validity period of the URL. Valid values: 10 to 14400. Unit: seconds. Default value: 10 |
| PlayUnLimited | string | no | Specifies whether the playback URL can be used an unlimited number of times within the validity period. Valid values: true: Allowed. false… |
| EncryptType | integer | no | The encryption type. Valid values: 1 (default): keyframe encryption. 0: no encryption |
| ForceIFrame | string | no | Specifies whether to send a forced I-frame command to the device. Valid values: true: Send the command. false (default): Do not send the… |

### Queries the task result of a local video upload node
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-local-file-upload-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | yes | The ID of the local video upload task. Created by calling https://help.aliyun.com/document_detail/363002.html |

### Queries whether an IPC device has recordings for each day of a specified month
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-month-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | The ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| Month | string | yes | The month to query, in the format of YYYYMM |
| IotInstanceId | string | no | 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… |

### Retrieves a list of images
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-picture-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | The device ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| BeginTime | integer | yes | The start time of the query range. The value is a 13-digit UNIX timestamp in milliseconds |
| EndTime | integer | yes | The end time of the query range. The value is a 13-digit UNIX timestamp in milliseconds |
| CurrentPage | integer | no | The page number to return. Pages start from 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10. Maximum value: 50 |
| PictureType | integer | no | The image type. Valid values: 0: thumbnail. 1: original image. 2 (default): all |
| PictureSource | integer | no | The image source. Valid values: 0 (default): all events. 1: alert event capture. 2: active capture. 3: other. 4: cloud screenshot |
| IotInstanceId | string | no | 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… |

### Queries the list of V-series edge all-in-one devices bound to an image search application instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-picture-search-aiboxes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| AppInstanceId | string | yes | Instance ID of the image search application instance. You can call the https://help.aliyun.com/document_detail/206608.html operation to… |
| PageSize | integer | yes | The number of records per page in the response. Maximum value: 30. Minimum value: 1. Default value: 10 |
| CurrentPage | integer | yes | Specifies the page number to start displaying from in the response. Minimum value: 1 |
| IotInstanceId | string | no | 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… |

### Queries the list of created image-to-text search application instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-picture-search-apps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PageSize | integer | yes | The number of records per page in the response. Maximum value: 50. Minimum value: 1. Default value: 20 |
| CurrentPage | integer | yes | The page number to start displaying from in the response. Minimum value: 1 |
| IotInstanceId | string | no | 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… |

### Queries the list of devices bound to an image search application instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-picture-search-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| AppInstanceId | string | yes | Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID |
| PageSize | integer | yes | The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10 |
| CurrentPage | integer | yes | The page number to return. Pages start from page 1 |

### Queries the list of integrated image-to-text search tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-picture-search-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| AppInstanceId | string | yes | Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID |
| JobStatus | integer | no | 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 | integer | yes | The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10 |
| CurrentPage | integer | yes | The page number to start displaying from in the returned results. Pages start from 1 |

### Queries the image search results of an integrated image-based search task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-picture-search-job-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| AppInstanceId | string | yes | Instance ID of the image search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query instance ID |
| JobId | string | yes | 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 | integer | yes | The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10 |
| CurrentPage | integer | yes | Specifies the page number to start displaying from in the returned results. Pages start from 1 |

### Queries the list of cloud recordings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | 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 | integer | no | The stream type. Valid values: 0 (default): main stream. 1: sub stream |
| BeginTime | integer | yes | The start time of the query range. The value is a 10-digit UNIX timestamp, in seconds |
| EndTime | integer | yes | The end time of the query range. The value is a 10-digit UNIX timestamp, in seconds |
| RecordType | integer | no | The recording type. Valid values: 0: continuous recording. 1: intelligent alert event recording. 2 (default): active recording. If this… |
| CurrentPage | integer | no | The page number to start displaying results from. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10. Maximum value: 50 |
| NeedSnapshot | string | no | Specifies whether a thumbnail is required. Valid values: true: Required. false (default): Not required |
| IotInstanceId | string | no | 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… |

### Queries the URL of a recording file by recording file ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-record-by-record-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | 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 | string | yes | The ID of the recording file. You can call https://help.aliyun.com/document_detail/107922.html to query the ID |
| IotInstanceId | string | no | 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… |

### Queries the details of a cloud recording download task by task ID, including the start time, recording…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-record-download-job-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console |
| JobId | string | yes | The ID of the cloud recording download task |

### Queries the list of cloud recording download tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-record-download-job-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console |
| PageSize | integer | yes | The number of devices to display on each page in the response. Maximum value: 50 |
| ProductKey | string | no | The ProductKey of the product to which the video device belongs. You can view the information of all products under the current instance… |
| DeviceName | string | no | 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 | string | no | 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 | integer | no | The page number from which to start displaying the results. Pages start from page 1 by default |

### Requests the download URL of a cloud recording file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-record-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| FileName | string | yes | The name of the recording file. You can call https://help.aliyun.com/document_detail/107922.html to query the file name |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | The device ID of the IPC device. This is the unique identifier issued by IoT Platform for the device. You can call… |

### Queries the details of a recording plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-record-plan-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PlanId | string | yes | The ID of the recording plan. You can call https://help.aliyun.com/document_detail/107896.html to query the ID |

### Queries the recording plan of a video device based on the device ID of an IPC
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-record-plan-device-by-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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 | integer | yes | The stream type. Valid values: 0: main stream 1: sub stream |

### Queries the devices associated with a recording plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-record-plan-device-by-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PlanId | string | yes | The ID of the recording plan. You can call https://help.aliyun.com/document_detail/107896.html to query the ID |
| CurrentPage | integer | no | The page number to return. Pages start from page 1 |
| PageSize | integer | no | The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10 |

### Queries the list of recording plans
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-record-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| CurrentPage | integer | no | The page number to display from the returned results. Pages start from 1 |
| PageSize | integer | no | The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10 |

### Queries the playback URL of a cloud recording file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-record-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| FileName | string | yes | The name of the cloud recording file. You can call https://help.aliyun.com/document_detail/107922.html to query the file name |
| SeekTime | integer | no | The playback offset time of the recording, in seconds. Default value: 0 |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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 | integer | no | The validity period of the URL, in seconds. Valid values: 10 to 3600 |

### Retrieves the playback URL of recording files within a specified time range
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-record-url-by-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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 | integer | no | The stream type. Valid values: 0 (default): main stream 1: sub stream |
| BeginTime | integer | yes | The start time of the query range. The value is a 10-digit UNIX timestamp, in seconds. Minimum value: 0. Maximum value: 2147483647 |
| EndTime | integer | yes | The end time of the query range. The value is a 10-digit UNIX timestamp, in seconds. Minimum value: 0. Maximum value: 2147483647 |
| UrlValidDuration | integer | no | The validity period of the URL. Valid values: 10 to 3600. Unit: seconds |

### QueryRtmpKey
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-rtmp-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | The ProductKey |
| DeviceName | string | no | The DeviceName |
| IotId | string | no | The IotId |
| IotInstanceId | string | yes | The IotInstanceId |

### Queries the details of a video stream push job, including the creation time, current push status, job type,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-stream-push-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | yes | The job ID |
| IotId | string | no | The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console |

### Queries the list and details of video stream push jobs, including the creation time, current push status,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-stream-push-job-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PageSize | integer | no | The number of records to display on each page of the returned results. Maximum value: 100. Default value: 10 |
| ProductKey | string | no | 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 | string | no | 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 | string | no | The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console |
| CurrentPage | integer | no | The page number of the returned results to display. Default value: 1 |
| JobType | integer | no | The type of the stream push job. 1 (default): continuous job. 2: trigger-based job that ends after interruption |

### Queries the list and details of cloud snapshot tasks, including the snapshot interval and stream type
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-stream-snapshot-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | The ID of the device. This is the unique identifier issued by IoT Platform for the device. You can call… |
| IotInstanceId | string | yes | The instance ID. You can view the ID of the current instance on the Overview tab of the IoT Platform console |

### Queries the time template information of a device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-time-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| CurrentPage | integer | no | The page number to return. Pages start from page 1 |
| PageSize | integer | no | The number of entries per page. Minimum value: 1. Maximum value: 50. Default value: 10 |

### Queries the details of a specified time template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-time-template-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| TemplateId | string | yes | The ID of the time template. You can call https://help.aliyun.com/document_detail/107890.html to query the ID |

### QueryVisionDeviceInfo
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-vision-device-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | The ProductKey |
| DeviceName | string | no | The DeviceName |
| IotId | string | no | The IotId |
| IotInstanceId | string | yes | The IotInstanceId |

### Retrieves the voice intercom address of an IPC device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/query-voice-intercom` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| Scheme | string | no | The connection protocol type for voice intercom. Valid values: ws: WebSocket connection protocol. The web voice call address obtained by… |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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.… |

### RefreshGbSubDeviceList
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/refresh-gb-sub-device-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | The ProductKey |
| DeviceName | string | no | The DeviceName |
| IotId | string | no | The IotId |
| IotInstanceId | string | yes | The IotInstanceId |

### Removes a device from a device group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/remove-face-device-from-device-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| IotInstanceId | string | no | The instance ID |
| ProductKey | string | yes | The ProductKey of the product on IoT Platform |
| DeviceName | string | yes | The device name |
| DeviceGroupId | string | yes | The device group ID |

### Removes a user from a user group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/remove-face-user-from-user-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID |
| UserId | string | yes | The user ID |
| UserGroupId | string | yes | The user group ID |

### Sets the cloud storage image lifecycle for an IPC device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/set-device-picture-life-cycle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | no | The ProductKey of the product to which the IPC device belongs. You can view the information about all products under the current account… |
| DeviceName | string | no | 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 | string | no | 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 | integer | yes | The storage duration of images in the cloud. Unit: days |

### Sets the recording lifecycle of an IPC device, which specifies the number of days that recording files are…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/set-device-record-life-cycle` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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 | integer | yes | The recording lifecycle, which specifies the number of days that recording files are retained in the cloud. You must set the recording… |

### Stops an IPC device from pushing streams
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/stop-live-streaming` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotId | string | no | 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 | string | no | 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 | string | no | 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 | integer | no | The stream type. Valid values: 0 (default): main stream. 1: sub stream |
| IotInstanceId | string | no | 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… |

### Stops an IPC device from actively triggering recording
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/stop-triggered-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | no | 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 | string | no | 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 | string | no | 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 | string | yes | The recording ID. You can call https://help.aliyun.com/document_detail/107915.html to query the ID |
| IotId | string | no | 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.… |

### Migrates a device to a different instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/transfer-device-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| DeviceNameList | string | yes | The list of device names to be migrated. A maximum of 100 device names can be specified (JSON-encoded) |
| ProductKey | string | yes | The ProductKey of the product to which the device belongs. This is the unique identifier generated by IoT Platform when the product is… |
| SourceInstanceId | string | no | The ID of the source instance to which the device belongs: Public instance ID: iotx-oxssharez200. > Currently, only the China (Shanghai)… |
| TargetInstanceId | string | yes | The ID of the target instance to which the device is migrated. Only Enterprise instances are supported as the target instance. You can log… |

### Triggers an IPC device to capture an image and upload it to the cloud
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/trigger-capture-picture` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | 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 | string | no | 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… |

### Triggers a specified IPC device to immediately start recording and upload the recording file to the cloud
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/trigger-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| ProductKey | string | no | 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 | string | no | 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 | string | no | 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 | integer | no | The stream type. Valid values: 0 (default): main stream. 1: sub stream |
| PreRecordDuration | integer | no | The pre-recording duration. Valid values: 0 to 10. Unit: seconds. The pre-recording duration is generated only when the device supports… |
| RecordDuration | integer | yes | The recording duration, including the pre-recording duration. Valid values: 10 to 7200. Unit: seconds. The maximum length of a single… |
| IotInstanceId | string | no | 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… |

### Unbinds devices from an image-to-text search application instance in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/unbind-picture-search-app-with-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| AppInstanceId | string | yes | Instance ID of the image-to-text search application instance. You can call https://help.aliyun.com/document_detail/206608.html to query… |
| IotInstanceId | string | no | The instance ID. Enterprise Enterprise instance: This parameter is required. You can view the ID of your Enterprise Enterprise instance on… |
| DeviceIotIds | string | yes | 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… |

### Updates the recording plan for intelligent alert events
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/update-event-record-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PlanId | string | yes | 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 | string | yes | The name of the intelligent alert event recording plan. The name must be less than 48 characters in length and can contain letters,… |
| EventTypes | string | no | The intelligent alert event types. To specify all intelligent alert event types, set this parameter to 0. To specify multiple intelligent… |
| PreRecordDuration | integer | no | The pre-recording duration. Valid values: 0 to 10. Unit: seconds. The pre-recording duration is generated only when the device supports… |
| RecordDuration | integer | yes | The recording duration, including the pre-recording duration. Valid values: 10 to 60. Unit: seconds |
| TemplateId | string | yes | The ID of the time template. You can call https://help.aliyun.com/document_detail/107890.html to query the ID |

### Updates user information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/update-face-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The isolation ID. Used for data isolation between different applications under a tenant. For example, if a user has businesses in both… |
| UserId | string | yes | The user ID |
| Name | string | no | The username |
| Params | string | no | The user information |
| FacePicUrl | string | no | The URL for downloading the image. Currently, JPG and JPEG format images are supported |
| CustomUserId | string | no | The unique ID of the user in the caller's business system, such as an ID card number or student ID |

### Updates the face synchronization relationship between a user group and a device group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/update-face-user-group-and-device-group-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IsolationId | string | yes | The business isolation ID that isolates data between different business applications under the same Alibaba Cloud account. Set this… |
| ControlId | string | yes | The control ID of the synchronization relationship between the user group and the device group. Set this parameter to the ControlId value… |
| Relation | string | yes | The face synchronization relationship. Currently, only SYNC_INFO_PICTURE is supported, which indicates that user photos and user… |

### UpdateGbDevice
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/update-gb-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| Description | string | no | The Description |
| ProductKey | string | no | The ProductKey |
| GbId | string | no | The GbId |
| DeviceName | string | no | The DeviceName |
| Password | string | no | The Password |
| IotInstanceId | string | yes | The IotInstanceId |
| IotId | string | no | The IotId |

### Sets the IP protocol version supported by an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/update-instance-internet-protocol` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| IotInstanceId | string | yes | 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 | string | yes | The IP protocol version. Valid values: IPv4 (default) IPv6 When the IP protocol version is set to IPv6, streaming media-related addresses… |

### Modifies the information of an image search application instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/update-picture-search-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| AppInstanceId | string | yes | Instance ID of the image search application instance. You can call [QueryPictureSearchApps](206608) to query instance ID |
| Name | string | yes | The name of the image search application instance. The name can contain Chinese characters, letters, digits, underscores (_), and hyphens… |
| Description | string | yes | The description of the image search application instance. The description can contain Chinese characters, letters, digits, underscores… |

### Updates a recording plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/update-record-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://linkvisual.aliyuncs.com |
| PlanId | string | yes | The ID of the recording plan. You can call https://help.aliyun.com/document_detail/107896.html to query the ID |
| Name | string | yes | 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 | string | yes | The ID of the time template to associate with the recording plan. You can call https://help.aliyun.com/document_detail/107890.html to… |

…and 3 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/add-event-record-plan-device" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud LinkVisual API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-linkvisual/add-event-record-plan-device with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud LinkVisual API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud LinkVisual itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud LinkVisual API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-linkvisual.

### What is the status of the Alibaba Cloud LinkVisual API?
Needs your own provider key (bring your own key)