# Alibaba Cloud Video Surveillance System API

> Alibaba Cloud Video Surveillance System API on Apizie: 214 endpoints (Adds one or more instances to a specified cluster, Adds pull stream configurations, Associates cloud application service instances with a project, Binds multiple devices to directories in a single operation, …) 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-vs/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Video Surveillance System (vs, version 2018-12-12). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds one or more instances to a specified cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/add-hive-edge-workers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| HiveId | string | yes | The cluster ID |
| InstanceIds | string | yes | A list of instance IDs (JSON-encoded) |

### Adds pull stream configurations
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/add-vs-pull-stream-info-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | The accelerated domain name |
| AppName | string | yes | The application name |
| StreamName | string | yes | The stream name |
| SourceUrl | string | yes | The origin server of the live stream. Separate multiple origin servers with semicolons (;) |
| StartTime | string | no | The start time of stream pulling. Specify the time in UTC. The interval between StartTime and EndTime must be within 7 days |
| EndTime | string | no | The end time of stream pulling. Specify the time in UTC. The interval between StartTime and EndTime must be within 7 days, and EndTime… |
| Always | string | no | The Always |

### Associates cloud application service instances with a project
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/associate-rendering-project-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| ProjectId | string | yes | The project ID |
| RenderingInstanceIds | string | yes | The instance IDs of the cloud application service (JSON-encoded) |

### Binds multiple devices to directories in a single operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-bind-directories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DirectoryId | string | yes | Directory ID |
| DeviceId | string | yes | Device ID. Separate multiple values with commas |

### Binds multiple devices to a parent platform for push in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-bind-parent-platform-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| ParentPlatformId | string | yes | The ID of the parent platform |
| DeviceId | string | yes | The device IDs. Separate multiple values with commas |

### Binds multiple purchased devices
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-bind-purchased-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Region | string | yes | The region |
| GroupId | string | yes | The ID of the device group |
| DeviceId | string | yes | The ID of the device |

### Bind templates to multiple specified instances, such as instances bound to spaces and streams
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-bind-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| TemplateId | string | yes | Template ID |
| InstanceId | string | yes | Instance ID. Separate multiple values with commas |
| InstanceType | string | yes | Instance type. Valid values: group (space) stream (stream) |
| ApplyAll | string | no | Apply to all streams within the scope. Default value: false |
| Replace | string | no | Replace existing bindings. Default value: false |

### Binds multiple templates in a single operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-bind-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| TemplateId | string | yes | The template ID |
| TemplateType | string | no | The template type. Valid values: record (recording) snapshot (snapshotting) |
| InstanceId | string | yes | The instance ID |
| InstanceType | string | yes | The instance type. Valid values: group stream |
| ApplyAll | string | no | Specifies whether to apply the template to all streams in the scope. The default value is false |
| Replace | string | no | Specifies whether to replace existing bindings. The default value is false |

### Retrieves screenshots of cloud application service instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-capture-rendering-instance-screenshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| RenderingInstanceIds | string | yes | The list of instance IDs. A maximum of 100 instance IDs can be specified (JSON-encoded) |
| Quality | integer | no | The image quality. Valid values: 1 to 100 |

### Deletes multiple devices in a single operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-delete-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Device ID. Separate multiple values with commas |

### Deletes domain name configurations in a batch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-delete-vs-domain-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainNames | string | yes | The accelerated domain names. Separate multiple domain names with commas |
| FunctionNames | string | yes | The feature names. Separate multiple features with commas |

### Forbids the push of a specific stream and allows you to schedule a time to resume the stream
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-forbid-vs-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | The accelerated domain name |
| Channel | string | yes | The stream name. Format: AppName/StreamName. You can specify multiple stream names separated by commas (,) |
| LiveStreamType | string | yes | Specifies whether the stream is pushed by the streamer or pulled by the client. Valid values: publisher: The stream is pushed by the… |
| Oneshot | string | no | Specifies whether to only interrupt the stream without adding it to the blacklist. Valid values: yes no |
| ControlStreamAction | string | no | The stream control action. Set the value to forbid, which indicates that stream push is forbidden |
| ResumeTime | string | no | The time to resume the stream. Specify the time in UTC format, for example, 2015-12-01T17:37:00Z |

### Resumes the push of a specific stream
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-resume-vs-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | The accelerated domain name |
| Channel | string | yes | The stream name in the format of AppName/StreamName. Separate multiple stream names with commas (,) |
| LiveStreamType | string | yes | Specifies whether the stream is pushed by the broadcaster or pulled by the client. Valid value: publisher (broadcaster push) |
| ControlStreamAction | string | no | The stream control operation. Set the value to resume to resume the stream push |

### Configure multiple domain names in batch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-set-vs-domain-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainNames | string | yes | Your accelerated domain names. Supports multiple domain names separated by commas (,) |
| Functions | string | yes | List of features |

