API overview

更新时间:
复制 MD 格式

This topic describes the API operations that are provided by the City Visual Intelligence Engine.

Video streams

APIDescription
AttachStreamCall AttachStream to attach a stream to a specified compute job group.
DetachStreamCall DetachStream to detach a video stream from a specified compute job group.
DescribeStreamsCall DescribeStreams to query the video streams that are attached to a specified compute job group.
ListStreamsForCamerasCall ListStreamsForCameras to query video stream information based on camera points.

Regions

APIDescription
DescribeRegionsCall DescribeRegions to query the available Alibaba Cloud regions.

Image search

APIDescription
SearchImagesCall SearchImages to search for images.

Algorithm library capability sets

APIDescription
CreateCapabilityCall CreateCapability to create an algorithm library capability set.
DescribeCapabilitiesCall DescribeCapabilities to query information about created algorithm library capability sets.
DeleteCapabilityCall DeleteCapability to delete a specified algorithm library capability set.
ModifyCapabilityCall ModifyCapability to modify an algorithm library capability set.

Compute resource configurations

APIDescription
DescribeResourceProfilesCall DescribeResourceProfiles to query information about created compute resource configurations.
CreateResourceProfileCall CreateResourceProfile to create a compute resource configuration.
DeleteResourceProfileCall DeleteResourceProfile to delete a specified compute resource configuration.
ModifyResourceProfileCall ModifyResourceProfile to modify a resource parameter set.

Algorithm libraries

APIDescription
ModifyAlgoLibCall ModifyAlgoLib to modify algorithm library information.
DescribeAlgoLibsCall DescribeAlgoLibs to query information about created algorithm libraries.
DeleteAlgoLibCall DeleteAlgoLib to delete a specified algorithm library.
CreateAlgoLibCall CreateAlgoLib to create an algorithm library.

Compute Workgroup

APIDescription
StopJobGroupCall StopJobGroup to stop a specified compute job group.
GetComputeJobLogCall GetComputeJobLog to query compute job logs.
ListComputeJobLogsCall ListComputeJobLogs to query the names of compute logs.
CreateJobGroupCall CreateJobGroup to create a compute job group.
ModifyJobGroupCall ModifyJobGroup to modify the information of a compute job group.
DescribeJobGroupsCall DescribeJobGroups to query information about created compute job groups.
StartJobGroupCall StartJobGroup to start a specified compute job group.
DeleteJobGroupCall DeleteJobGroup to delete a specified compute job group.

Camera points

APIDescription
DescribeCamerasCall DescribeCameras to query information about created camera points.
CreateCameraCall CreateCamera to create a camera point.
BatchModifyCameraStatusCall BatchModifyCameraStatus to batch modify the status of camera points.
ModifyCameraCall ModifyCamera to modify camera point information.
DeleteCameraCall DeleteCamera to delete a specified camera point.

Stream ingestion workgroups

APIDescription
DeleteWorkGroupCall DeleteWorkGroup to delete a specified stream ingestion workgroup.
DescribeWorkGroupsCall DescribeWorkGroups to query created stream ingestion workgroups.
CreateWorkGroupCall CreateWorkGroup to create a stream ingestion workgroup.
ModifyWorkGroupCall ModifyWorkGroup to modify the information of a stream ingestion workgroup.
DescribeProtocolsCall DescribeProtocols to query the supported workgroup protocols.

Instances

APIDescription
ModifyInstanceCall ModifyInstance to modify an instance.
DescribeInstancesCall DescribeInstances to query the details of one or more instances.
DeleteInstanceCall DeleteInstance to release an expired subscription instance.
CreateInstanceCall CreateInstance to create an instance.