### Start stream pulling for multiple devices at once
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-start-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Device ID. Separate multiple IDs with commas |

### Starts multiple streams
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-start-streams` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Stream ID. Separate multiple IDs with commas |

### Stops stream pulling for multiple devices
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-stop-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Device ID. Separate multiple values with commas |
| StartTime | string | no | Stream restart trigger time |

### Stops multiple streams in a batch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-stop-streams` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The stream IDs. To specify multiple IDs, separate them with commas |
| StartTime | string | no | The time to stop the streams. You can specify a future time to stop the streams |

### Detaches multiple devices from a folder in bulk
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-unbind-directories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DirectoryId | string | yes | The folder ID |
| DeviceId | string | yes | The device ID. Separate multiple values with commas |

### Batch unbind multiple devices from parent platform push
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-unbind-parent-platform-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| ParentPlatformId | string | yes | The ID of the parent platform |
| DeviceId | string | yes | The device IDs. Separate multiple values with commas |

### Detach multiple purchased devices from a space in a single operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-unbind-purchased-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DeviceId | string | yes | Device ID. Separate multiple IDs with commas |

### Detach a template from multiple specified instances, such as space instances or stream instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-unbind-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| TemplateId | string | no | The template ID. If omitted, all bindings that match the conditions on the instance are detached |
| TemplateType | string | no | The template type. Valid values: record snapshot |
| InstanceId | string | yes | The instance ID. Separate multiple IDs with commas |
| InstanceType | string | yes | The instance type. Valid values: group stream |

### Unbind multiple templates simultaneously
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/batch-unbind-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| TemplateId | string | no | The template ID |
| TemplateType | string | no | The template type. Valid values: record snapshot |
| InstanceId | string | yes | The instance ID |
| InstanceType | string | yes | The instance type. Valid values: group stream |

### Attach a device to a folder
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/bind-directory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DirectoryId | string | yes | The folder ID |
| DeviceId | string | yes | The device ID |

### Binds a device to push streams to a parent platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/bind-parent-platform-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| ParentPlatformId | string | yes | The ID of the parent platform |
| DeviceId | string | yes | The ID of the device |

### Attach purchased devices to a space
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/bind-purchased-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Region | string | yes | The region to which the space belongs |
| GroupId | string | yes | The space ID |
| DeviceId | string | yes | The device ID |

### Binds a template to a specified instance, such as a group or stream
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/bind-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| TemplateId | string | yes | The ID of the template |
| TemplateType | string | no | The type of the template. Valid values: record snapshot |
| InstanceId | string | yes | The ID of the instance |
| InstanceType | string | yes | The type of the instance. Valid values: group stream |
| ApplyAll | string | no | Whether to apply the template to all streams in the scope. Default value: false |
| Replace | string | no | Whether to replace an existing binding. Default value: false |

### Cancels a Comfy task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/cancel-comfy-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| TaskId | string | yes | The ID of the Comfy task |

### Continuously adjust lens parameters such as aperture and zoom
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/continuous-adjust` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Device ID |
| Iris | string | no | Aperture speed parameter. A positive value increases the aperture. Value range: -1.0 to 1.0 |
| Focus | string | no | Zoom speed parameter. A positive value increases the focal length. Value range: -1.0 to 1.0 |

### Rotate the camera continuously by panning, tilting, or zooming
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/continuous-move` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Device ID |
| Pan | string | no | Pan speed. A positive value moves the camera left. Valid values: -1.0 to 1.0 |
| Tilt | string | no | Tilt speed. A positive value moves the camera up. Valid values: -1.0 to 1.0 |
| Zoom | string | no | Zoom speed. A positive value zooms in. Valid values: -1.0 to 1.0 |

### Starts a Comfy task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-comfy-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| WorkflowId | string | yes | The ID of the Comfy workflow to start |
| UserParameters | string | yes | The workflow parameters to be replaced |
| HiveId | string | yes | The identifier of the resource pool |

### Creates a directory for user data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-comfy-user-data-dir` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Path | string | no | The path of the directory to create. The format is /dir1/ for a single-level directory and /dir1/dir2/ for a multi-level directory |

### Uploads a Comfy workflow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-comfy-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Name | string | yes | The name of the workflow |
| Description | string | no | The description of the workflow |
| Workflow | string | yes | The workflow JSON |

### Add a new device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Name | string | no | Device name |
| Description | string | no | Device description |
| GroupId | string | yes | ID of the space that contains the device |
| ParentId | string | no | ID of the parent device. For example, the ID of the platform that hosts the camera |
| DirectoryId | string | no | ID of the folder that contains the device |
| Type | string | yes | Device type. Valid values: ipc (camera) platform (platform) ied (intelligent device) |
| AutoStart | string | no | Whether to automatically start the stream. Default value: false |
| GbId | string | no | GB-compliant device ID. This parameter applies only to GB-compliant protocols |
| Ip | string | no | Device IP address |
| Port | integer | no | Device port |
| Url | string | no | Stream URL on the device |
| Username | string | no | Device username |
| Password | string | no | Device password |
| Vendor | string | no | Device vendor |
| Dsn | string | no | Device serial number |
| Longitude | string | no | Device longitude |
| Latitude | string | no | The dimension of the device |
| AutoPos | string | no | Whether to enable location subscription for the device. Default value: false |
| PosInterval | integer | no | Location subscription interval, in seconds |
| AlarmMethod | string | no | GB-compliant alarm method to subscribe to. Valid values: 0 (all) 5 (video alarm) 7 (other alarms) An empty value means no subscription.… |
| Params | string | no | Additional device parameters, formatted as a JSON string |

### Reports a device alert
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-device-alarm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The device ID |
| ChannelId | integer | yes | The channel ID |
| ObjectType | integer | yes | The media object type. Valid values: 0: none 1: JPEG image 2: video 3: GIF image |
| Alarm | integer | yes | The Alarm Metric. Valid values: 0: other 1: motion detection alerting 2: intelligent alerting 3: switch alerting 4: video loss alerting |
| SubAlarm | integer | yes | The alert subtype |
| StartTime | integer | yes | The start time. Unit: milliseconds |
| EndTime | integer | yes | The end time. Unit: milliseconds |
| Expire | integer | no | The expiration time of the media upload URL. Unit: seconds. Default value: 60 |

### Creates a new folder
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-directory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Name | string | yes | Folder name |
| Description | string | no | Folder description |
| GroupId | string | yes | Space ID to which the folder belongs |
| ParentId | string | yes | Parent folder ID. When you create a device space, the system automatically creates a root directory for that space. Use the… |

### Create a new workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Name | string | yes | Workspace name |
| Description | string | no | Workspace description |
| App | string | no | Application name used by the workspace. Default value: live |
| Region | string | no | Region where the workspace is located, that is, the service center |
| InProtocol | string | yes | Ingest protocol used by the workspace. Valid values: gb28181 rtmp |
| OutProtocol | string | no | Playback protocols used by the workspace. Separate multiple values with commas. Valid values: flv hls rtmp |
| PushDomain | string | no | Ingest domain used by the workspace |
| PlayDomain | string | no | Streaming domain used by the workspace |
| LazyPull | string | no | Whether to enable on-demand stream pulling. Valid values: false (default) true |
| Callback | string | no | Callback URL triggered when device or stream status updates in the workspace |

### Creates a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-hive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Name | string | yes | The project ID |
| Description | string | no | A description of the cluster |

### Adds a new parent platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-parent-platform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Name | string | yes | The name of the parent platform |
| Description | string | no | The description of the parent platform |
| Protocol | string | no | The protocol of the parent platform. Valid values: gb28181: Chinese National Standard (GB28181) |
| GbId | string | yes | The national standard ID of the parent platform |
| Ip | string | yes | The SIP service IP address of the parent platform |
| Port | integer | yes | The SIP service port of the parent platform |
| ClientAuth | string | no | Specifies whether to enable local authentication. Valid values: true (default) false |
| ClientUsername | string | no | The local username |
| ClientPassword | string | no | The local password |
| AutoStart | string | no | Specifies whether to automatically enable the parent platform. Valid values: false (default) true |

### Creates a Cloud Application Service data package
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-rendering-data-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| RenderingInstanceId | string | yes | The instance ID of the Cloud Application Service. Note: This operation applies only to crs.cp.* series instance types |
| Description | string | no | The description |
| Category | string | no | The data type. Valid values: Package (default) Baseline |
| InstanceBillingCycle | string | no | The billing type. Valid values: Hour: hourly |

### Creates a cloud application service instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-rendering-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| RenderingSpec | string | yes | The specification of the cloud application service instance. If the specification belongs to the crs.cp.* series, the billing method can… |
| ClientInfo | string | no | The client information (JSON-encoded) |
| InternetMaxBandwidth | integer | no | The maximum bandwidth. Unit: Mbit/s. Default value: 10 |
| AutoRenew | string | no | This parameter is valid only when `InstanceChargeType` is set to `PrePaid` (subscription). Specifies whether to enable auto-renewal. Valid… |
| Period | string | no | This parameter is valid only when `InstanceChargeType` is set to `PrePaid` (subscription). The subscription duration. Valid values (Note:… |
| InstanceChargeType | string | no | The billing method of the instance. Valid values: PrePaid (default): subscription. PostPaid: pay-as-you-go |
| InternetChargeType | string | no | Only one Billable methods is supported. If Billable methods already exist, the new value is invalid by default, and the existing Billable… |
| StorageSize | string | no | The cloud storage capacity used by the cloud application service instance. Note: This refers to cloud storage, not local storage |
| InstanceBillingCycle | string | no | This parameter is valid only when `InstanceChargeType` is set to `PostPaid` (pay-as-you-go). The billing cycle. Valid values: Hour: hourly |
| Attributes | string | no | Keep the default value unless you have special requirements. If you have special requirements, contact technical support to confirm the… |

### Creates a custom gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-rendering-instance-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| RenderingInstanceId | string | yes | The cloud application service instance ID |
| GatewayInstanceId | string | yes | The custom gateway instance ID |

### Creates a cloud application service project and configures session-related properties
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-rendering-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| ProjectName | string | yes | The custom project name, which serves as the unique identifier for the project. Naming conventions: The length must be 1 to 128… |
| SessionAttribs | string | no | The session attributes (JSON-encoded) |
| Description | string | no | The description of the project. The description must be 0 to 255 characters in length |

### Creates an on-demand snapshot for the specified stream
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-stream-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Stream ID |
| Location | string | no | Screenshot method. Valid values: center (cloud screenshot) (default) device (device screenshot) |

### Create a new template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/create-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Name | string | yes | Template Name |
| Description | string | no | Template description |
| Type | string | yes | Template type. Valid values: record (recording) snapshot (snapshot) transcode (transcoding) timeshift (time shifting) |
| Region | string | no | Region where the OSS bucket resides, that is, the service center. |
| OssBucket | string | no | OSS bucket |
| OssEndpoint | string | no | Domain name of OSS. |
| OssFilePrefix | string | no | OSS file prefix. |
| Trigger | string | no | Template trigger type. Default value: auto. Valid values: auto (automatic) ondemand (on-demand) |
| Interval | integer | no | Operation epoch, in seconds. |
| Retention | integer | no | Time-shift retention period, in days |
| FileFormat | string | no | Storage file format. Multiple values are separated by commas. Valid values: mp4 flv hls The Qingdao ingest endpoint does not support… |
| JpgOverwrite | string | no | Storage path for JPG files used in overwrite snapshots. Only JPG images are currently supported. Supports variable substitution with… |
| JpgSequence | string | no | Storage path for JPG files used in sequential snapshots. Only JPG images are currently supported. Supports variable substitution with… |
| JpgOnDemand | string | no | Storage path for on-demand JPG screenshots. Only JPG images are currently supported. Variables can be used in the path. Supported… |
| Mp4 | string | no | Storage path for MP4 files. The path supports variable substitution. Available variables include {AppName}, {StreamName}, {Sequence},… |
| Flv | string | no | Storage path for FLV files. For the format, see the description for Mp4. |
| HlsM3u8 | string | no | Storage path for HLS m3u8 files. For the format, see the description for Mp4. |
| HlsTs | string | no | Storage path for HLS .ts files. Variables can be used in the path. Supported variables include {AppName}, {StreamName}, {UnixTimestamp},… |
| Callback | string | no | Callback URL to be invoked after template execution. Note: Templates triggered on demand do not support callback parameters. |
| TransConfigsJSON | string | no | An array of TransConfig-type transcoding configurations, formatted as a JSON string |

### Unbinds one or more workload instances from a specified cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/del-hive-edge-workers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| HiveId | string | yes | The cluster ID |
| InstanceIds | string | yes | The list of workload IDs (JSON-encoded) |

### Deletes a cloud application. Cloud applications in use cannot be deleted
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-cloud-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| AppId | string | yes | The ID of the cloud application, which corresponds to a unique application package |

### Deletes an artifact
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-comfy-production` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| ProductionId | string | no | The ID of the artifact |

### Deletes a file or directory in user data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-comfy-user-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| FileName | string | no | The name of the file or directory to delete. If a path is passed, it is treated as a directory and must end with a forward slash (/). File… |

### Deletes a Comfy workflow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-comfy-workflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| WorkflowId | string | yes | The workflow ID |

### Deletes a device from a space
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Device ID |

### Deletes a folder
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-directory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The folder ID |

### Deletes a file object. You cannot delete a file that is being uploaded or pre-pushed. After a file is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| FileId | string | yes | The ID of the file, which uniquely identifies the file |

### Delete a workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Space ID |

### Deletes an empty cluster by the specified ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-hive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| HiveId | string | yes | The cluster ID |

### Deletes a parent platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-parent-platform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The ID of the parent platform |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The device ID |
| PresetId | string | yes | The preset ID |

### Deletes a specified public key. This action automatically revokes logon authorization for all associated…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-public-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| KeyName | string | yes | The name of the public key |

### Clears the configuration settings of a cloud application service instance. Only module properties configured…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-rendering-instance-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| RenderingInstanceId | string | yes | The cloud application service instance ID |
| Configuration | string | no | The configuration content. By default, all configured modules are cleared (JSON-encoded) |

### Deletes a custom gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-rendering-instance-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| RenderingInstanceId | string | no | The instance ID of the cloud application service |

### Deletes the settings of a cloud application service instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-rendering-instance-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| RenderingInstanceId | string | no | The cloud application service instance ID |
| AttributeNames | string | no | The list of attribute names (JSON-encoded) |

### Deletes a cloud application service project. Projects that contain business scheduling data such as online…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-rendering-project` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| ProjectId | string | yes | The project ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The ID of the template |

### Delete stream pulling information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-vs-pull-stream-info-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | Your stream pulling domain |
| AppName | string | yes | The application name for the live stream |
| StreamName | string | yes | The name of the live stream |

### Deletes the callback configuration for stream ingest
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/delete-vs-streams-notify-url-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | The accelerated domain name |

### Query all resource information for an account in a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-account-stat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | no | Alibaba Cloud account ID |

### Retrieves the download URL for user-generated results
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-comfy-production-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| ProductionId | string | yes | The production ID |

### Lists the generation results of a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-comfy-productions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| TaskId | string | yes | The ID of the specified ComfyTask |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The page size |

### Queries the waiting queue information of Comfy tasks. The default maximum length of a single Hive waiting…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-comfy-task-waiting-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| HiveId | string | no | The ID of the specified Hive |

### Queries the list of Comfy tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-comfy-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| TaskId | string | no | The ID of the Comfy task, used as a filter |
| TaskState | string | no | The task state, used as a filter |
| WorkflowId | string | no | The ID of the Comfy workflow, used as a filter |
| HiveId | string | no | The Hive ID, used as a filter to query tasks executed under the specified Hive |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of records to display on each page |

### Retrieves the download URL for user data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-comfy-user-data-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| FileName | string | yes | The name of the file to download |

### Retrieves the URL for uploading user files
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-comfy-user-data-upload-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| FileName | string | yes | The name of the file to be uploaded. The file name format can be a single file name (such as 1.jpg) or a path format (such as… |
| FileSizeBytes | integer | yes | The actual size of the file to be uploaded, in bytes. This value must be the exact size of the file in bytes. The file size is verified… |
| FileMd5 | string | yes | The MD5 value of the file to be uploaded. This value must be the exact MD5 value of the file. The file MD5 value is verified when the… |
| ContentType | string | yes | The content type of the file to be uploaded |

### Lists all files and directories in the user data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-comfy-user-datas` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| FileName | string | no | The name of the file to query, or the directory to query. To query a directory, pass the path ending with a forward slash (/) |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Queries the information of all Comfy workflows. Paging is supported
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-comfy-workflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Name | string | no | The name of the workflow |
| PageNumber | integer | no | The page number of the list to query |
| PageSize | integer | no | The number of entries per page |

### Queries the details of a device
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The device ID |
| IncludeStats | string | no | Specifies whether to return stream statistics information. Default value: false |
| IncludeDirectory | string | no | Specifies whether to return directory information. Default value: false |

### Queries a list of device channels
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-device-channels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Query by device ID |
| PageSize | integer | no | The number of entries per page. The default value is 20 |
| PageNum | integer | no | The page number. The default value is 1 |

### Queries a device gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-device-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Device ID |
| ClientIp | string | no | Client IP address |
| Expire | integer | no | Time-to-live (TTL) |

### Queries the URL information for a device stream
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-device-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Device ID |
| Stream | string | yes | Stream name |
| OutProtocol | string | yes | Stream protocol. Valid values: rtmp flv hls When Mode is set to push, only rtmp is supported |
| Mode | string | no | Stream mode. Valid values: play push |
| Type | string | no | The Type |
| Auth | string | no | The Auth |
| Expire | integer | no | Authentication validity period, in seconds |

### Queries the list of devices
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | no | The device ID. You can specify multiple IDs separated by commas (,) |
| Name | string | no | The device name. You can specify multiple names separated by commas (,) |
| Type | string | no | The device type. Valid values: ipc: Camera. platform: Platform. ied: Intelligent device |
| GroupId | string | no | The ID of the workspace to which the device belongs |
| ParentId | string | no | The ID of the parent device to which the device belongs |
| DirectoryId | string | no | The ID of the directory to which the device belongs |
| GbId | string | no | The national standard ID of the device |
| Dsn | string | no | The device serial number, which uniquely identifies the device |
| Status | string | no | The device status |
| Vendor | string | no | The device vendor |
| SortBy | string | no | The field used for sorting. Valid value: id: Sort by ID. This is the default value |
| SortDirection | string | no | The sort order. Valid values: asc: Ascending order. This is the default value. desc: Descending order |
| PageSize | integer | no | The number of entries per page. Default value: 20 |
| PageNum | integer | no | The page number. Default value: 1 |
| IncludeStats | string | no | Specifies whether to return stream statistics information. Default value: false |
| IncludeDirectory | string | no | Specifies whether to return directory information. Default value: false |

### Query the list of directories
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-directories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| GroupId | string | yes | ID of the group to which the directory belongs |
| ParentId | string | no | Query by parent directory ID |
| SortBy | string | no | Sort by the specified field. Default is by ID |
| SortDirection | string | no | Sort order. Default is ascending. Values: asc (ascending) desc (descending) |
| PageSize | integer | no | Page size. Default is 20 |
| PageNum | integer | no | Page number. Default is 1 |
| NoPagination | string | no | Disable paging. Default is false |

### Queries a directory
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-directory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The directory ID |

### Retrieves workspace information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The workspace ID |
| IncludeStats | string | no | Specifies whether to return the statistics information of the devices in the workspace. Default value: false |

### You can query the list of spaces
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | no | The space ID |
| Name | string | no | Space name |
| Region | string | no | The service region where the group is located |
| InProtocol | string | no | Ingest protocol used by the group. Valid values: gb28181 rtmp |
| Status | string | no | Group status. Valid values: on (enabled) off (disabled) |
| SortBy | string | no | Field to sort by. Valid values: Id (default) |
| SortDirection | string | no | Sort order. Valid values: asc (ascending, default) desc (descending) |
| PageSize | integer | no | Number of entries per page |
| PageNum | integer | no | Page number. Default: 1 |
| IncludeStats | string | no | Whether to return device statistics for the group. Default: false |

### Queries information about a parent platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-parent-platform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The ID of the parent platform |

### Queries the list of devices under a parent platform
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-parent-platform-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Query by parent platform ID |
| SortBy | string | no | Sort by the specified field. Sorted by id by default |
| SortDirection | string | no | Sort order. Ascending by default. Valid values: asc (ascending) desc (descending) |
| PageSize | integer | no | The page size. Default value: 20 |
| PageNum | integer | no | The page number. Default value: 1 |

### Query the list of parent platforms
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-parent-platforms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| GbId | string | no | Query by the GB ID of the parent platform |
| Status | string | no | Query by the status of the parent platform |
| SortBy | string | no | Sort by the specified field. Sorted by id by default |
| SortDirection | string | no | Sort order. Ascending by default. Valid values: asc (ascending) desc (descending) |
| PageSize | integer | no | Page size. Default value is 20 |
| PageNum | integer | no | Page number. Default value is 1 |

### Retrieve the list of presets
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-presets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Device ID |

### DescribePublishStreamStatus
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-publish-stream-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| InstanceId | string | yes | The InstanceId |

### Queries the details of purchased devices
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-purchased-device` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The device ID |

### Queries the list of purchased devices
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-purchased-devices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | no | The device ID |
| Name | string | no | The device name |
| Type | string | no | The device type. Valid values: ipc: Camera. platform: Platform. ied: Intelligent device |
| SubType | string | no | The device subtype. Valid values: bullet: Bullet camera. dome: Dome camera. ptz: PTZ camera |
| GroupId | string | no | The ID of the workspace to which the device belongs |
| Vendor | string | no | The device vendor |
| SortBy | string | no | The field by which to sort the results. Valid values: id (default) |
| SortDirection | string | no | The sort order. Default value: asc. Valid values: asc: Ascending order. desc: Descending order |
| PageSize | integer | no | The number of entries per page. Default value: 20 |
| PageNum | integer | no | The page number. Default value: 1 |

### Queries a list of recording records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Type | string | yes | The type of the storage record. Valid values: record: recording snapshot: snapshot |
| StreamId | string | yes | The ID of the stream |
| StartTime | string | yes | The start time. Specify the time in the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format. The time must be in UTC |
| EndTime | string | yes | The end time. Specify the time in the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format. The time must be in UTC |
| PrivateBucket | string | no | Specifies whether to use a private bucket |
| SortBy | string | no | The field by which to sort. Valid values: Id: default |
| SortDirection | string | no | The sort order. Valid values: asc: ascending order (default) desc: descending order |
| PageSize | integer | no | The number of entries per page. Default value: 20 |
| PageNum | integer | no | The page number. Default value: 1 |

### Queries the details of a cloud application service instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-rendering-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| RenderingInstanceId | string | yes | The instance ID of the cloud application service |

### Queries the real-time system configuration information of a cloud application service instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-rendering-instance-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| RenderingInstanceId | string | yes | The instance ID of the cloud application service |
| Configuration | string | no | The configuration content to be queried. By default, all modules are queried (JSON-encoded) |

### Queries the configurations of a cloud application service instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-rendering-instance-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| RenderingInstanceId | string | no | The cloud application service instance ID |
| AttributeNames | string | no | The list of instance configuration names (JSON-encoded) |

### Queries the details of a session, including the current session status, network access IP address and port,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-rendering-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| ProjectId | string | yes | The project ID |
| SessionId | string | no | The session ID. You must specify at least one of SessionId and ClientId |
| ClientId | string | no | The unique ID of the client. You must specify at least one of SessionId and ClientId |

### Queries information about a stream
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The stream ID |

### Retrieves the URL of a stream
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-stream-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The stream ID |
| Type | string | no | The type of the stream. The default value is \`live\`. Valid values: \`live\`: a live stream. \`vod\`: a video-on-demand (VOD) stream,… |
| OutProtocol | string | yes | The playback protocol for the stream. Valid values: rtmp flv hls |
| Auth | string | no | Specifies whether to generate a signed URL. Valid values: true false |
| AuthKey | string | no | The primary key associated with the playback domain name. This key is used to generate the authentication URL. Call the… |
| Expire | integer | no | The time-to-live (TTL) of the URL. Unit: seconds |
| StartTime | integer | no | The start time. This parameter applies to \`vod\` streams. A UNIX timestamp. Unit: seconds. |
| EndTime | integer | no | The end time. This parameter applies to \`vod\` streams. A UNIX timestamp. Unit: seconds. |
| Transcode | string | no | The name of the transcoding rule. This parameter is valid only after a transcoding template is attached |

### Retrieves a list of video-on-demand records for a stream, such as historical stream lists from an NVR
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-stream-vod-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | The stream ID |
| StartTime | integer | yes | The start time of the video-on-demand records. The value is a UNIX timestamp in seconds |
| EndTime | integer | yes | The end time of the video-on-demand records. The value is a UNIX timestamp in seconds |

### Queries a list of streams. You can filter streams by stream ID, name, space ID, and device ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-streams` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | no | The stream ID. You can specify multiple IDs separated by commas (,) |
| GroupId | string | no | The space ID |
| DeviceId | string | no | The device ID |
| ParentId | string | no | The parent device ID of the device to which the stream belongs |
| Name | string | no | The stream name. You can specify multiple names separated by commas (,) |
| Domain | string | no | The domain name |
| App | string | no | The application |
| SortBy | string | no | The field by which to sort the results. Valid values: Id (default) GroupId Name DeviceId Protocol You can specify only one field |
| SortDirection | string | no | The sort order. Valid values: asc: ascending order (default) desc: descending order |
| PageSize | integer | no | The number of entries per page. Default value: 20 |
| PageNum | integer | no | The page number. Default value: 1 |

### Query information about a template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | yes | Template ID |

### List templates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Id | string | no | Template ID |
| Type | string | no | Filter templates by template type |
| InstanceId | string | no | Filter templates by the bound instance ID |
| SortBy | string | no | Sort results by the specified field. Default: sort by ID |
| SortDirection | string | no | Sort order. Default: ascending. Valid values: asc (ascending) desc (descending) |
| PageSize | integer | no | Number of entries per page. Default: 20 |
| PageNum | integer | no | Page number. Default: 1 |

### Retrieves the URL information of a video-on-demand (VOD) stream
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vod-stream-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| Url | string | yes | The file URL of the video-on-demand video |
| TxId | string | no | The TxId |

### Retrieve certificate details
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-certificate-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| CertName | string | yes | The certificate name |

### Retrieves a list of domain name certificates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-certificate-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | no | Domain name |

### Retrieves the usage data of connected devices
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-devices-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| GroupId | string | no | The workspace ID |
| StartTime | string | no | The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in… |
| EndTime | string | no | The end time of the data to retrieve. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the… |

### Queries network bandwidth monitoring data for Domain Names
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-bps-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | no | Domain Names. If this parameter is empty, the system returns merged data for all accelerated Domain Names. Enter the accelerated Domain… |
| StartTime | string | no | The start time for data retrieval. The date format follows ISO8601 notation and uses UTC time. Format: YYYY-MM-DDThh:mm:ssZ. The minimum… |
| EndTime | string | no | The end time must be later than the start time. The date format follows ISO8601 notation and uses UTC time. Format: YYYY-MM-DDThh:mm:ssZ |
| Interval | string | no | The time granularity for query data. Supports 300, 3600, and 86400 seconds. If this parameter is not specified or the specified value is… |
| IspNameEn | string | no | The English name of the carrier (ISP). Obtain this from the DescribeCdnRegionAndIsp interface. If not specified, the system queries all… |
| LocationNameEn | string | no | The English name of the region. Obtain this from the DescribeCdnRegionAndIsp interface. If not specified, the system queries all regions |

### Retrieves the certificate information for a specified accelerated domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-certificate-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | The domain name |

### Queries domain name configurations. You can query the configurations of multiple features in a single request
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | Your accelerated domain name |
| FunctionNames | string | yes | List of feature names. Supports multiple values separated by commas (,) |

### Obtains the basic configuration information for a specified Visual Edge Computing Service domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | Domain name for the Visual Edge Computing Service |

### Queries the page view (PV) data for a domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-pv-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | The domain name for Visual Edge Computing Service |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the \`YYYY-MM-DDThh:mm:ssZ\` format. The time must… |
| EndTime | string | no | The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the… |

### Retrieve page view (PV) and unique visitor (UV) data for a Visual Edge Computing Service domain
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-pv-uv-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | Visual Edge Computing Service domain name |
| StartTime | string | no | Start time in UTC format. For example: 2016-06-29T19:00:00Z |
| EndTime | string | no | End time in UTC format. For example: 2016-06-30T19:00:00Z |

### Retrieve domain name record data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-record-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | no | Visual Edge Computing Service domain name |
| StartTime | string | no | Start time of the data range. Use ISO 8601 notation in UTC. Format: YYYY-MM-DDThh:mm:ssZ. Minimum data granularity is 5 minutes. If you… |
| EndTime | string | no | End time of the data range. Must be later than StartTime. Use ISO 8601 notation in UTC. Format: YYYY-MM-DDThh:mm:ssZ |
| Region | string | no | Region information |

### Queries the regional data for a domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-region-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | no | The domain name of Visual Edge Computing Service |
| StartTime | string | no | The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in… |
| EndTime | string | no | The end time of the data to retrieve. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the… |

### Query network request monitoring data for a domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-req-bps-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | no | Visual Edge Computing Service domain name |
| StartTime | string | no | Start time of the data query. Use ISO 8601 notation and UTC time. Format: YYYY-MM-DDThh:mm:ssZ Minimum data granularity is 5 minutes. If… |
| EndTime | string | no | End time must be later than start time. Use ISO 8601 notation and UTC time. Format: YYYY-MM-DDThh:mm:ssZ |
| Interval | string | no | Time granularity for the query, in seconds. Valid values: 300, 3600, and 86400. If you omit this parameter or specify an unsupported… |
| IspNameEn | string | no | ISP name in English. Get this value from the DescribeCdnRegionAndIsp operation. If you omit this parameter, the system queries data for… |
| LocationNameEn | string | no | Region name in English. Get this value from the DescribeCdnRegionAndIsp operation. If you omit this parameter, the system queries data for… |

### Obtain traffic data for domain name requests
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-req-traffic-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | no | Visual Edge Computing Service domain name |
| StartTime | string | no | Start time of the query. Specify in ISO 8601 format using UTC time. Format: YYYY-MM-DDThh:mm:ssZ Minimum time granularity is 5 minutes. If… |
| EndTime | string | no | End time of the query. Must be later than the start time. Specify in ISO 8601 format using UTC time. Format: YYYY-MM-DDThh:mm:ssZ |
| Interval | string | no | Time granularity of the query. Unit: seconds. Valid values: 300 (default). 3600. 86400. If you omit this parameter or specify an… |
| IspNameEn | string | no | ISP name in English. Call DescribeCdnRegionAndIsp to get valid values. If you omit this parameter, the system returns data for all ISPs |
| LocationNameEn | string | no | Region name in English. Call DescribeCdnRegionAndIsp to get valid values. If you omit this parameter, the system returns data for all… |

### Retrieves snapshot data for a domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-snapshot-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | no | Visual Edge Computing Service domain name |
| StartTime | string | no | Start time of the data range. Use ISO 8601 notation and UTC time. Format: YYYY-MM-DDThh:mm:ssZ Minimum data granularity is 5 minutes. If… |
| EndTime | string | no | End time of the data range. Must be later than StartTime. Use ISO 8601 notation and UTC time. Format: YYYY-MM-DDThh:mm:ssZ |

### Retrieve traffic data for a domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-traffic-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | no | The domain name of the Visual Edge Computing Service |
| StartTime | string | no | The start time for data retrieval. Use ISO8601 notation for the date format and UTC time. Format: YYYY-MM-DDThh:mm:ssZ The minimum data… |
| EndTime | string | no | The end time must be later than the start time. Use ISO8601 notation for the date format and UTC time. Format: YYYY-MM-DDThh:mm:ssZ |
| Interval | string | no | The time granularity for querying data. Supported values are 300, 3600, and 86400 seconds. If this parameter is not provided or an… |
| IspNameEn | string | no | The English name of the ISP. Obtain this value through the DescribeCdnRegionAndIsp interface. If this parameter is not provided, the… |
| LocationNameEn | string | no | The English name of the region. Obtain this value through the DescribeCdnRegionAndIsp interface. If this parameter is not provided, the… |

### Retrieve UV data by domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-domain-uv-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | The domain name of Visual Edge Computing Service |
| StartTime | string | no | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be… |
| EndTime | string | no | The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the… |

### Queries the pull stream configuration for a domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-pull-stream-info-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | The pull stream domain name |

### Queries the stream ingest callback configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/describe-vs-streams-notify-url-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://vs.cn-beijing.aliyuncs.com |
| DomainName | string | yes | Your accelerated domain name |

…and 94 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-vs/add-hive-edge-workers" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Video Surveillance System API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-vs/add-hive-edge-workers with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Video Surveillance System 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-vs.

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