From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/vs/2018-12-12/api-docs.php | 33899 ++++++++++++++++---------------- 1 file changed, 17387 insertions(+), 16512 deletions(-) (limited to 'data/en_us/vs') diff --git a/data/en_us/vs/2018-12-12/api-docs.php b/data/en_us/vs/2018-12-12/api-docs.php index 2c07369..b04dbe8 100644 --- a/data/en_us/vs/2018-12-12/api-docs.php +++ b/data/en_us/vs/2018-12-12/api-docs.php @@ -1,685 +1,362 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'vs', - 'version' => '2018-12-12', - ], + 'info' => ['style' => 'RPC', 'product' => 'vs', 'version' => '2018-12-12'], 'directories' => [ [ - 'id' => 390443, - 'title' => null, + 'children' => ['CreateHive', 'ModifyHiveAttribute', 'ListEdgeWorkers', 'AddHiveEdgeWorkers', 'MoveHiveEdgeWorkers', 'ModifyComfyWorkflow', 'CreateComfyWorkflow', 'CreateComfyUserDataDir', 'CreateComfyTask', 'DeleteComfyWorkflow', 'DescribeComfyUserDatas', 'DeleteComfyUserData', 'DescribeComfyUserDataUploadUrl', 'DescribeComfyUserDataDownloadUrl', 'DescribeComfyTasks', 'DescribeComfyProductions', 'DescribeComfyProductionDownloadUrl', 'DeleteComfyProduction', 'CancelComfyTask', 'DescribeComfyWorkflows'], 'type' => 'directory', + 'title' => 'AIGC generation platform', + ], + [ 'children' => [ [ - 'id' => 390444, - 'title' => null, + 'children' => ['ModifyRenderingChargeType', 'CreateRenderingInstance', 'ListRenderingInstances', 'ModifyRenderingInstanceAttribute', 'DescribeRenderingInstance', 'GetRenderingInstanceStreamingInfo', 'RefreshRenderingInstanceStreaming', 'SendRenderingInstanceCommands', 'GetRenderingInstanceCommandsStatus', 'ModifyRenderingInstance', 'RebootRenderingInstance', 'RebootRenderingServer', 'ResetRenderingInstance', 'ModifyRenderingInstanceBandwidth', 'RenewRenderingInstance', 'ReleaseRenderingInstance'], 'type' => 'directory', - 'children' => [ - 'ModifyRenderingChargeType', - 'CreateRenderingInstance', - 'ListRenderingInstances', - 'ModifyRenderingInstanceAttribute', - 'DescribeRenderingInstance', - 'GetRenderingInstanceStreamingInfo', - 'RefreshRenderingInstanceStreaming', - 'SendRenderingInstanceCommands', - 'GetRenderingInstanceCommandsStatus', - 'ModifyRenderingInstance', - 'RebootRenderingInstance', - 'RebootRenderingServer', - 'ResetRenderingInstance', - 'ModifyRenderingInstanceBandwidth', - 'RenewRenderingInstance', - 'ReleaseRenderingInstance', - ], - ], - [ - 'id' => 390461, - 'title' => null, + 'title' => 'Instance management', + ], + [ + 'children' => ['CreateRenderingDataPackage', 'ListRenderingDataPackages', 'RecoverRenderingDataPackage', 'ReleaseRenderingDataPackage'], 'type' => 'directory', - 'children' => [ - 'CreateRenderingDataPackage', - 'ListRenderingDataPackages', - 'RecoverRenderingDataPackage', - 'ReleaseRenderingDataPackage', - ], + 'title' => 'Data package management', ], [ - 'id' => 390466, - 'title' => null, + 'children' => ['UploadPublicKey', 'ListPublicKeys', 'ManageLogin', 'DeletePublicKey'], 'type' => 'directory', - 'children' => [ - 'UploadPublicKey', - 'ListPublicKeys', - 'ManageLogin', - 'DeletePublicKey', - ], + 'title' => 'Secure logon', ], [ - 'id' => 390471, - 'title' => null, + 'children' => ['UploadCloudApp', 'ListCloudApps', 'UpdateCloudAppInfo', 'ListCloudAppPatches', 'InstallCloudApp', 'ListCloudAppInstallations', 'UninstallCloudApp', 'DeleteCloudApp'], 'type' => 'directory', - 'children' => [ - 'UploadCloudApp', - 'ListCloudApps', - 'UpdateCloudAppInfo', - 'ListCloudAppPatches', - 'InstallCloudApp', - 'ListCloudAppInstallations', - 'UninstallCloudApp', - 'DeleteCloudApp', - ], + 'title' => 'Cloud application management', ], [ - 'id' => 390480, - 'title' => null, + 'children' => ['DescribeRenderingInstanceConfiguration', 'UpdateRenderingInstanceConfiguration', 'DeleteRenderingInstanceConfiguration', 'DescribeRenderingInstanceSettings', 'UpdateRenderingInstanceSettings', 'DeleteRenderingInstanceSettings'], 'type' => 'directory', - 'children' => [ - 'DescribeRenderingInstanceConfiguration', - 'UpdateRenderingInstanceConfiguration', - 'DeleteRenderingInstanceConfiguration', - 'DescribeRenderingInstanceSettings', - 'UpdateRenderingInstanceSettings', - 'DeleteRenderingInstanceSettings', - ], + 'title' => 'System configuration', ], [ - 'id' => 390487, - 'title' => null, + 'children' => ['UploadFile', 'ListFiles', 'UpdateFileInfo', 'PushFile', 'ListFilePushStatuses', 'DeleteFile'], 'type' => 'directory', - 'children' => [ - 'UploadFile', - 'ListFiles', - 'UpdateFileInfo', - 'PushFile', - 'ListFilePushStatuses', - 'DeleteFile', - ], + 'title' => 'File management', ], [ - 'id' => 390494, - 'title' => null, + 'children' => ['CreateRenderingInstanceGateway', 'ListRenderingInstanceGateway', 'DeleteRenderingInstanceGateway'], 'type' => 'directory', - 'children' => [ - 'CreateRenderingInstanceGateway', - 'ListRenderingInstanceGateway', - 'DeleteRenderingInstanceGateway', - ], + 'title' => 'Custom gateway', ], [ - 'id' => 390498, - 'title' => null, + 'children' => ['CreateRenderingProject', 'ListRenderingProjects', 'UpdateRenderingProject', 'AssociateRenderingProjectInstances', 'ListRenderingProjectInstances', 'GetRenderingProjectInstanceStateMetrics', 'DisassociateRenderingProjectInstances', 'DeleteRenderingProject'], 'type' => 'directory', - 'children' => [ - 'CreateRenderingProject', - 'ListRenderingProjects', - 'UpdateRenderingProject', - 'AssociateRenderingProjectInstances', - 'ListRenderingProjectInstances', - 'GetRenderingProjectInstanceStateMetrics', - 'DisassociateRenderingProjectInstances', - 'DeleteRenderingProject', - ], + 'title' => 'Project management', ], [ - 'id' => 390507, - 'title' => null, + 'children' => ['StartRenderingSession', 'ListRenderingSessions', 'DescribeRenderingSession', 'StopRenderingSession'], 'type' => 'directory', - 'children' => [ - 'StartRenderingSession', - 'ListRenderingSessions', - 'DescribeRenderingSession', - 'StopRenderingSession', - ], + 'title' => 'Session management', ], ], + 'type' => 'directory', + 'title' => 'Cloud application service management', ], [ - 'id' => 390512, - 'title' => null, + 'children' => ['DescribeAccountStat', 'DescribeVsUserResourcePackage', 'OpenVsService'], 'type' => 'directory', - 'children' => [ - 'DescribeAccountStat', - 'DescribeVsUserResourcePackage', - 'OpenVsService', - ], + 'title' => 'Account', ], [ - 'id' => 390516, - 'title' => null, + 'children' => ['CreateGroup', 'DeleteGroup', 'ModifyGroup', 'DescribeGroup', 'DescribeGroups'], 'type' => 'directory', - 'children' => [ - 'CreateGroup', - 'DeleteGroup', - 'ModifyGroup', - 'DescribeGroup', - 'DescribeGroups', - ], + 'title' => 'Space management', ], [ - 'id' => 390522, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'CreateDevice', - 'DeleteDevice', - 'BatchDeleteDevices', - 'ModifyDevice', - 'DescribeDevice', - 'DescribeDevices', - 'SyncCatalogs', - 'UnlockDevice', - 'StartDevice', - 'StopDevice', - 'BatchStartDevices', - 'BatchStopDevices', - 'CreateDeviceAlarm', - 'ModifyDeviceAlarm', - 'ModifyDeviceCapture', - 'ModifyDeviceChannels', - 'DescribeDeviceChannels', - 'DescribeDeviceGateway', - 'DescribeDeviceURL', - 'DescribePurchasedDevice', - 'DescribePurchasedDevices', - 'BindPurchasedDevice', - 'UnbindPurchasedDevice', - 'BatchBindPurchasedDevices', - 'BatchUnbindDirectories', - 'BatchUnbindPurchasedDevices', + 'CreateDevice', 'DeleteDevice', 'BatchDeleteDevices', 'ModifyDevice', 'DescribeDevice', 'DescribeDevices', 'SyncCatalogs', 'UnlockDevice', 'StartDevice', 'StopDevice', 'BatchStartDevices', 'BatchStopDevices', 'CreateDeviceAlarm', 'ModifyDeviceAlarm', 'ModifyDeviceCapture', 'ModifyDeviceChannels', 'DescribeDeviceChannels', 'DescribeDeviceGateway', 'DescribeDeviceURL', 'DescribePurchasedDevice', + 'DescribePurchasedDevices', 'BindPurchasedDevice', 'UnbindPurchasedDevice', 'BatchBindPurchasedDevices', 'BatchUnbindDirectories', 'BatchUnbindPurchasedDevices', ], + 'type' => 'directory', + 'title' => 'Device management', ], [ - 'id' => 390549, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'StartStream', - 'StopStream', - 'BatchStartStreams', - 'BatchStopStreams', - 'DescribeStream', - 'DescribeStreams', - 'DescribeStreamURL', - 'DescribeVodStreamURL', - 'DescribeStreamVodList', - 'ForbidVsStream', - 'ResumeVsStream', - 'BatchForbidVsStream', - 'BatchResumeVsStream', - 'CreateStreamSnapshot', - 'SetVsStreamsNotifyUrlConfig', - 'DeleteVsStreamsNotifyUrlConfig', - 'DescribeVsStreamsNotifyUrlConfig', - 'AddVsPullStreamInfoConfig', - 'DeleteVsPullStreamInfoConfig', - 'UpdateVsPullStreamInfoConfig', - 'DescribeVsPullStreamInfoConfig', - 'StartTransferStream', - 'StopTransferStream', - 'DescribeVsStreamsOnlineList', - 'DescribeVsStreamsPublishList', + 'StartStream', 'StopStream', 'BatchStartStreams', 'BatchStopStreams', 'DescribeStream', 'DescribeStreams', 'DescribeStreamURL', 'DescribeVodStreamURL', 'DescribeStreamVodList', 'ForbidVsStream', 'ResumeVsStream', 'BatchForbidVsStream', 'BatchResumeVsStream', 'CreateStreamSnapshot', 'SetVsStreamsNotifyUrlConfig', 'DeleteVsStreamsNotifyUrlConfig', 'DescribeVsStreamsNotifyUrlConfig', 'AddVsPullStreamInfoConfig', 'DeleteVsPullStreamInfoConfig', 'UpdateVsPullStreamInfoConfig', + 'DescribeVsPullStreamInfoConfig', 'StartTransferStream', 'StopTransferStream', 'DescribeVsStreamsOnlineList', 'DescribeVsStreamsPublishList', ], + 'type' => 'directory', + 'title' => 'Stream management', ], [ - 'id' => 390575, - 'title' => null, + 'children' => ['CreateTemplate', 'DeleteTemplate', 'ModifyTemplate', 'DescribeTemplate', 'DescribeTemplates', 'BindTemplate', 'UnbindTemplate', 'BatchBindTemplate', 'BatchUnbindTemplate', 'BatchBindTemplates', 'BatchUnbindTemplates'], 'type' => 'directory', - 'children' => [ - 'CreateTemplate', - 'DeleteTemplate', - 'ModifyTemplate', - 'DescribeTemplate', - 'DescribeTemplates', - 'BindTemplate', - 'UnbindTemplate', - 'BatchBindTemplate', - 'BatchUnbindTemplate', - 'BatchBindTemplates', - 'BatchUnbindTemplates', - ], + 'title' => 'Template management', ], [ - 'id' => 390587, - 'title' => null, + 'children' => ['StartRecordStream', 'StopRecordStream', 'DescribeRecords'], 'type' => 'directory', - 'children' => [ - 'StartRecordStream', - 'StopRecordStream', - 'DescribeRecords', - ], + 'title' => 'Recording management', ], [ - 'id' => 390591, - 'title' => null, + 'children' => ['SetVsDomainCertificate', 'DescribeVsCertificateDetail', 'DescribeVsDomainCertificateInfo', 'DescribeVsCertificateList', 'DescribeVsDomainDetail', 'DescribeVsDomainConfigs', 'BatchSetVsDomainConfigs', 'BatchDeleteVsDomainConfigs', 'DescribeVsTopDomainsByFlow'], 'type' => 'directory', - 'children' => [ - 'SetVsDomainCertificate', - 'DescribeVsCertificateDetail', - 'DescribeVsDomainCertificateInfo', - 'DescribeVsCertificateList', - 'DescribeVsDomainDetail', - 'DescribeVsDomainConfigs', - 'BatchSetVsDomainConfigs', - 'BatchDeleteVsDomainConfigs', - 'DescribeVsTopDomainsByFlow', - ], + 'title' => 'Domain name management', ], [ - 'id' => 390601, - 'title' => null, + 'children' => ['SetPreset', 'GotoPreset', 'DeletePreset', 'DescribePresets', 'StopMove', 'StopAdjust', 'ContinuousMove', 'ContinuousAdjust'], 'type' => 'directory', - 'children' => [ - 'SetPreset', - 'GotoPreset', - 'DeletePreset', - 'DescribePresets', - 'StopMove', - 'StopAdjust', - 'ContinuousMove', - 'ContinuousAdjust', - ], + 'title' => 'PTZ management', ], [ - 'id' => 390610, - 'title' => null, + 'children' => ['CreateDirectory', 'DeleteDirectory', 'ModifyDirectory', 'DescribeDirectory', 'DescribeDirectories', 'BindDirectory', 'UnbindDirectory', 'BatchBindDirectories'], 'type' => 'directory', - 'children' => [ - 'CreateDirectory', - 'DeleteDirectory', - 'ModifyDirectory', - 'DescribeDirectory', - 'DescribeDirectories', - 'BindDirectory', - 'UnbindDirectory', - 'BatchBindDirectories', - ], + 'title' => 'Directory management', ], [ - 'id' => 390619, - 'title' => null, + 'children' => ['CreateParentPlatform', 'DeleteParentPlatform', 'ModifyParentPlatform', 'DescribeParentPlatform', 'DescribeParentPlatforms', 'DescribeParentPlatformDevices', 'StartParentPlatform', 'BindParentPlatformDevice', 'BatchBindParentPlatformDevices', 'UnbindParentPlatformDevice', 'BatchUnbindParentPlatformDevices'], 'type' => 'directory', - 'children' => [ - 'CreateParentPlatform', - 'DeleteParentPlatform', - 'ModifyParentPlatform', - 'DescribeParentPlatform', - 'DescribeParentPlatforms', - 'DescribeParentPlatformDevices', - 'StartParentPlatform', - 'BindParentPlatformDevice', - 'BatchBindParentPlatformDevices', - 'UnbindParentPlatformDevice', - 'BatchUnbindParentPlatformDevices', - ], + 'title' => 'Cascading platform management', ], [ - 'id' => 390631, - 'title' => null, + 'children' => ['DescribeVsDomainPvData', 'DescribeVsDomainUvData', 'DescribeVsDomainPvUvData', 'DescribeVsDomainRecordData', 'DescribeVsDomainSnapshotData', 'DescribeVsDomainRegionData', 'DescribeVsDomainBpsData', 'DescribeVsDomainReqBpsData', 'DescribeVsDomainTrafficData', 'DescribeVsDomainReqTrafficData', 'DescribeVsDevicesData', 'DescribeVsUpPeakPublishStreamData'], 'type' => 'directory', - 'children' => [ - 'DescribeVsDomainPvData', - 'DescribeVsDomainUvData', - 'DescribeVsDomainPvUvData', - 'DescribeVsDomainRecordData', - 'DescribeVsDomainSnapshotData', - 'DescribeVsDomainRegionData', - 'DescribeVsDomainBpsData', - 'DescribeVsDomainReqBpsData', - 'DescribeVsDomainTrafficData', - 'DescribeVsDomainReqTrafficData', - 'DescribeVsDevicesData', - 'DescribeVsUpPeakPublishStreamData', - ], + 'title' => 'Usage query', ], [ - 'id' => 390644, - 'title' => null, + 'children' => ['VerifyVsDomainOwner', 'DescribeVsVerifyContent', 'StartPublishStream', 'DescribePublishStreamStatus', 'StopPublishStream', 'BatchCaptureRenderingInstanceScreenshot', 'DelHiveEdgeWorkers', 'DeleteHive', 'ListHives', 'ListSpecifications'], 'type' => 'directory', - 'children' => [ - 'VerifyVsDomainOwner', - 'DescribeVsVerifyContent', - 'StartPublishStream', - 'DescribePublishStreamStatus', - 'StopPublishStream', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'ModifyRenderingChargeType' => [ - 'summary' => '变配云渲染资源实例付费类型', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'AddHiveEdgeWorkers' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREvsJ3UH6I', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'AutoRenew', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - ], - [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'default' => '1', - 'enum' => [ - '1', - '2', - '3', - '4', - '5', - '6', - '7', - '8', - '9', - '12', - ], - ], - ], - [ - 'name' => 'InstanceBillingCycle', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Hour', - 'default' => 'Hour', - 'enum' => [ - 'Hour', - ], - ], - ], - [ - 'name' => 'RenderingInstanceId', + 'name' => 'HiveId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive-xxxx-xxx-xxx'], ], [ - 'name' => 'InstanceChargeType', + 'name' => 'InstanceIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'An instance ID.', 'type' => 'string', 'required' => false, 'example' => '[\'ew-g24n2ql2sdozw6hl2\']', 'title' => ''], 'required' => true, - 'example' => 'PostPaid', - 'enum' => [ - 'PrePaid', - 'PostPaid', - ], + 'description' => 'A list of instance IDs.', + 'example' => '[\'acp-c4b9pbj4fzkagfexv\', \'acp-c4b9pbj4fzkagfexw\']', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'xxxx-xxx-xxx'], + 'SuccessInstanceCount' => ['description' => 'The number of instances that were successfully added.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'FailedInstanceCount' => ['description' => 'The number of instances that failed to be added.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'SuccessInstances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'ew-1226d588c69449209ee963161c067b04'], + 'Message' => ['description' => 'A message indicating the result of the operation.', 'type' => 'string', 'title' => '', 'example' => 'SUCCESS'], + ], + 'description' => 'Details of a successfully added instance.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of successfully added instances.', + 'title' => '', + 'example' => '', ], - 'RenderingInstanceId' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', + 'FailedInstances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'ew-1226d588c69449209ee963161c067b04'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Error 1062 (23000): Duplicate entry \'hive-4fbf3928d40e43948b98acdb4fb5aaed-ew-1226d588c69449209ee9631\' for key \'PRIMARY\''], + ], + 'description' => 'Details of an instance that failed to be added.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of instances that failed to be added.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AddHiveEdgeWorkers', + 'summary' => 'Adds one or more instances to a specified cluster.', + 'description' => '## Usage notes'."\n" + ."\n" + .'- **HiveId** is a required parameter that specifies the ID of the target cluster.'."\n" + ."\n" + .'- **InstanceIds** is a required parameter that specifies a list of instance IDs to add.'."\n" + ."\n" + .'- Adding an instance that already exists in the target cluster returns an error message.'."\n" + ."\n" + .'- The response includes lists of successful and failed instances. This allows you to verify which instances were added and review the reasons for any failures.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxx-xxx\\",\\n \\"SuccessInstanceCount\\": 5,\\n \\"FailedInstanceCount\\": 0,\\n \\"SuccessInstances\\": [\\n {\\n \\"InstanceId\\": \\"ew-1226d588c69449209ee963161c067b04\\",\\n \\"Message\\": \\"SUCCESS\\"\\n }\\n ],\\n \\"FailedInstances\\": [\\n {\\n \\"InstanceId\\": \\"ew-1226d588c69449209ee963161c067b04\\",\\n \\"Message\\": \\"Error 1062 (23000): Duplicate entry \'hive-4fbf3928d40e43948b98acdb4fb5aaed-ew-1226d588c69449209ee9631\' for key \'PRIMARY\'\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateRenderingInstance' => [ - 'summary' => '申请云渲染资源实例', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddVsPullStreamInfoConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREvsJ3UH6I', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RenderingSpec', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例规格', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'crs.cp.l1', - ], + 'schema' => ['description' => 'The accelerated domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], ], [ - 'name' => 'ClientInfo', + 'name' => 'AppName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '客户端信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ClientIp' => [ - 'title' => '客户端IP地址', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '172.21.128.110', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'xxxApp', 'title' => ''], ], [ - 'name' => 'InternetMaxBandwidth', + 'name' => 'StreamName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The stream name.', 'type' => 'string', 'required' => true, 'example' => 'xxxStream', 'title' => ''], ], [ - 'name' => 'AutoRenew', + 'name' => 'SourceUrl', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The source URL of the live stream.'."\n" + ."\n" + .'> Multiple source URLs are supported. Separate them with semicolons (;).', 'type' => 'string', 'required' => true, 'example' => 'up.******.com.cn', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'enum' => [ - '1', - '2', - '3', - '4', - '5', - '6', - '7', - '8', - '9', - '12', - ], - ], + 'schema' => ['description' => 'The start time for stream pulling.'."\n" + ."\n" + .'> The time must be in UTC format. The interval between StartTime and EndTime cannot exceed 7 days.', 'type' => 'string', 'required' => false, 'example' => '2017-08-28T07:30:30Z', 'title' => ''], ], [ - 'name' => 'InstanceChargeType', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'PrePaid', - 'enum' => [ - 'PrePaid', - ], - ], + 'schema' => ['description' => 'The end time for stream pulling.'."\n" + ."\n" + .'> The time must be in UTC format. The interval between StartTime and EndTime cannot exceed 7 days. EndTime must be later than the current time.', 'type' => 'string', 'required' => false, 'example' => '2017-08-28T09:30:30Z', 'title' => ''], ], [ - 'name' => 'InternetChargeType', + 'name' => 'Always', 'in' => 'query', 'schema' => [ - 'description' => '', 'type' => 'string', 'required' => false, - 'example' => '95BandwidthByMonth', - 'enum' => [ - '95BandwidthByMonth', - ], - ], - ], - [ - 'name' => 'StorageSize', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'InstanceBillingCycle', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'enum' => [ - 'Hour', - ], - ], - ], - [ - 'name' => 'Attributes', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Zone' => [ - 'type' => 'string', - ], - 'OutAccess' => [ - 'type' => 'string', - ], - 'InAccess' => [ - 'type' => 'string', - ], - 'EdgeMediaService' => [ - 'type' => 'string', - ], - ], + 'enum' => ['yes', 'no'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'RenderingInstanceId' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3CB843A9-DD34-4881-B8D6-B0D539D111E4', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Param.Missing.StartTime', 'errorMessage' => 'You must specify StartTime.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ['errorCode' => 'Duration.Exceed', 'errorMessage' => 'The duration between StartTime and EndTime is too long.', 'description' => 'The duration between StartTime and EndTime is too long.'], + ['errorCode' => 'ConfigAlreadyExists', 'errorMessage' => 'The specified configuration already exists.', 'description' => 'The specified configuration already exists.'], + ], + 403 => [ + ['errorCode' => 'Deny.TooMany.Stream', 'errorMessage' => 'The operation is denied because the maximum number of streams is exceeded.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\"\\n}","type":"json"}]', - ], - 'ListRenderingInstances' => [ - 'summary' => '查询所有云渲染实例信息，支持分页查询。', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3CB843A9-DD34-4881-B8D6-B0D539D111E4\\"\\n}","type":"json"}]', + 'title' => 'Add stream pulling configuration', + 'summary' => 'Adds a stream pulling configuration.', + 'extraInfo' => '## Special error codes'."\n" + .'| Error code | Description | HTTP status code | Semantics |'."\n" + .'|------------|-------------|------------------|-----------|'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain name was not found under the current account. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | The current operation is not supported, such as for a non-live streaming domain. |'."\n" + .'| Missing DomainName | DomainName is mandatory for this action. | 400 | A required parameter is missing. |'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | An unknown error occurred in the backend. |'."\n" + .'| InvalidStartTime.Malformed | Specified StartTime is malformed. | 400 | The StartTime format is invalid. |'."\n" + .'| InvalidEndTime.Malformed | Specified EndTime is malformed. | 400 | The EndTime format is invalid. |'."\n" + .'| InvalidEndTime.Mismatch | Specified end time does not match the specified start time or current time. | 400 | The Time Range between StartTime and EndTime must be within one week, and EndTime must not exceed the current time. |'."\n" + .'| ConfigAlreadyExists | Config already exists. | 400 | Configuration data already exists. |'."\n" + .'| PullStreamOverLimit | Pull stream is over limit for this domainName. | 400 | The stream pulling Traffic for this domain name has exceeded the Traffic limit. |', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:AddVsPullStreamInfoConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddVsPullStreamInfoConfig'], + ], ], + ], + 'AssociateRenderingProjectInstances' => [ + 'summary' => 'Associates cloud application service instances with a project.', + 'description' => '## Request description'."\n" + ."\n" + .'- This operation associates instances that meet specific conditions with a specified project.', + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -688,2431 +365,2249 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '199255', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'RenderingSpec', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'crs.cp.l1', - ], + 'schema' => ['description' => 'Project ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], ], [ - 'name' => 'RenderingInstanceId', + 'name' => 'RenderingInstanceIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', + 'description' => 'List of cloud application service instance IDs', + 'type' => 'array', + 'items' => ['description' => 'Cloud application service instance ID', 'type' => 'string', 'required' => false, 'example' => 'render-4523e7b93ca246febd10cd12347d70c0', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'allowEmptyValue' => true, + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'SuccessInstanceCount' => ['description' => 'Number of successful cloud application service instances', 'type' => 'string', 'title' => '', 'example' => '5'], + 'FailedInstanceCount' => ['description' => 'Number of failed cloud application service instances', 'type' => 'string', 'title' => '', 'example' => '0'], + 'SuccessInstances' => [ + 'description' => 'List of successfully associated instances', + 'type' => 'array', + 'items' => [ + 'description' => 'Cloud application service instance ID and association result description', + 'type' => 'object', + 'properties' => [ + 'RenderingInstanceId' => ['description' => 'Cloud application service instance ID', 'type' => 'string', 'title' => '', 'example' => 'render-5130e2feb23f442fb9456a3d977f03d4'], + 'Message' => ['description' => 'Description', 'type' => 'string', 'title' => '', 'example' => 'SUCCESS'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'FailedInstances' => [ + 'description' => 'List of instances that failed to associate', + 'type' => 'array', + 'items' => [ + 'description' => 'Cloud application service instance ID and failure reason', + 'type' => 'object', + 'properties' => [ + 'RenderingInstanceId' => ['description' => 'Cloud application service instance ID', 'type' => 'string', 'title' => '', 'example' => 'render-b45f28650ffe4591bf4c5c95996a428c'], + 'Message' => ['description' => 'Failure reason', 'type' => 'string', 'title' => '', 'example' => 'invalid id'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SuccessInstanceCount\\": \\"5\\",\\n \\"FailedInstanceCount\\": \\"0\\",\\n \\"SuccessInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-5130e2feb23f442fb9456a3d977f03d4\\",\\n \\"Message\\": \\"SUCCESS\\"\\n }\\n ],\\n \\"FailedInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-b45f28650ffe4591bf4c5c95996a428c\\",\\n \\"Message\\": \\"invalid id\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Associate instances with a project', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:AssociateRenderingProjectInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'BatchBindDirectories' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'DirectoryId', + 'in' => 'query', + 'schema' => ['description' => 'Directory ID.', 'type' => 'string', 'required' => true, 'example' => '399*****488-cn-qingdao', 'title' => ''], + ], [ - 'name' => 'PageSize', + 'name' => 'DeviceId', 'in' => 'query', - 'allowEmptyValue' => true, + 'schema' => ['description' => 'Device ID. Separate multiple values with commas.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Results' => [ + 'description' => 'Results list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Error' => ['description' => 'Error message for the binding.'."\n" + ."\n" + .'> Appears only if an error occurs.', 'type' => 'string', 'example' => 'An error occurred while processing your request.', 'title' => ''], + 'DirectoryId' => ['description' => 'Directory ID.', 'type' => 'string', 'example' => '399*****488-cn-qingdao', 'title' => ''], + 'DeviceId' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"An error occurred while processing your request.\\",\\n \\"DirectoryId\\": \\"399*****488-cn-qingdao\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch Attach Devices to Folder', + 'summary' => 'Binds multiple devices to directories in a single operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchBindDirectories'], + ], + ], + 'ramActions' => [ [ - 'name' => 'StorageSize', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchBindDirectories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'BatchBindParentPlatformDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartTime', + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ParentPlatformId', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'required' => true, 'example' => '361*****212-cn-qingdao', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The device IDs. Separate multiple values with commas.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'RenderingInstances' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Results' => [ + 'description' => 'The list of results.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'RenderingInstanceId' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - 'RenderingSpec' => [ - 'title' => '云渲染实例当前操作状态', - 'description' => '', - 'type' => 'string', - 'example' => 'crs.cp.l1', - ], - 'CreationTime' => [ - 'title' => '云渲染实例创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2023-11-17T02:18:04Z', - ], - 'StorageSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'Error' => ['description' => 'The error message.'."\n" + .'> This parameter is returned only when an error occurs.', 'type' => 'string', 'example' => 'some error', 'title' => ''], + 'ParentPlatformId' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'example' => '361*****212-cn-qingdao', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'TotalCount' => [ - 'title' => '云渲染实例总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"ParentPlatformId\\": \\"361*****212-cn-qingdao\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch bind devices to a parent platform', + 'summary' => 'Binds multiple devices to a parent platform for push in batches.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchBindParentPlatformDevices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchBindParentPlatformDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"RenderingSpec\\": \\"crs.cp.l1\\",\\n \\"CreationTime\\": \\"2023-11-17T02:18:04Z\\",\\n \\"StorageSize\\": 100\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]', ], - 'ModifyRenderingInstanceAttribute' => [ - 'summary' => '修改云应用服务实例密码', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'BatchBindPurchasedDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => true, 'example' => 'cn-qingdao', 'title' => ''], ], [ - 'name' => 'Password', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'Toehold2020', - ], + 'schema' => ['description' => 'The ID of the device group.', 'type' => 'string', 'required' => true, 'example' => '348*****174-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the device.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Results' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of results.', + 'type' => 'object', + 'properties' => [ + 'Error' => ['description' => 'The error message for the device. This parameter is returned only when an error occurs.', 'type' => 'string', 'example' => 'some error', 'title' => ''], + 'GroupId' => ['description' => 'Space ID.', 'type' => 'string', 'example' => '238*****380-cn-qingdao', 'title' => ''], + 'DeviceId' => ['description' => 'The ID of the device.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'Region' => ['description' => 'The region.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"GroupId\\": \\"238*****380-cn-qingdao\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\",\\n \\"Region\\": \\"cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch attach purchased devices', + 'summary' => 'Binds multiple purchased devices.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchBindPurchasedDevices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchBindPurchasedDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', ], - 'DescribeRenderingInstance' => [ - 'summary' => '查询云渲染实例详细信息。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BatchBindTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '199425', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'Template ID.', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Instance ID. Separate multiple values with commas.', 'type' => 'string', 'required' => true, 'example' => '323*****994-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => ['description' => 'Instance type. Valid values:'."\n" + ."\n" + .'- group (space)'."\n" + ."\n" + .'- stream (stream)', 'type' => 'string', 'required' => true, 'example' => 'group', 'title' => ''], + ], + [ + 'name' => 'ApplyAll', + 'in' => 'query', + 'schema' => ['description' => 'Apply to all streams within the scope. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'Replace', + 'in' => 'query', + 'schema' => ['description' => 'Replace existing bindings. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'RenderingInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - 'CreationTime' => [ - 'title' => '实例创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-05-07T02:27:06Z', - ], - 'SystemInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Resolution' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1920*1080', - ], - 'Frequency' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - ], - ], - 'RenderingStatus' => [ - 'title' => '实例操作状态', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'title' => '实例操作状态，取值范围，'."\n" - .'1. Preparing：初始化准备中'."\n" - .'2. Rebooting：重启中'."\n" - .'3. Resetting：重置中'."\n" - .'4. Working：工作中，属于终态'."\n" - .'5. Failure：操作失败，属于终态', - 'description' => '', - 'type' => 'string', - 'example' => 'Working', - ], - 'LatestAction' => [ - 'title' => '实例最近一次操作动作', - 'description' => '', - 'type' => 'string', - 'example' => 'MigrateLocalData', - ], - 'Description' => [ - 'title' => '状态描述', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'ConfigInfo' => [ - 'title' => '实例配置信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'NetworkConfig' => [ - 'title' => '出/入方向带宽限速。单位Mb/s。', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MaxIngressBandwidth' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'MaxEgressBandwidth' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'BandwidthStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-08-17T09:54:35Z', - ], - ], - ], - 'Configuration' => [ - 'title' => '已生效真机仿真配置', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ModuleName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'location', - ], - 'Attributes' => [ - 'title' => '属性列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '', - 'type' => 'any', - 'example' => '100', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'lon', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'Hostname' => [ - 'title' => '实例hostname,默认为出口Eip', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-xxx.ecr.aliyuncs.com', - ], - 'Isp' => [ - 'title' => '运营商编码，取值范围：'."\n" - .'1. cmcc'."\n" - .'2. unicom'."\n" - .'3. telecom', - 'type' => 'string', - ], - 'PortMappings' => [ - 'title' => '端口映射信息', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ExternalPort' => [ - 'title' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', - 'description' => '', - 'type' => 'string', - 'example' => '10013/10020', - ], - 'InternalPort' => [ - 'title' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', - 'description' => '', - 'type' => 'string', - 'example' => '49008/49015', - ], - ], - ], - ], - 'RenderingSpec' => [ - 'type' => 'string', - ], - 'StorageSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'EgressIp' => [ - 'title' => '出站IP', - 'type' => 'string', - ], - 'AdditionalIngresses' => [ - 'title' => '其他可选的入口网络信息', + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Bindings' => [ + 'description' => 'Result list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Hostname' => [ - 'title' => '云应用服务实例域名/IP', - 'type' => 'string', - ], - 'Isp' => [ - 'title' => '运营商编码，取值范围：'."\n" - .'1. cmcc'."\n" - .'2. unicom'."\n" - .'3. telecom', - 'type' => 'string', - ], - 'PortMappings' => [ - 'title' => '端口映射列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ExternalPort' => [ - 'title' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', - 'type' => 'string', - ], - 'InternalPort' => [ - 'title' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - 'InternalIp' => [ - 'type' => 'string', - ], - 'ResourceAttributes' => [ - 'title' => '云应用服务实例属性信息', - 'type' => 'object', - 'properties' => [ - 'Zone' => [ - 'title' => '资源域，取值范围：Private、Public', - 'type' => 'string', - 'example' => 'Public', - 'enum' => [ - 'Private', - 'Public', - ], - ], - 'OutAccess' => [ - 'title' => '出网配置，取值范围：'."\n" - .'1. ON：开启。资源具备访问公网能力。'."\n" - .'2. OFF：关闭。', - 'type' => 'string', - 'example' => 'ON', - 'enum' => [ - 'ON', - 'OFF', - ], - ], - 'InAccess' => [ - 'title' => '入网配置，取值范围：'."\n" - .'1. ON：开启。资源可被外部访问。'."\n" - .'2. OFF：关闭。', - 'type' => 'string', - 'example' => 'ON', - 'enum' => [ - 'ON', - 'OFF', - ], - ], - 'EdgeMediaService' => [ - 'title' => '流化服务，取值范围：'."\n" - .'1. ON：开启。'."\n" - .'2. OFF：关闭。', - 'type' => 'string', - 'example' => 'ON', - 'enum' => [ - 'ON', - 'OFF', - ], + 'Error' => ['description' => 'Error message.'."\n" + ."\n" + .'> This field exists only when the operation fails.', 'type' => 'string', 'example' => 'some error', 'title' => ''], + 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => '323*****994-cn-qingdao', 'title' => ''], + 'InstanceType' => ['description' => 'Instance type.', 'type' => 'string', 'example' => 'group', 'title' => ''], + 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '323*****998-cn-qingdao', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'InstanceChargeType' => [ - 'title' => '实例计费类型', - 'type' => 'string', - 'example' => 'PostPaid', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"CreationTime\\": \\"2024-05-07T02:27:06Z\\",\\n \\"SystemInfo\\": {\\n \\"Resolution\\": \\"1920*1080\\",\\n \\"Frequency\\": 60\\n },\\n \\"RenderingStatus\\": {\\n \\"Status\\": \\"Working\\",\\n \\"LatestAction\\": \\"MigrateLocalData\\",\\n \\"Description\\": \\"工作中\\"\\n },\\n \\"ConfigInfo\\": {\\n \\"NetworkConfig\\": {\\n \\"MaxIngressBandwidth\\": 100,\\n \\"MaxEgressBandwidth\\": 100,\\n \\"BandwidthStatus\\": \\"success\\",\\n \\"UpdateTime\\": \\"2023-08-17T09:54:35Z\\"\\n },\\n \\"Configuration\\": [\\n {\\n \\"ModuleName\\": \\"location\\",\\n \\"Attributes\\": [\\n {\\n \\"Value\\": \\"100\\",\\n \\"Name\\": \\"lon\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Hostname\\": \\"cn-xxx.ecr.aliyuncs.com\\",\\n \\"Isp\\": \\"telecom\\",\\n \\"PortMappings\\": [\\n {\\n \\"ExternalPort\\": \\"10013/10020\\",\\n \\"InternalPort\\": \\"49008/49015\\"\\n }\\n ],\\n \\"RenderingSpec\\": \\"crs.cp.l1\\",\\n \\"StorageSize\\": 20,\\n \\"EgressIp\\": \\"1.1.8.8\\",\\n \\"AdditionalIngresses\\": [\\n {\\n \\"Hostname\\": \\"101.66.165.213\\",\\n \\"Isp\\": \\"cmcc\\",\\n \\"PortMappings\\": [\\n {\\n \\"ExternalPort\\": \\"12500/12519\\",\\n \\"InternalPort\\": \\"11120/11139\\"\\n }\\n ]\\n }\\n ],\\n \\"InternalIp\\": \\"10.1.17.32\\",\\n \\"ResourceAttributes\\": {\\n \\"Zone\\": \\"Public\\",\\n \\"OutAccess\\": \\"ON\\",\\n \\"InAccess\\": \\"ON\\",\\n \\"EdgeMediaService\\": \\"ON\\"\\n },\\n \\"InstanceChargeType\\": \\"PostPaid\\"\\n}","type":"json"}]', - ], - 'GetRenderingInstanceStreamingInfo' => [ - 'summary' => '获取云渲染实例流连接信息，每次流化建联前都需要调用此接口获取最新连接信息', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Bindings\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"InstanceId\\": \\"323*****994-cn-qingdao\\",\\n \\"InstanceType\\": \\"group\\",\\n \\"TemplateId\\": \\"323*****998-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch attach template to multiple instances', + 'summary' => 'Bind templates to multiple specified instances, such as instances bound to spaces and streams.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchBindTemplate'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchBindTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'BatchBindTemplates' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '199704', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => ['description' => 'The template type. Valid values:'."\n" + ."\n" + .'- record (recording)'."\n" + ."\n" + .'- snapshot (snapshotting)', 'type' => 'string', 'required' => false, 'example' => 'timeshift', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => '323*****994-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => ['description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- group'."\n" + ."\n" + .'- stream', 'type' => 'string', 'required' => true, 'example' => 'stream', 'title' => ''], + ], + [ + 'name' => 'ApplyAll', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to apply the template to all streams in the scope. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'Replace', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to replace existing bindings. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'RenderingInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - 'Gateway' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.178.208.22', - ], - 'Hostname' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.18.20.2', - ], - 'Port' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10003', - ], - 'FlowId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '792fy125-594c-4dde-ab35-9ff8hrf0a86f', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '20D0DFCE-5DB7-5D83-BD82-8482F2327636', 'title' => ''], + 'Results' => [ + 'description' => 'A list of results.', + 'type' => 'array', + 'items' => [ + 'description' => 'Bindings', + 'type' => 'object', + 'properties' => [ + 'Error' => ['description' => 'The error message.'."\n" + ."\n" + .'> This parameter is returned only when the operation fails.', 'type' => 'string', 'example' => 'some error', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '323*****994-cn-qingdao ', 'title' => ''], + 'InstanceType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'group', 'title' => ''], + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '323*****998-cn-qingdao ', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"Gateway\\": \\"10.178.208.22\\",\\n \\"Hostname\\": \\"10.18.20.2\\",\\n \\"Port\\": \\"10003\\",\\n \\"FlowId\\": \\"792fy125-594c-4dde-ab35-9ff8hrf0a86f\\"\\n}","type":"json"}]', - ], - 'RefreshRenderingInstanceStreaming' => [ - 'summary' => '更新实例流连接信息', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20D0DFCE-5DB7-5D83-BD82-8482F2327636\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"InstanceId\\": \\"323*****994-cn-qingdao\\\\t\\",\\n \\"InstanceType\\": \\"group\\",\\n \\"TemplateId\\": \\"323*****998-cn-qingdao\\\\t\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch attach templates', + 'summary' => 'Binds multiple templates in a single operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchBindTemplates'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchBindTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'BatchCaptureRenderingInstanceScreenshot' => [ + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvs4YZ3LQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREvs4YZ3LQ'], ], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'RenderingInstanceIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The list of instance IDs. A maximum of 100 instance IDs can be specified.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID of the cloud application service instance.', 'type' => 'string', 'required' => false, 'example' => 'render-a371588064324c57b7b0133a96cbd17a', 'title' => ''], 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', + 'maxItems' => 100, + 'minItems' => 1, + 'example' => '', ], ], [ - 'name' => 'ClientInfo', + 'name' => 'Quality', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ClientIp' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '172.21.128.110', - ], - 'NewClient' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], - ], - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'The image quality. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'example' => '60', 'default' => '60', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'RenderingInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - 'Gateway' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.178.208.22', - ], - 'Hostname' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-xxx.ecr.aliyuncs.com', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'FailedItems' => [ + 'description' => 'The list of instances for which screenshots failed.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a failed instance.', + 'type' => 'object', + 'properties' => [ + 'RenderingInstanceId' => ['description' => 'The instance ID of the cloud application service instance.', 'type' => 'string', 'example' => 'render-072da95539d3402da90353b244191722', 'title' => ''], + 'ErrCode' => ['description' => 'The error code of the failure.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'ErrMessage' => ['description' => 'The error message of the failure.', 'type' => 'string', 'example' => 'Not Applied', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Port' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8080', + 'FailedCount' => ['description' => 'The number of failed instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'SuccessItems' => [ + 'description' => 'The list of successful instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a successful instance.', + 'type' => 'object', + 'properties' => [ + 'RenderingInstanceId' => ['description' => 'The instance ID of the cloud application service instance.', 'type' => 'string', 'example' => 'render-1ada8cd82783407b99fa202826fc6447', 'title' => ''], + 'DownloadUrl' => ['description' => 'The download URL of the screenshot.', 'type' => 'string', 'example' => 'https://testts-1.oss-cn-beijing.aliyuncs.com/app/test-zip-file.zip', 'title' => ''], + 'CreationTime' => ['description' => 'The time when the screenshot was created.', 'type' => 'string', 'example' => '2026-05-19T14:46:37+08:00', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'FlowId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '792fy125-594c-4dde-ab35-9ff8hrf0a86f', + 'SuccessCount' => ['description' => 'The number of successful instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Datatest' => [ + 'description' => 'The dry run result.', + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => 'The dry run result.', + 'type' => 'object', + 'properties' => [ + 'SuccessCount' => ['description' => 'The number of successful instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => 'The response was successful.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Batch capture screenshots of cloud application service instances', + 'summary' => 'Retrieves screenshots of cloud application service instances.', + 'description' => '## Request description'."\n" + ."\n" + .'- **Authentication**: Requests must include the `AliUid` parameter for identity verification.'."\n" + .'- **Instance specification**: Use `RenderingInstanceIds` to specify the instances to capture screenshots from.'."\n" + .'- **Screenshot quality**: Use the `Quality` parameter to set the image quality of screenshots. The default value is 75 (if not configured). Valid values: 1 to 100.'."\n" + .'- **Response handling**: The response contains lists of successful and failed instances with related information, including download URLs and screenshot completion times.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"Gateway\\": \\"10.178.208.22\\",\\n \\"Hostname\\": \\"cn-xxx.ecr.aliyuncs.com\\",\\n \\"Port\\": \\"8080\\",\\n \\"FlowId\\": \\"792fy125-594c-4dde-ab35-9ff8hrf0a86f\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"FailedItems\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-072da95539d3402da90353b244191722\\",\\n \\"ErrCode\\": \\"Success\\",\\n \\"ErrMessage\\": \\"Not Applied\\"\\n }\\n ],\\n \\"FailedCount\\": 0,\\n \\"SuccessItems\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-1ada8cd82783407b99fa202826fc6447\\",\\n \\"DownloadUrl\\": \\"https://testts-1.oss-cn-beijing.aliyuncs.com/app/test-zip-file.zip\\",\\n \\"CreationTime\\": \\"2026-05-19T14:46:37+08:00\\"\\n }\\n ],\\n \\"SuccessCount\\": 1,\\n \\"Datatest\\": {\\n \\"Result\\": {\\n \\"SuccessCount\\": 1\\n }\\n }\\n}","type":"json"}]', ], - 'SendRenderingInstanceCommands' => [ - 'summary' => '下发shell命令，支持同步/异步响应命令。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BatchDeleteDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '213860', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '云应用服务实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - ], - [ - 'name' => 'Commands', - 'in' => 'formData', - 'schema' => [ - 'title' => 'shell命令字符串。支持输入多条命令，以";"分隔', - 'description' => '', - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => 'date;ls -l /tmp', - ], - ], - [ - 'name' => 'Mode', - 'in' => 'query', - 'schema' => [ - 'title' => '命令响应模式，取值范围：'."\n" - .'1. Sync：同步响应。默认值。'."\n" - .'2. Async：异步响应', - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'Async', - 'Sync', - ], - ], - ], - [ - 'name' => 'Timeout', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '命令执行的超时时间，单位秒。取值范围与Mode响应模式取值有关：'."\n" - .'1. Mode=Sync，0-30，默认30'."\n" - .'2. Mode=Async，0-3600，默认300', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '3600', - 'minimum' => '0', - ], + 'schema' => ['description' => 'Device ID. Separate multiple values with commas.', 'type' => 'string', 'required' => true, 'example' => '32388****39092996', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Result' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Thu Jun 27 16:06:26 CST 2024', - 'title' => '命令的执行结果字符串', - ], - 'CmdId' => [ - 'title' => '命令请求的唯一ID。默认1天内有效，对于异步场景，对结果有关注的情况，建议在有效时间内尽快查询结果（最好在命令执行超期时间内）。', - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID of this task.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Results' => [ + 'description' => 'Result list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Error' => ['description' => 'Device error message. (Only present if an error occurs)', 'type' => 'string', 'example' => 'Device not found', 'title' => ''], + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '323884****9092996', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"Device not found\\",\\n \\"Id\\": \\"323884****9092996\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Delete devices in batch', + 'summary' => 'Deletes multiple devices in a single operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteDevices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchDeleteDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Result\\": \\"Thu Jun 27 16:06:26 CST 2024\\",\\n \\"CmdId\\": \\"cmd-81de027b66e442e99c1e0e09a16a0be5\\"\\n}","type":"json"}]', ], - 'GetRenderingInstanceCommandsStatus' => [ - 'summary' => '查询命令的执行状态与结果。', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'BatchDeleteVsDomainConfigs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '213860', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'DomainNames', 'in' => 'query', - 'schema' => [ - 'title' => '云应用服务实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'The accelerated domain names. Separate multiple domain names with commas.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ - 'name' => 'CmdId', + 'name' => 'FunctionNames', 'in' => 'query', - 'schema' => [ - 'title' => '命令下发请求的唯一ID', - 'description' => '', - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => 'cmd-81de027b66e442e99c1e0e09a16a0be5', - ], + 'schema' => ['description' => 'The feature names. Separate multiple features with commas.', 'type' => 'string', 'required' => true, 'example' => 'https_force', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Result' => [ - 'title' => '命令的执行结果字符串', - 'description' => '', - 'type' => 'string', - 'example' => 'Thu Jun 27 16:06:26 CST 2024', - ], - 'Status' => [ - 'title' => '命令执行状态，取值范围：'."\n" - .'1. Doing：执行中'."\n" - .'2. Success：已成功'."\n" - .'3. Failed：失败。超时时间内，失败会自动重试，客户可以选择继续等待或重新发起请求。', - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Message' => [ - 'title' => '描述信息。Status=Failed时，包含失败原因', - 'description' => '', - 'type' => 'string', - 'example' => 'conn failed!', - ], + 'RequestId' => ['description' => 'The request ID of this operation.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Delete domain configurations for a domain name', + 'summary' => 'Deletes domain name configurations in a batch.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteVsDomainConfigs'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchDeleteVsDomainConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Result\\": \\"Thu Jun 27 16:06:26 CST 2024\\",\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"conn failed!\\"\\n}","type":"json"}]', ], - 'ModifyRenderingInstance' => [ - 'summary' => '变配云渲染资源实例', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'BatchForbidVsStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREvsJ3UH6I', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingSpec', + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'Your accelerated domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], + ], + [ + 'name' => 'Channel', + 'in' => 'query', + 'schema' => ['description' => 'The stream name.'."\n" + ."\n" + .'> - Format: AppName/StreamName.'."\n" + .'>'."\n" + .'> - Specify multiple names, separated by commas (,).', 'type' => 'string', 'required' => true, 'example' => 'live/stream1,live/stream2', 'title' => ''], + ], + [ + 'name' => 'LiveStreamType', 'in' => 'query', 'schema' => [ - 'title' => '云渲染实例规格', - 'description' => '', + 'description' => 'Specifies whether the operation applies to stream ingest by a streamer or stream pulling by a client. Valid values:'."\n" + ."\n" + .'- publisher (streamer ingest)'."\n" + ."\n" + .'> Only publisher is supported.', 'type' => 'string', - 'required' => false, - 'example' => 'crs.cp.l1', + 'required' => true, + 'enum' => ['publisher'], + 'example' => 'publisher', + 'title' => '', ], ], [ - 'name' => 'StorageSize', + 'name' => 'Oneshot', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Specifies whether to stop ingest without adding the stream to the blacklist. Valid values:'."\n" + ."\n" + .'- yes'."\n" + ."\n" + .'- no', 'type' => 'string', 'required' => false, - 'example' => '20', + 'enum' => ['yes', 'no'], + 'example' => 'yes', + 'title' => '', ], ], [ - 'name' => 'RenderingInstanceId', + 'name' => 'ControlStreamAction', 'in' => 'query', 'schema' => [ - 'description' => '', 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', + 'required' => false, + 'default' => 'forbid', + 'enum' => ['forbid'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'ResumeTime', + 'in' => 'query', + 'schema' => ['description' => 'The time to resume ingest.'."\n" + ."\n" + .'> Use UTC format. Example: 2015-12-01T17:37:00Z', 'type' => 'string', 'required' => false, 'example' => '2015-12-01T17:37:00Z', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '6DFE7B89-8532-566F-B5CE-924B10FCE7AC', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6DFE7B89-8532-566F-B5CE-924B10FCE7AC\\"\\n}","type":"json"}]', - ], - 'RebootRenderingInstance' => [ - 'summary' => '重启云渲染实例', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '212048', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], - 'parameters' => [ - [ - 'name' => 'RenderingInstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例ID', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B058D71B-76EA-5DF6-ACAF-A617C1E7937F', 'title' => ''], + 'ForbidResult' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ForbidResultInfo' => [ + 'description' => 'The result of stopping ingest.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The operation result. Valid values:'."\n" + ."\n" + .'- success'."\n" + ."\n" + .'- fail', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Count' => ['description' => 'The number of streams that succeeded or failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Detail' => ['description' => 'The error reason. Valid values:'."\n" + ."\n" + .'- ok'."\n" + ."\n" + .'- exceed-limit (blacklist limit exceeded)'."\n" + ."\n" + .'- internal-error (internal error)', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'Channels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Channel' => [ + 'description' => 'The list of stream names.', + 'type' => 'array', + 'items' => ['description' => 'The stream name.'."\n" + ."\n" + .'> - Format: AppName/StreamName.'."\n" + .'>'."\n" + .'> - Specify multiple names, separated by commas (,).', 'type' => 'string', 'example' => 'live/stream1,live/stream2', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B058D71B-76EA-5DF6-ACAF-A617C1E7937F\\",\\n \\"ForbidResult\\": {\\n \\"ForbidResultInfo\\": [\\n {\\n \\"Result\\": \\"success\\",\\n \\"Count\\": 2,\\n \\"Detail\\": \\"ok\\",\\n \\"Channels\\": {\\n \\"Channel\\": [\\n \\"live/stream1,live/stream2\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Batch forbid VS streams', + 'summary' => 'Stop stream ingest for one or more streams. You can schedule when to resume ingest.', + 'extraInfo' => '## Special error codes'."\n" + .'| Error code | Description | HTTP status code | Semantics |'."\n" + .'|------------|-------------|------------------|-----------|'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | An unknown error occurred in the backend. |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain name was not found under the current account. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | The current operation is not supported, such as using a non-live domain. |'."\n" + .'| InvalidResumeTime.Malformed | Specified parameter ResumeTime is not valid. | 400 | The end time is invalid. |'."\n" + .'| QuotaExceeded.Blacklist | Exceed max blacklist count limit | 400 | The number of blacklist entries exceeds the upper limit (default: 10,000). |'."\n" + .'| ConfigAlreadyExists | Config has already exist. | 400 | The configuration already exists. |', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchForbidVsStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchForbidVsStream'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', ], - 'RebootRenderingServer' => [ - 'summary' => '云应用服务实例主机重启', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'BatchResumeVsStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingInstanceIds', + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'The accelerated domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], + ], + [ + 'name' => 'Channel', + 'in' => 'query', + 'schema' => ['description' => 'The name of the stream in the AppName/StreamName format. To specify multiple streams, separate the stream names with commas.', 'type' => 'string', 'required' => true, 'example' => 'live/stream1', 'title' => ''], + ], + [ + 'name' => 'LiveStreamType', 'in' => 'query', - 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[\\"render-6cdd65c6964c4ef2a635341f8c024191\\"]', - ], + 'description' => 'The type of live stream. Only publisher is supported, which indicates that the stream is ingested by a streamer.', + 'type' => 'string', 'required' => true, + 'enum' => ['publisher'], + 'example' => 'publisher', + 'title' => '', + ], + ], + [ + 'name' => 'ControlStreamAction', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => 'resume', + 'enum' => ['resume'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'SuccessInstanceCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'SuccessInstances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RenderingInstanceId' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'ResumeResult' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResumeResultInfo' => [ + 'description' => 'The result of the resume task.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result of the operation. Valid values: success and fail.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Count' => ['description' => 'The number of ingest endpoints that resumed successfully or failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Detail' => ['description' => 'The detailed result. ok indicates that the operation is successful. internal-error indicates that an internal error occurred.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'Channels' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Channel' => [ + 'description' => 'A list of streams.', + 'type' => 'array', + 'items' => ['description' => 'A stream in the AppName/StreamName format.', 'type' => 'string', 'example' => 'live/stream1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'render-e6cf423c787e4e43b460a788da254fe3', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'FailedInstanceCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'FailedInstances' => [ 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RenderingInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'render-421cd2a1125947c19fcd5c7dd2c7d31e', - ], - 'ErrMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Rejected due to timeout', - ], - 'ErrCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300000', - ], - ], - ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"ResumeResult\\": {\\n \\"ResumeResultInfo\\": [\\n {\\n \\"Result\\": \\"success\\",\\n \\"Count\\": 1,\\n \\"Detail\\": \\"ok\\",\\n \\"Channels\\": {\\n \\"Channel\\": [\\n \\"live/stream1\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Batch resume the push of a monitoring stream.', + 'summary' => 'Resumes stream ingest for one or more streams.', + 'extraInfo' => '## Special error codes'."\n" + .'| Error code | Description | HTTP status code | Semantics |'."\n" + .'|------------------------|--------------------------------------------------------------|------------------|----------------------------------------|'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | An unknown error occurred in the backend. |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain name was not found under the current account. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | The current operation is not supported, such as using a non-live domain. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchResumeVsStream'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchResumeVsStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SuccessInstanceCount\\": 5,\\n \\"SuccessInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-e6cf423c787e4e43b460a788da254fe3\\"\\n }\\n ],\\n \\"FailedInstanceCount\\": 0,\\n \\"FailedInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-421cd2a1125947c19fcd5c7dd2c7d31e\\",\\n \\"ErrMessage\\": \\"Rejected due to timeout\\",\\n \\"ErrCode\\": 300000\\n }\\n ]\\n}","type":"json"}]', ], - 'ResetRenderingInstance' => [ - 'summary' => '重置云渲染实例', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'BatchSetVsDomainConfigs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '234195', - 'abilityTreeNodes' => [ - 'FEATUREvsUGIQL3', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - ], - [ - 'name' => 'DataPackageId', + 'name' => 'DomainNames', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Your accelerated domain names.'."\n" + ."\n" + .'> Supports multiple domain names separated by commas (,).', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ - 'name' => 'ActionName', + 'name' => 'Functions', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'example' => 'Reset', - 'default' => 'Reset', - ], + 'schema' => ['description' => 'List of features.', 'type' => 'string', 'required' => true, 'example' => '[{“functionArgs”:[{“argName”:”domain_name”,”argValue”:”api.hellodtworld.com”}],”functionName”:”set_req_host_header”}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9BEC5E85-C76B-56EF-A922-860EFDB8B64B', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9BEC5E85-C76B-56EF-A922-860EFDB8B64B\\"\\n}","type":"json"}]', + 'title' => 'Batch configure domain names', + 'summary' => 'Configure multiple domain names in batch.', + 'requestParamsDescription' => '### Functions format'."\n" + ."\n" + .'- \\[{"functionArgs":\\[{"argName":"domain\\_name","argValue":"api.hellodtworld.com"}],"functionName":"set\\_req\\_host\\_header"}]'."\n" + ."\n" + .'- For certain features such as filetype\\_based\\_ttl\\_set, you can configure multiple rules. To update a specific rule, specify its configId. Example: \\[{"functionArgs":\\[{"argName":"file\\_type","argValue":"jpg"},{"argName":"ttl","argValue":"18"},{"argName":"weight","argValue":"30"}],"functionName":"filetype\\_based\\_ttl\\_set","configId":5068995}]'."\n" + ."\n" + .'### Feature descriptions'."\n" + ."\n" + .'Treat all parameter values as strings.'."\n" + ."\n" + .'| Name | Parameters |'."\n" + .'| ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| referer_white_list_set: Referer whitelist | refer_domain_allow_list: Whitelist entries separated by commas (,);
allow_empty: Allow empty referer. Valid values: on/off |'."\n" + .'| referer_black_list_set: Referer blacklist | refer_domain_deny_list: Blacklist entries separated by commas (,);
allow_empty: Allow empty referer. Valid values: on/off |'."\n" + .'| filetype_based_ttl_set: File expiration time setting | ttl: Cache time in seconds;
file_type: File types. Support multiple types separated by commas (,), such as txt,jpg;
weight: Weight. Valid range: 1–199 |'."\n" + .'| path_based_ttl_set: Folder expiration time setting | ttl: Cache time in seconds;
path: Folder path. Must start with "/";
weight: Weight. Valid range: 1–99 |'."\n" + .'| oss_auth: OSS authentication bucket | oss_bucket_id: Your bucket address |'."\n" + .'| ip_black_list_set: IP address blacklist | ip_list: IP addresses separated by commas (,) |'."\n" + .'| ip_allow_list_set: IP address whitelist | ip_list: IP addresses separated by commas (,) |'."\n" + .'| ip_white_list_set: IP bypass blocking | ip_list: IP addresses separated by commas (,) |'."\n" + .'| error_page: Error page redirection | error_code: Error code;
rewrite_page: Redirect page |'."\n" + .'| set_req_host_header: Modify back-to-origin custom header | domain_name: Back-to-origin Host header value |'."\n" + .'| set_hashkey_args: Ignore URL parameters | hashkey_args: List of parameters to retain. Separate multiple parameters with commas (,);
disable: When set to on, ignore all parameters. When off, do not ignore |'."\n" + .'| aliauth: Alibaba Cloud authentication | auth_type: Authentication type. Valid values: "no_auth", "type_a", "type_b", "type_c";
auth_key1: Authentication key1;
auth_key2: Authentication key2;
ali_auth_delta: Custom authentication buffer time |'."\n" + .'| set_resp_header: Set response header (visible in browser) | key: Response header. Valid values: Content-Type|Cache-Control|Content-Disposition|Content-Language|Expires|Access-Control-Allow-Origin|Access-Control-Allow-Methods|Access-Control-Allow-Headers|Access-Control-Max-Age|Access-Control-Expose-Headers;
value: Response header value. Set to null to delete |'."\n" + .'| https_force: Force HTTPS redirection | enable: Feature switch. Valid values: on/off |'."\n" + .'| http_force: Force HTTP redirection | enable: Feature switch. Valid values: on/off |'."\n" + .'| https_option: HTTPS basic parameters | http2: HTTP/2 switch. Valid values: on/off |'."\n" + .'| l2_oss_key: L2 OSS back-to-origin private key | private_oss_auth: Enable private OSS authentication. Valid values: on/off |'."\n" + .'| forward_scheme: Static protocol follows origin | enable: Switch. Valid values: on/off;
scheme_origin: Origin protocol. Supports http, https, and follow |'."\n" + .'| green_manager: Pornography detection | enable: Enable pornography detection. Valid values: on/off |'."\n" + .'| tmd_signature: Configure custom rate limiting rules | name: Rule name. Must be unique within the domain;
path: URI path. Can be duplicated but must be valid;
pathType: Match type. 0: prefix match, 1: exact match;
interval: Monitoring duration in seconds. Must be ≥10;
count: Access count per IP;
action: Block type. 0: block, 1: bot detection;
ttl: Block duration in seconds; |'."\n" + .'| dynamic: Dynamic site acceleration settings | enable: Switch (required). Valid values: on/off;
static_route_type: Static acceleration file suffix; static_route_url: Static acceleration URI;
static_route_path: Static acceleration PATH;
dynamic_route_origin: Back-to-origin route scheme. Supports http/https/follow; |'."\n" + .'| set_req_header: Custom back-to-origin HTTP header | key: Header name;
value: Header value |'."\n" + .'| l2_oss_key: Private bucket back-to-origin | private_oss_auth: Private bucket back-to-origin switch. Valid values: on/off |'."\n" + .'| range: Range-based back-to-origin | enable: Switch. Valid values: on/off/force |'."\n" + .'| video_seek: Video seeking | enable: Switch. Valid values: on/off |'."\n" + .'| ali_remove_args: Ignore URL parameters (remove) | ali_remove_args: (Required) Parameters to remove. Separate multiple parameters with spaces. Remaining parameters become the args part of the hashkey URL;
keep_oss_args: Valid values: on/off. On retains all parameters during origin fetch. Off uses only the parameters in the cache hashkey |'."\n" + .'| https_tls_version: TLS protocol version | tls10: Enable TLSv1.0. Default: on. Valid values: on/off;
tls11: Enable TLSv1.1. Default: on. Valid values: on/off;
tls12: Enable TLSv1.2. Default: on. Valid values: on/off;
tls13: Enable TLSv1.3. Default: off. Valid values: on/off; |'."\n" + .'| HSTS: HTTP Strict Transport Security | enabled: Switch (required). Default: off. Valid values: on/off;
https_hsts_max_age: (Required) Expiration time in seconds. We recommend 5184000s (60 days);
https_hsts_include_subdomains: Include includeSubDomains in HSTS header. Valid values: on/off. Use caution. Before enabling, ensure all subdomains of this accelerated domain support HTTPS. Otherwise, subdomains may become inaccessible after automatic HTTPS redirection |'."\n" + .'| filetype_force_ttl_code: File status code expiration time setting | file_type: (Required) File types. Support multiple types separated by commas (,), such as txt,jpg;
code_string: (Required) Status codes. Example: 302=0,301=0,4xx=2 |'."\n" + .'| path_force_ttl_code: Path status code expiration time setting | path: (Required) Must start with /. Example: /image;
code_string: (Required) Status codes. Example: 302=0,301=0,4xx=2 |'."\n" + .'| gzip: HTML Gzip optimization | enable: Feature switch (required). Valid values: on/off |'."\n" + .'| tesla: HTML optimization acceleration | enable: Feature switch (required). Valid values: on/off |', + 'extraInfo' => '### Special error codes'."\n" + .'| Error Code | Description | HTTP Status Code | Semantics |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| InvalidFunctions.Malformed | Specified Functions is malformed. | 400 | The specified Functions parameter is invalid. |'."\n" + .'| InvalidFunctionName.ValueNotSupported | FunctionName %s is not supported. | 400 | The FunctionName %s is not supported (%s indicates the specific feature name). |'."\n" + .'| InvalidArgName.ValueNotSupported | ArgName %s is not supported. | 400 | The ArgName %s is not supported (%s indicates the specific parameter name). |'."\n" + .'| InvalidArgValue.Malformed | Specified ArgValue is malformed. | 400 | The specified ArgValue parameter is invalid. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchSetVsDomainConfigs'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchSetVsDomainConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', ], - 'ModifyRenderingInstanceBandwidth' => [ - 'summary' => '修改云渲染实例限速带宽', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BatchStartDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '213857', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - ], - [ - 'name' => 'MaxIngressBandwidth', - 'in' => 'query', - 'schema' => [ - 'title' => 'MaxIngressBandwidth/MaxEgressBandwidth至少必选其一'."\n" - .'● 入方向最大限流，单位Mb/s；'."\n" - .'● 实例原始配置不限流；'."\n" - .'● 无输入或输入0时，默认保留最后一次配置'."\n" - .'● 输入小于0时，重置为不限流', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'MaxEgressBandwidth', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => 'MaxIngressBandwidth/MaxEgressBandwidth至少必选其一'."\n" - .'● 出方向最大限流，单位Mb/s'."\n" - .'● 实例原始配置不限流；'."\n" - .'● 无输入或输入0时，默认保留最后一次配置'."\n" - .'● 输入小于0时，重置为不限流', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'Device ID. Separate multiple IDs with commas.', 'type' => 'string', 'required' => true, 'example' => '32388487****92996-cn-qingdao', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'RenewRenderingInstance' => [ - 'summary' => '续费云渲染资源实例', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'RequestId' => ['description' => 'The request ID of this task.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Results' => [ + 'description' => 'List of results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '32388487****92996-cn-qingdao', 'title' => ''], + 'Streams' => [ + 'description' => 'List of device streams.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Error' => ['description' => 'Error message for the stream. This field appears only when an error occurs.', 'type' => 'string', 'example' => 'Stream not found', 'title' => ''], + 'Name' => ['description' => 'Stream name.', 'type' => 'string', 'example' => '310101*****187542126', 'title' => ''], + 'Id' => ['description' => 'Stream ID.', 'type' => 'string', 'example' => '3238848****092997-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Id\\": \\"32388487****92996-cn-qingdao\\",\\n \\"Streams\\": [\\n {\\n \\"Error\\": \\"Stream not found\\",\\n \\"Name\\": \\"310101*****187542126\\",\\n \\"Id\\": \\"3238848****092997-cn-qingdao\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Start Devices in Batch', + 'summary' => 'Start stream pulling for multiple devices at once.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchStartDevices'], + ], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'AutoRenew', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchStartDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'BatchStartStreams' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - 'enum' => [ - '1', - '2', - '3', - '4', - '5', - '6', - '7', - '8', - '9', - '12', - ], - ], + 'AK' => [], ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'Stream ID. Separate multiple IDs with commas.', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Results' => [ + 'description' => 'Results list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Error' => ['description' => 'Error message for the stream.'."\n" + ."\n" + .'> This field appears only if the stream fails.', 'type' => 'string', 'example' => 'stream not found', 'title' => ''], + 'Name' => ['description' => 'Stream name.', 'type' => 'string', 'example' => '31000000*****0000002', 'title' => ''], + 'Id' => ['description' => 'Stream ID.', 'type' => 'string', 'example' => '323*****997-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'ReleaseRenderingInstance' => [ - 'summary' => '释放云渲染实例', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"stream not found\\",\\n \\"Name\\": \\"31000000*****0000002\\",\\n \\"Id\\": \\"323*****997-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Start Streams in Batch', + 'summary' => 'Starts multiple streams.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchStartStreams'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchStartStreams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'BatchStopDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'Device ID. Separate multiple values with commas.', 'type' => 'string', 'required' => true, 'example' => '32388487****92996', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'Stream restart trigger time.', 'type' => 'string', 'required' => false, 'example' => '2021-10-14T23:00:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'RequestId' => ['description' => 'Request ID for this task.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Results' => [ + 'description' => 'Result list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '32388487****92996', 'title' => ''], + 'Streams' => [ + 'description' => 'Device stream list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Error' => ['description' => 'Stream error message. (Appears only when an error occurs)', 'type' => 'string', 'example' => 'Stream not found', 'title' => ''], + 'Name' => ['description' => 'Name', 'type' => 'string', 'example' => '32388*****39092997', 'title' => ''], + 'Id' => ['description' => 'Stream ID.', 'type' => 'string', 'example' => '323884****9092997', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'CreateRenderingDataPackage' => [ - 'summary' => '创建云渲染数据包', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Id\\": \\"32388487****92996\\",\\n \\"Streams\\": [\\n {\\n \\"Error\\": \\"Stream not found\\",\\n \\"Name\\": \\"32388*****39092997\\",\\n \\"Id\\": \\"323884****9092997\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch Stop Devices', + 'summary' => 'Stops stream pulling for multiple devices.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchStopDevices'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchStopDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'BatchStopStreams' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREvsJ3UH6I', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'testdescription', - 'maxLength' => 64, - ], - ], - [ - 'name' => 'Category', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'enum' => [ - 'Package', - 'Baseline', - ], - ], + 'schema' => ['description' => 'The stream IDs. To specify multiple IDs, separate them with commas.', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', 'title' => ''], ], [ - 'name' => 'InstanceBillingCycle', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'enum' => [ - 'Hour', - 'Day', - 'Month', - ], - ], + 'schema' => ['description' => 'The time to stop the streams. You can specify a future time to stop the streams.', 'type' => 'string', 'required' => false, 'example' => '2021-12-10T10:00:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'DataPackageId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dp-9f8c57355d224ad7beaf95e145f22111'."\n" - ."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Results' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Error' => ['description' => 'The error message for the stream.'."\n" + ."\n" + .'> This parameter is returned only if an error occurs on the stream.', 'type' => 'string', 'example' => 'stream not found', 'title' => ''], + 'Name' => ['description' => 'The stream name.', 'type' => 'string', 'example' => '3100000*****00000002', 'title' => ''], + 'Id' => ['description' => 'The stream ID.', 'type' => 'string', 'example' => '323*****997-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DataPackageId\\": \\"dp-9f8c57355d224ad7beaf95e145f22111\\\\n\\\\n\\"\\n}","type":"json"}]', - ], - 'ListRenderingDataPackages' => [ - 'summary' => '查询所有云应用数据包信息，支持分页查询。', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"stream not found\\",\\n \\"Name\\": \\"3100000*****00000002\\",\\n \\"Id\\": \\"323*****997-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Stop streams in batch', + 'summary' => 'Stops multiple streams in a batch.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchStopStreams'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchStopStreams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'BatchUnbindDirectories' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '199255', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Size', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The folder ID.', 'type' => 'string', 'required' => true, 'example' => '399*****488-cn-qingdao', 'title' => ''], ], [ - 'name' => 'DataPackageId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dp-449ea3d16c0841b8bf33ec5bbc86a152', - ], - ], - [ - 'name' => 'Status', + 'name' => 'DeviceId', 'in' => 'query', + 'schema' => ['description' => 'The device ID. Separate multiple values with commas.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '64DB7F34-11A8-45DC-A421-40ACF446282C', 'title' => ''], + 'Results' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Error' => ['description' => 'The error message for the detach operation.'."\n" + ."\n" + .'> This field appears only if an error occurs.', 'type' => 'string', 'example' => 'An error occurred while processing your request.', 'title' => ''], + 'DirectoryId' => ['description' => 'The folder ID.', 'type' => 'string', 'example' => '399*****488-cn-qingdao', 'title' => ''], + 'DeviceId' => ['description' => 'Folder ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'available', - ], - ], - [ - 'name' => 'Category', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64DB7F34-11A8-45DC-A421-40ACF446282C\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"An error occurred while processing your request.\\",\\n \\"DirectoryId\\": \\"399*****488-cn-qingdao\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Detach multiple devices from a folder in batch', + 'summary' => 'Detaches multiple devices from a folder in bulk.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUnbindDirectories'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchUnbindDirectories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'BatchUnbindParentPlatformDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'AK' => [], ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'ParentPlatformId', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'required' => true, 'example' => '361*****212-cn-qingdao', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The device IDs. Separate multiple values with commas.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'DataPackages' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Results' => [ + 'description' => 'The list of results.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'available', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'Category' => [ - 'type' => 'string', - ], - 'Size' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'RenderingInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'render-342012a227dc4ddf91f024639e43051a', - ], - 'CreationTime' => [ - 'title' => '云渲染实例创建时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-15T10:23:06+08:00', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-12-06T02:03:59Z', - ], - 'DataPackageId' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'dp-449ea3d16c0841b8bf33ec5bbc86a152'."\n", - ], + 'Error' => ['description' => 'The error message.'."\n" + .'> This parameter is returned only when an error occurs.', 'type' => 'string', 'example' => 'some error', 'title' => ''], + 'ParentPlatformId' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'example' => '361*****212-cn-qingdao', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'TotalCount' => [ - 'title' => '云渲染实例总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"ParentPlatformId\\": \\"361*****212-cn-qingdao\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch Unbind Parent Platform Devices', + 'summary' => 'Batch unbind multiple devices from parent platform push.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUnbindParentPlatformDevices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchUnbindParentPlatformDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DataPackages\\": [\\n {\\n \\"Status\\": \\"available\\",\\n \\"Description\\": \\"test\\",\\n \\"Category\\": \\"Package\\",\\n \\"Size\\": 10,\\n \\"RenderingInstanceId\\": \\"render-342012a227dc4ddf91f024639e43051a\\",\\n \\"CreationTime\\": \\"2024-10-15T10:23:06+08:00\\",\\n \\"UpdateTime\\": \\"2024-12-06T02:03:59Z\\",\\n \\"DataPackageId\\": \\"dp-449ea3d16c0841b8bf33ec5bbc86a152\\\\n\\"\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]', ], - 'RecoverRenderingDataPackage' => [ - 'summary' => '恢复数据到云渲染实例', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'BatchUnbindPurchasedDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '212048', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - ], - [ - 'name' => 'DataPackageId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dp-449ea3d16c0841b8bf33ec5bbc86a152'."\n", - ], - ], - [ - 'name' => 'LoadMode', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Device ID. Separate multiple IDs with commas.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Results' => [ + 'description' => 'Result list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Error' => ['description' => 'Error message.'."\n" + ."\n" + .'> This field appears only when an error occurs.', 'type' => 'string', 'example' => 'some error', 'title' => ''], + 'DeviceId' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch detach purchased devices', + 'summary' => 'Detach multiple purchased devices from a space in a single operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUnbindPurchasedDevices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchUnbindPurchasedDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', ], - 'ReleaseRenderingDataPackage' => [ - 'summary' => '释放云渲染数据包', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'BatchUnbindTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREvsJ3UH6I', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'DataPackageId', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'dp-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'The template ID. If omitted, all bindings that match the conditions on the instance are detached.', 'type' => 'string', 'required' => false, 'example' => '323*****998-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => ['description' => 'The template type. Valid values:'."\n" + ."\n" + .'- record'."\n" + ."\n" + .'- snapshot', 'type' => 'string', 'required' => false, 'example' => 'record', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. Separate multiple IDs with commas.', 'type' => 'string', 'required' => true, 'example' => '323*****994-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => ['description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- group'."\n" + ."\n" + .'- stream', 'type' => 'string', 'required' => true, 'example' => 'group', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '5BEF36E7-3838-5B92-BA32-87DBF1425ABC', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Bindings' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Error' => ['description' => 'The error message.'."\n" + ."\n" + .'> This field appears only when the operation fails.', 'type' => 'string', 'example' => 'some error', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '323*****994-cn-qingdao', 'title' => ''], + 'InstanceType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'group', 'title' => ''], + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '323*****998-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BEF36E7-3838-5B92-BA32-87DBF1425ABC\\"\\n}","type":"json"}]', - ], - 'UploadPublicKey' => [ - 'summary' => '上传公钥，用于安全登陆鉴权。', - 'methods' => [ - 'post', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Bindings\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"InstanceId\\": \\"323*****994-cn-qingdao\\",\\n \\"InstanceType\\": \\"group\\",\\n \\"TemplateId\\": \\"323*****998-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch detach template from specified instances', + 'summary' => 'Detach a template from multiple specified instances, such as space instances or stream instances.', + 'description' => '> Specify at least one of TemplateId or TemplateType.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUnbindTemplate'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchUnbindTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'BatchUnbindTemplates' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '207881', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'KeyName', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '公钥名称，不可重复。'."\n" - .'取值规范：'."\n" - .'1. 长度8-255'."\n" - .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" - .'3. 首字符必须为字母或数字'."\n" - .'4. 前缀不能为"group-"', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mykey-v1.0', - 'maxLength' => 255, - 'minLength' => 8, - ], + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => false, 'example' => '323*****998-cn-qingdao', 'title' => ''], ], [ - 'name' => 'KeyGroup', + 'name' => 'TemplateType', 'in' => 'query', - 'schema' => [ - 'title' => '公钥分组，用于公钥管理。'."\n" - .'不同分组的公钥可以单独下发到具体设备。'."\n" - .'取值规范：'."\n" - .'1. 长度0-255'."\n" - .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" - .'3. 首字符必须为字母或数字', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'g-test', - ], + 'schema' => ['description' => 'The template type. Valid values:'."\n" + ."\n" + .'- record'."\n" + ."\n" + .'- snapshot', 'type' => 'string', 'required' => false, 'example' => 'record', 'title' => ''], ], [ - 'name' => 'Content', - 'in' => 'query', - 'schema' => [ - 'title' => '经过编码的公钥内容，默认编码格式Base64。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'verify_dffeb6610035dcb77b413a59c3*****', - ], - ], - [ - 'name' => 'Description', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '公钥描述信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 255, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => '400941290881239938-cn-beijing', 'title' => ''], ], [ - 'name' => 'KeyType', + 'name' => 'InstanceType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'default' => 'adb', - 'enum' => [ - 'adb', - 'ssh', - ], - ], + 'schema' => ['description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- group'."\n" + ."\n" + .'- stream', 'type' => 'string', 'required' => true, 'example' => 'stream', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90B377DF-C874-5BBD-B957-42C4C06AFECE', 'title' => ''], + 'Results' => [ + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Error' => ['description' => 'The error message.'."\n" + ."\n" + .'> Appears only if the operation fails.', 'type' => 'string', 'example' => 'some error', 'title' => ''], + 'TemplateType' => ['description' => 'The template type.', 'type' => 'string', 'example' => 'snapshot', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '323*****994-cn-qingdao', 'title' => ''], + 'InstanceType' => ['description' => 'The instance type.', 'type' => 'string', 'example' => 'group', 'title' => ''], + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '323*****998-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90B377DF-C874-5BBD-B957-42C4C06AFECE\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"TemplateType\\": \\"snapshot\\",\\n \\"InstanceId\\": \\"323*****994-cn-qingdao\\",\\n \\"InstanceType\\": \\"group\\",\\n \\"TemplateId\\": \\"323*****998-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Batch detach templates', + 'summary' => 'Unbind multiple templates simultaneously.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUnbindTemplates'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchUnbindTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', ], - 'ListPublicKeys' => [ - 'summary' => '查询公钥信息', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BindDirectory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '207885', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'KeyName', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'title' => '公钥名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mykey', - ], + 'schema' => ['description' => 'The folder ID.', 'type' => 'string', 'required' => true, 'example' => '399*****488-cn-qingdao', 'title' => ''], ], [ - 'name' => 'KeyGroup', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'title' => '公钥分组，用于公钥管理。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'g-test', - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '查询列表的页码。起始值为1。'."\n" - .'默认值：1。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3CB843A9-DD34-4881-B8D6-B0D539D111E4', 'title' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页查询时设置的每页行数，最大值为100行。'."\n" - .'默认值：10。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3CB843A9-DD34-4881-B8D6-B0D539D111E4\\"\\n}","type":"json"}]', + 'title' => 'Attach Device to Folder', + 'summary' => 'Attach a device to a folder.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindDirectory'], ], + ], + 'ramActions' => [ [ - 'name' => 'KeyType', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'enum' => [ - 'ssh', - 'adb', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BindDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'BindParentPlatformDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartTime', + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ParentPlatformId', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'required' => true, 'example' => '361*****212-cn-qingdao', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the device.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'PublicKeys' => [ - 'title' => '公钥信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'KeyName' => [ - 'title' => '公钥名称', - 'description' => '', - 'type' => 'string', - 'example' => 'mykey', - ], - 'Description' => [ - 'title' => '公钥描述信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'KeyType' => [ - 'type' => 'string', - ], - 'KeyGroup' => [ - 'title' => '公钥分组', - 'description' => '', - 'type' => 'string', - 'example' => 'mygroup', - ], - 'Content' => [ - 'title' => '经过编码的公钥内容，默认编码格式：Base64', - 'description' => '', - 'type' => 'string', - 'example' => 'verify_30d89ccb0905c8c7882c1d14a991954b', - ], - 'UploadTime' => [ - 'title' => '公钥上传时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-06-11T14:26:48+08:00', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '记录总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageNumber' => [ - 'title' => '查询列表的页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页查询时设置的每页行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Bind a device to a parent platform', + 'summary' => 'Binds a device to push streams to a parent platform.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindParentPlatformDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BindParentPlatformDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"PublicKeys\\": [\\n {\\n \\"KeyName\\": \\"mykey\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"KeyType\\": \\"ssh\\",\\n \\"KeyGroup\\": \\"mygroup\\",\\n \\"Content\\": \\"verify_30d89ccb0905c8c7882c1d14a991954b\\",\\n \\"UploadTime\\": \\"2024-06-11T14:26:48+08:00\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', ], - 'ManageLogin' => [ - 'summary' => '安全登陆管理', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BindPurchasedDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '207906', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - ], - [ - 'name' => 'KeyName', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => '公钥名称，与 KeyGroup 至少存在一个，二者都存在时，KeyName 优先级更高且必须属于KeyGroup。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mykey', - ], + 'schema' => ['description' => 'The region to which the space belongs.', 'type' => 'string', 'required' => true, 'example' => 'cn-qingdao', 'title' => ''], ], [ - 'name' => 'KeyGroup', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'title' => '公钥分组，如果 KeyName 不存在，则下发 KeyGroup 内所有的公钥。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mygroup', - ], + 'schema' => ['description' => 'The space ID.', 'type' => 'string', 'required' => true, 'example' => '3484*****8732174-cn-qingdao', 'title' => ''], ], [ - 'name' => 'ActionName', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'title' => '管理动作，取值：'."\n" - .'open - 打开登陆，默认值'."\n" - .'close - 关闭登陆', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'open', - 'default' => 'open', - 'enum' => [ - 'open', - 'close', - ], - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'example' => '3939*****6580539-cn-qingdao', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'LoginInfo' => [ - 'title' => '连接信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'LoginHostname' => [ - 'title' => 'ssh 连接的host', - 'description' => '', - 'type' => 'string', - 'example' => '12.10.4.10', - ], - 'LoginPort' => [ - 'title' => 'ssh 连接端口', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10004', - ], - 'AdbLoginPort' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Attach a purchased device', + 'summary' => 'Attach purchased devices to a space.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindPurchasedDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BindPurchasedDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"LoginInfo\\": {\\n \\"LoginHostname\\": \\"12.10.4.10\\",\\n \\"LoginPort\\": 10004,\\n \\"AdbLoginPort\\": 10005\\n }\\n}","type":"json"}]', ], - 'DeletePublicKey' => [ - 'summary' => '删除公钥信息', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BindTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '207905', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'KeyName', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '公钥名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'appKey', - ], + 'schema' => ['description' => 'The ID of the template.', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the template. Valid values:'."\n" + ."\n" + .'- record'."\n" + ."\n" + .'- snapshot', 'type' => 'string', 'required' => false, 'example' => 'record', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => '323*****994-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the instance. Valid values:'."\n" + ."\n" + .'- group'."\n" + ."\n" + .'- stream', 'type' => 'string', 'required' => true, 'example' => 'group', 'title' => ''], + ], + [ + 'name' => 'ApplyAll', + 'in' => 'query', + 'schema' => ['description' => 'Whether to apply the template to all streams in the scope. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'Replace', + 'in' => 'query', + 'schema' => ['description' => 'Whether to replace an existing binding. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => '323*****994-cn-qingdao', 'title' => ''], + 'InstanceType' => ['description' => 'The type of the instance.', 'type' => 'string', 'example' => 'group', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the template.', 'type' => 'string', 'example' => '323*****998-cn-qingdao', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'UploadCloudApp' => [ - 'summary' => '应用上架', - 'methods' => [ - 'post', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"InstanceId\\": \\"323*****994-cn-qingdao\\",\\n \\"InstanceType\\": \\"group\\",\\n \\"TemplateId\\": \\"323*****998-cn-qingdao\\"\\n}","type":"json"}]', + 'title' => 'Attach template to specified instance', + 'summary' => 'Binds a template to a specified instance, such as a group or stream.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindTemplate'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BindTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CancelComfyTask' => [ + 'summary' => 'Cancels a Comfy task.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3121,1271 +2616,854 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '207909', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'AppName', + 'name' => 'TaskId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the Comfy task to cancel.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '6c8234f4-d1e1-4cea-b08b-7926fbdea144'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '是 应用名。安卓应用需使用其包名，如com.aaa.bbb。'."\n" - .'默认取值规范：'."\n" - .'1. 长度4-50'."\n" - .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" - .'3. 首、尾字符必须为字母或数字', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'com.aaa.bbb', - 'maxLength' => 50, - 'minLength' => 4, + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The error code. A value of 0 indicates success.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The returned message. A `success` value indicates a successful request.', 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'title' => '', + 'description' => 'Response schema.', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CancelComfyTask', + 'description' => '> Stop the parent platform before canceling the task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'ContinuousAdjust' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AppVersion', + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '是 应用版本。安卓应用需使用其VersionName，如1.1.1。'."\n" - .'默认取值规范：'."\n" - .'1. 长度1-50'."\n" - .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" - .'3. 首、尾字符必须为字母或数字', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1.1.1', - 'maxLength' => 50, - 'minLength' => 1, - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], [ - 'name' => 'DownloadUrl', + 'name' => 'Iris', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'https://xxx.xxx.xxx.apk', - ], + 'schema' => ['description' => 'Aperture speed parameter. A positive value increases the aperture.
Value range: -1.0 to 1.0
', 'type' => 'string', 'required' => false, 'example' => '0.5', 'title' => ''], ], [ - 'name' => 'Md5', + 'name' => 'Focus', 'in' => 'query', + 'schema' => ['description' => 'Zoom speed parameter. A positive value increases the focal length.
Value range: -1.0 to 1.0
', 'type' => 'string', 'required' => false, 'example' => '0.5', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0CFBB7BD10CDD7279642ADAB8FEF3DEE', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Continuously Adjust Lens', + 'summary' => 'Continuously adjust lens parameters such as aperture and zoom.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ContinuousAdjust'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PkgFormat', - 'in' => 'query', - 'schema' => [ - 'title' => '安装包格式，默认是下载文件地址后缀。取值范围：'."\n" - .'1. apk'."\n" - .'2. tar.gz'."\n" - .'3. tar'."\n" - .'4. zip'."\n" - .'5. rar', - 'type' => 'string', - 'enum' => [ - 'apk', - 'tar.gz', - 'tar', - 'zip', - 'rar', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:ContinuousAdjust', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'ContinuousMove' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'PkgType', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '安装包类型，取值范围：'."\n" - .'1. android'."\n" - .'2. win'."\n" - .'3. android_appmarket'."\n" - .'无输入时，默认将根据PkgFormat(或根据DownloadUrl文件后缀自动解析出PkgFormat)自动映射安装包类型，PkgFormat与安装包类型默认映射关系，'."\n" - .'1. android：apk，apk格式默认映射为android'."\n" - .'2. win：tar.gz, tar, zip, rar'."\n" - .'3.android_appmarket: apk', - 'type' => 'string', - 'enum' => [ - 'android', - 'win', - 'android_appmarket', - ], - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'Pan', 'in' => 'query', - 'schema' => [ - 'title' => '应用描述信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 255, - ], + 'schema' => ['description' => 'Pan speed. A positive value moves the camera left.
'."\n" + .'Valid values: -1.0 to 1.0
', 'type' => 'string', 'required' => false, 'example' => '0.5', 'title' => ''], ], [ - 'name' => 'PkgLabels', + 'name' => 'Tilt', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '云应用标签，可多选，取值范围：'."\n" - .'1. hot'."\n" - .'2. game'."\n" - .'3. app', - 'type' => 'array', - 'items' => [ - 'title' => '云应用标签', - 'type' => 'string', - 'enum' => [ - 'app', - 'game', - 'hot', - ], - ], - ], + 'schema' => ['description' => 'Tilt speed. A positive value moves the camera up.
'."\n" + .'Valid values: -1.0 to 1.0
', 'type' => 'string', 'required' => false, 'example' => '0.5', 'title' => ''], + ], + [ + 'name' => 'Zoom', + 'in' => 'query', + 'schema' => ['description' => 'Zoom speed. A positive value zooms in.
'."\n" + .'Valid values: -1.0 to 1.0
', 'type' => 'string', 'required' => false, 'example' => '0.5', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'AppId' => [ - 'title' => '云应用ID，对应唯一的应用包', - 'description' => '', - 'type' => 'string', - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', - ], + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"AppId\\": \\"cap-b06b26edfhytbn b94a75ae1a79efc90eb\\"\\n}","type":"json"}]', - ], - 'ListCloudApps' => [ - 'summary' => '查询云应用列表', - 'methods' => [ - 'get', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Continuously Rotate the Camera Lens', + 'summary' => 'Rotate the camera continuously by panning, tilting, or zooming.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ContinuousMove'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:ContinuousMove', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateComfyTask' => [ + 'summary' => 'Starts a Comfy task.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '207913', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'WorkflowId', 'in' => 'query', - 'schema' => [ - 'title' => '云应用ID，对应唯一的应用包', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', - ], + 'schema' => ['description' => 'The ID of the Comfy workflow to start.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5f'], ], [ - 'name' => 'AppName', + 'name' => 'UserParameters', 'in' => 'query', - 'schema' => [ - 'title' => '应用名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'com.aaa.bbb', - ], + 'schema' => ['description' => 'The parameters to replace in the workflow.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{"2":{"text":"masterpiece, best quality, beautiful cat, sunny day"},"3":{"text":"low quality, worst quality, blurry, watermark, text, signature"}}'], ], [ - 'name' => 'AppVersion', + 'name' => 'HiveId', 'in' => 'query', - 'schema' => [ - 'title' => '应用版本', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.0', - ], + 'schema' => ['description' => 'The ID of the resource pool.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive-26cd567b35c04a0a90f017388207b232'], ], - [ - 'name' => 'PkgType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '安装包类型，取值范围：'."\n" - .'1. android'."\n" - .'2. win'."\n" - .'3. android_appmarket'."\n", - 'type' => 'string', - 'enum' => [ - 'android', - 'win', - 'android_appmarket', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The response code. A value of 0 indicates a successful request. For a list of other values, see Error Codes.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The returned message. It provides more details about the request status.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the asynchronous task. You can use this ID to query the task status on the Task Query tab in the Intelligent Media Management console.', 'type' => 'string', 'example' => '6c8234f4-d1e1-4cea-b08b-7926fbdea144', 'title' => ''], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateComfyTask', + 'description' => '> You must first enable the on-demand screenshot feature in the associated screenshot template.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"TaskId\\": \\"6c8234f4-d1e1-4cea-b08b-7926fbdea144\\"\\n}","type":"json"}]', + ], + 'CreateComfyUserDataDir' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '查询列表的页码。起始值为1。'."\n" - .'默认值：1。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'Path', 'in' => 'query', - 'schema' => [ - 'title' => '分页查询时设置的每页行数，最大值为100行。'."\n" - .'默认值：10。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The path of the directory to create. Use /dir1/ for a single-level directory, or /dir1/dir2/ for a multi-level directory.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '/userdir1'], ], - [ - 'name' => 'StartTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The status code. A value of 0 indicates success.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The returned message. If the request fails, this parameter contains the failure reason.', 'type' => 'string', 'example' => 'conn failed!', 'title' => ''], + ], + 'title' => '', + 'description' => 'The data returned.', + 'example' => '', ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateComfyUserDataDir', + 'summary' => 'Creates a directory for user data.', + 'description' => '> You must specify either a template ID or a template type.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"conn failed!\\"\\n}","type":"json"}]', + ], + 'CreateComfyWorkflow' => [ + 'summary' => 'Creates a Comfy workflow.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], + 'parameters' => [ [ - 'name' => 'LatestVersionOnly', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '是否仅输出应用最新提交的版本，默认false', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The workflow name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '图生视频的工作流示例'], ], [ - 'name' => 'PkgLabel', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'title' => '云应用标签，'."\n" - .'1. 取值范围：'."\n" - .' a. hot'."\n" - .' b. game'."\n" - .' c. app'."\n" - .'2. 特殊情况：'."\n" - .' a. 查询无标签的应用列表：输入"NULL"', - 'type' => 'string', - ], + 'schema' => ['description' => 'The workflow description.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '这是一个图生视频的工作流'], ], [ - 'name' => 'Status', + 'name' => 'Workflow', 'in' => 'query', 'schema' => [ - 'title' => '应用上传状态，取值范围：'."\n" - .'1. Success：终态，成功'."\n" - .'2. Failed：终态，失败'."\n" - .'3. Created'."\n" - .'4. Doing', + 'description' => 'The JSON definition of the workflow.', + 'enumValueTitles' => [], 'type' => 'string', + 'required' => true, + 'title' => '', + 'example' => '{}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'CloudApps' => [ - 'title' => '云应用信息列表', - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The internal error code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. If `Status` is `Failed`, this parameter provides the reason for the failure.', 'type' => 'string', 'example' => 'conn failed!', 'title' => ''], + 'WorkflowId' => ['description' => 'The workflow ID.', 'type' => 'string', 'title' => '', 'example' => 'wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5c'], + 'Status' => ['description' => 'The workflow status.', 'type' => 'string', 'title' => '', 'example' => 'on'], + 'MissingNodes' => [ 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AppVersion' => [ - 'title' => '应用版本', - 'description' => '', - 'type' => 'string', - 'example' => '1.5.0', - ], - 'Status' => [ - 'title' => '应用上传状态，取值范围：'."\n" - .'1. Created'."\n" - .'2. Doing'."\n" - .'3. Success：终态'."\n" - .'4. Failed：终态'."\n" - .'5. Deleting'."\n" - .'6. DeleteFailed：终态', - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Description' => [ - 'title' => '应用描述信息', - 'description' => '', - 'type' => 'string', - 'example' => 'demo', - ], - 'AppId' => [ - 'title' => '应用ID', - 'description' => '', - 'type' => 'string', - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', - ], - 'PkgFormat' => [ - 'title' => '安装包格式', - 'type' => 'string', - ], - 'StatusDescription' => [ - 'title' => '状态描述信息', - 'description' => '', - 'type' => 'string', - 'example' => 'upload success', - ], - 'UpdateTime' => [ - 'title' => '状态最新更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-05-28T14:48:34+08:00', - ], - 'UploadTime' => [ - 'title' => '应用上传时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-05-28T14:28:14+08:00', - ], - 'PkgType' => [ - 'title' => '安装包类型，android/win', - 'type' => 'string', - ], - 'AppName' => [ - 'title' => '应用名', - 'description' => '', - 'type' => 'string', - 'example' => 'com.aaa.bbb', - ], - 'StablePatchId' => [ - 'title' => '稳定版Patch包ID', - 'type' => 'string', - 'example' => 'patch-7bdf679812484df08a956b73e0b3bdf6', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '记录总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageNumber' => [ - 'title' => '查询列表的页码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页查询时设置的每页行数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'items' => ['description' => 'The name of a missing node.', 'type' => 'string', 'title' => '', 'example' => '{}'], + 'title' => '', + 'description' => 'A list of missing nodes.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The data returned.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"CloudApps\\": [\\n {\\n \\"AppVersion\\": \\"1.5.0\\",\\n \\"Status\\": \\"Success\\",\\n \\"Description\\": \\"demo\\",\\n \\"AppId\\": \\"cap-b06b26edfhytbn b94a75ae1a79efc90eb\\",\\n \\"PkgFormat\\": \\"apk\\",\\n \\"StatusDescription\\": \\"upload success\\",\\n \\"UpdateTime\\": \\"2024-05-28T14:48:34+08:00\\",\\n \\"UploadTime\\": \\"2024-05-28T14:28:14+08:00\\",\\n \\"PkgType\\": \\"android\\",\\n \\"AppName\\": \\"com.aaa.bbb\\",\\n \\"StablePatchId\\": \\"patch-7bdf679812484df08a956b73e0b3bdf6\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateComfyWorkflow', + 'description' => '> You must enable the on-demand screenshot feature in the associated screenshot template before calling this operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"conn failed!\\",\\n \\"WorkflowId\\": \\"wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5c\\",\\n \\"Status\\": \\"on\\",\\n \\"MissingNodes\\": [\\n \\"{}\\"\\n ]\\n}","type":"json"}]', ], - 'UpdateCloudAppInfo' => [ - 'summary' => '更新云应用信息', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '207912', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '云应用ID，对应唯一的应用包', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', - ], + 'schema' => ['description' => 'Device name.', 'type' => 'string', 'required' => false, 'example' => 'xxx路口摄像头', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'title' => '应用描述信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 255, - ], + 'schema' => ['description' => 'Device description.', 'type' => 'string', 'required' => false, 'example' => 'xxx路口摄像头', 'title' => ''], ], [ - 'name' => 'StablePatchId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'title' => '稳定版PatchId。客户业务使用中(如会话启动)未指定PatchId情况，默认使用的PatchId。仅win场景支持。'."\n" - .'特殊取值说明：'."\n" - .'1. 输入值origin：表示取消patch版本，默认使用初始版本', - 'type' => 'string', - 'required' => false, - 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', - ], + 'schema' => ['description' => 'ID of the space that contains the device.', 'type' => 'string', 'required' => true, 'example' => '348*****174-cn-qingdao', 'title' => ''], ], [ - 'name' => 'Patch', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '待上传的Patch包信息，仅win场景支持', - 'type' => 'object', - 'properties' => [ - 'PatchName' => [ - 'title' => 'Patch包名称或描述，AppId下唯一标记之一。仅win场景支持。'."\n" - .'默认取值规范：'."\n" - .'1. 不能等于origin、all'."\n" - .'2. 长度1-50'."\n" - .'3. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" - .'4. 首、尾字符必须为字母或数字', - 'type' => 'string', - 'required' => false, - 'example' => 'p1', - 'maxLength' => 50, - 'minLength' => 1, - ], - 'DownloadURL' => [ - 'title' => 'Patch包下载地址。'."\n" - .'默认patch包格式与原始云应用包格式一致。RenderingInstanceId/DownloadURL 必选其一，'."\n" - .'DownloadURL优先级高。', - 'type' => 'string', - 'required' => false, - 'example' => 'https://test_host/app/test-tar-pkg.tar', - ], - 'Md5' => [ - 'title' => 'patch包md5，用于检查完整性。仅DownloadURL非空时有效，DownloadURL非空时必选。', - 'type' => 'string', - 'required' => false, - 'example' => '346f6404395adfg5bae1e45g4e943bf7', - ], - 'PkgFormat' => [ - 'title' => '安装包格式，默认是下载文件地址后缀。仅DownloadURL非空时有效，取值范围：'."\n" - .'1. tar.gz'."\n" - .'2. tar'."\n" - .'3. zip'."\n" - .'4. rar', - 'type' => 'string', - 'example' => 'tar', - 'enum' => [ - 'tar', - 'tar.gz', - 'zip', - 'rar', - ], - ], - 'RenderingInstanceId' => [ - 'title' => '制作patch包依赖的实例ID。仅安卓应用市场（PkgType=andrpid_appmarket）场景有效。RenderingInstanceId/DownloadURL 必选其一，'."\n" - .'DownloadURL优先级高。', - 'type' => 'string', - ], - 'AsStablePatch' => [ - 'title' => '上传成功后是否自动配置为稳定版Patch，默认false。', - 'type' => 'boolean', - 'default' => 'false', - ], - ], - ], + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => ['description' => 'ID of the parent device. For example, the ID of the platform that hosts the camera.', 'type' => 'string', 'required' => false, 'example' => '399*****774-cn-qingdao', 'title' => ''], ], [ - 'name' => 'PkgLabels', + 'name' => 'DirectoryId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '云应用标签，可多选，将重置云应用标签，'."\n" - .'1. 取值范围：'."\n" - .' a. hot'."\n" - .' b. game'."\n" - .' c. app'."\n" - .'2. 特殊情况：'."\n" - .' a. 删除所有标签：输入["NULL"]', - 'type' => 'array', - 'items' => [ - 'title' => '云应用标签', - 'type' => 'string', - ], - ], + 'schema' => ['description' => 'ID of the folder that contains the device.', 'type' => 'string', 'required' => false, 'example' => '399*****488-cn-qingdao', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'PatchId' => [ - 'title' => '补丁包ID', - 'type' => 'string', - 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', - ], - ], - ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'Device type. Valid values:'."\n" + ."\n" + .'- ipc (camera)'."\n" + ."\n" + .'- platform (platform)'."\n" + ."\n" + .'- ied (intelligent device)', 'type' => 'string', 'required' => true, 'example' => 'ipc', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"PatchId\\": \\"patch-03fa76e8e13a49b6a966b063d9d309b4\\"\\n}","type":"json"}]', - ], - 'ListCloudAppPatches' => [ - 'summary' => '查询一个云应用的Patch列表。', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'AutoStart', + 'in' => 'query', + 'schema' => ['description' => 'Whether to automatically start the stream. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '207913', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', + [ + 'name' => 'GbId', + 'in' => 'query', + 'schema' => ['description' => 'GB-compliant device ID.'."\n" + ."\n" + .'> This parameter applies only to GB-compliant protocols.', 'type' => 'string', 'required' => false, 'example' => '31000000****00000002', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'title' => '云应用ID，对应唯一的应用包', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', - ], + 'schema' => ['description' => 'Device IP address.', 'type' => 'string', 'required' => false, 'example' => '10.10.10.10', 'title' => ''], ], [ - 'name' => 'PatchName', + 'name' => 'Port', 'in' => 'query', - 'schema' => [ - 'title' => '补丁包名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'patch-1', - ], + 'schema' => ['description' => 'Device port.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8080', 'title' => ''], ], [ - 'name' => 'PatchId', + 'name' => 'Url', 'in' => 'query', - 'schema' => [ - 'title' => '补丁包ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', - ], + 'schema' => ['description' => 'Stream URL on the device.', 'type' => 'string', 'required' => false, 'example' => 'rtmp://xxx/xxx', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Username', 'in' => 'query', - 'schema' => [ - 'title' => '查询列表的页码。起始值为1。'."\n" - .'默认值：1。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'Device username.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'title' => '分页查询时设置的每页行数，最大值为100行。'."\n" - .'默认值：10。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '20', - 'default' => '10', - ], + 'schema' => ['description' => 'Device password.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Vendor', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2015-11-29T00:00:00Z', - ], + 'schema' => ['description' => 'Device vendor.', 'type' => 'string', 'required' => false, 'example' => '公司A', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Dsn', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2017-12-10T21:00:00Z', - ], + 'schema' => ['description' => 'Device serial number.', 'type' => 'string', 'required' => false, 'example' => '7D0*****4C0', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Patches' => [ - 'title' => '云应用Patch列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '云应用Patch信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'title' => '应用上传状态，取值范围：'."\n" - .'1. Created'."\n" - .'2. Doing'."\n" - .'3. Success：终态'."\n" - .'4. Failed：终态'."\n" - .'5. Deleting'."\n" - .'6. DeleteFailed：终态', - 'description' => '', - 'type' => 'string', - 'example' => 'Doing', - ], - 'PatchName' => [ - 'title' => '补丁包名称', - 'description' => '', - 'type' => 'string', - 'example' => 'patch-1', - ], - 'StatusDescription' => [ - 'title' => '状态描述信息', - 'description' => '', - 'type' => 'string', - 'example' => 'Uploading', - ], - 'UpdateTime' => [ - 'title' => '状态最新更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-09-23T02:12:28', - ], - 'PatchId' => [ - 'title' => '补丁包ID', - 'description' => '', - 'type' => 'string', - 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', - ], - 'UploadTime' => [ - 'title' => '上传时间', - 'description' => '', - 'type' => 'string', - 'example' => '2025-07-24T14:45:36+08:00', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '记录总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageNumber' => [ - 'title' => '查询列表的页码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页查询时设置的每页行数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], + [ + 'name' => 'Longitude', + 'in' => 'query', + 'schema' => ['description' => 'Device longitude.', 'type' => 'string', 'required' => false, 'example' => '45.00', 'title' => ''], + ], + [ + 'name' => 'Latitude', + 'in' => 'query', + 'schema' => ['description' => 'The dimension of the device.', 'type' => 'string', 'required' => false, 'example' => '119.20', 'title' => ''], + ], + [ + 'name' => 'AutoPos', + 'in' => 'query', + 'schema' => ['description' => 'Whether to enable location subscription for the device. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'PosInterval', + 'in' => 'query', + 'schema' => ['description' => 'Location subscription interval, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', 'title' => ''], + ], + [ + 'name' => 'AlarmMethod', + 'in' => 'query', + 'schema' => ['description' => 'GB-compliant alarm method to subscribe to. Valid values:'."\n" + ."\n" + .'- 0 (all)'."\n" + ."\n" + .'- 5 (video alarm)'."\n" + ."\n" + .'- 7 (other alarms)'."\n" + ."\n" + .'> * An empty value means no subscription.'."\n" + .'>'."\n" + .'> * You can specify multiple values, separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => ['description' => 'Additional device parameters, formatted as a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Patches\\": [\\n {\\n \\"Status\\": \\"Doing\\",\\n \\"PatchName\\": \\"patch-1\\",\\n \\"StatusDescription\\": \\"Uploading\\",\\n \\"UpdateTime\\": \\"2024-09-23T02:12:28\\",\\n \\"PatchId\\": \\"patch-03fa76e8e13a49b6a966b063d9d309b4\\",\\n \\"UploadTime\\": \\"2025-07-24T14:45:36+08:00\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', - ], - 'InstallCloudApp' => [ - 'summary' => '安装云应用', - 'methods' => [ - 'post', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Add Device', + 'summary' => 'Add a new device.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateDeviceAlarm' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '207914', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '云应用服务实例ID。'."\n" - .'RenderingInstanceId、RenderingInstanceIds、ProjectId至少必选其一。'."\n" - .'优先级RenderingInstanceId > RenderingInstanceIds > ProjectId', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], [ - 'name' => 'AppId', + 'name' => 'ChannelId', 'in' => 'query', - 'schema' => [ - 'title' => '云应用ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', - ], + 'schema' => ['description' => 'The channel ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12', 'title' => ''], ], [ - 'name' => 'RenderingInstanceIds', + 'name' => 'ObjectType', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '云应用服务实例ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '云应用服务实例ID', - 'type' => 'string', - ], - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The media object type. Valid values:'."\n" + .'- 0: none'."\n" + .'- 1: JPEG image'."\n" + .'- 2: video'."\n" + .'- 3: GIF image.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'Alarm', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'The Alarm Metric. Valid values:'."\n" + ."\n" + .'- 0: other'."\n" + .'- 1: motion detection alerting'."\n" + .'- 2: intelligent alerting'."\n" + .'- 3: switch alerting'."\n" + .'- 4: video loss alerting.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'SubAlarm', 'in' => 'query', - 'schema' => [ - 'title' => '项目下被选中的实例最大个数。仅ProjectId非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认100。取值1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '1', - 'default' => '100', - ], + 'schema' => ['description' => 'The alert subtype.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '项目下实例关联关系分页页码（分页查询默认按实例关联时间倒序）。仅ProjectId非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认1。'."\n" - .'1. 关于PageNumber取值范围：'."\n" - .' a. 【推荐】方法一：根据项目关联实例总数（接口ListRenderingProjectInstances可获取），换算出上限值。'."\n" - .' b. 方法二：可以通过接口返回值判断PageNumber是否达到Project上限值，【优点：不用换算取值范围】。接口返回满足以下任意一个条件时，就可以认为PageNumber达到上限值：'."\n" - .' ⅰ. 接口返回403+错误码Code 200301'."\n" - .' ⅱ. 接口的返回值SuccessInstanceCount+FailedInstanceCount 'integer', - 'format' => 'int32', - 'minimum' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The start time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1632121707000', 'title' => ''], ], [ - 'name' => 'PatchId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'title' => '要安装的Patch包ID，仅win场景支持。'."\n" - .'1. 默认安装StablePatchId'."\n" - .'2. 输入值origin，表示安装原始版本', - 'type' => 'string', - 'example' => 'patch-7bdf679812484df08a956b73e0b3bdf6', - ], + 'schema' => ['description' => 'The end time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1632314789000', 'title' => ''], + ], + [ + 'name' => 'Expire', + 'in' => 'query', + 'schema' => ['description' => 'The expiration time of the media upload URL. Unit: seconds. Default value: 60.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'SuccessInstanceCount' => [ - 'title' => '成功的云应用服务实例量', - 'type' => 'integer', - 'format' => 'int32', - ], - 'SuccessInstances' => [ - 'title' => '成功的云应用服务实例列表', - 'type' => 'array', - 'items' => [ - 'title' => '云应用服务实例', - 'type' => 'object', - 'properties' => [ - 'RenderingInstanceId' => [ - 'title' => '云应用服务实例ID', - 'type' => 'string', - ], - ], - ], - ], - 'FailedInstanceCount' => [ - 'title' => '失败的云应用服务实例量', - 'type' => 'integer', - 'format' => 'int32', - ], - 'FailedInstances' => [ - 'title' => '失败的云应用服务实例列表', - 'type' => 'array', - 'items' => [ - 'title' => '失败的云应用服务实例', - 'type' => 'object', - 'properties' => [ - 'RenderingInstanceId' => [ - 'title' => '云应用服务实例ID', - 'type' => 'string', - ], - 'ErrMessage' => [ - 'title' => '失败原因信息', - 'type' => 'string', - ], - 'ErrCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], + 'Url' => ['description' => '媒体上传的URL，可使用PUT上传。', 'type' => 'string', 'example' => 'rtmp://demo.aliyundoc.com/live/310101*****7542007?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e', 'title' => ''], + 'AlarmId' => ['description' => '告警ID。', 'type' => 'string', 'example' => '0hyNgTdgv2D000195842', 'title' => ''], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '76E11E6A-4441-51C9-AF60-D354362257A7', 'title' => ''], + 'Expire' => ['description' => 'URL的过期时长。（单位：秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '3600', 'title' => ''], + 'AlarmDelay' => ['description' => '下次相同告警的最小间隔。（单位：秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Url\\": \\"rtmp://demo.aliyundoc.com/live/310101*****7542007?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e\\",\\n \\"AlarmId\\": \\"0hyNgTdgv2D000195842\\",\\n \\"RequestId\\": \\"76E11E6A-4441-51C9-AF60-D354362257A7\\",\\n \\"Expire\\": 3600,\\n \\"AlarmDelay\\": 60\\n}","type":"json"}]', + 'title' => 'Create device alert', + 'summary' => 'Reports a device alert.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDeviceAlarm'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateDeviceAlarm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SuccessInstanceCount\\": 5,\\n \\"SuccessInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-5130e2feb23f442fb9456a3d977f03d4\\"\\n }\\n ],\\n \\"FailedInstanceCount\\": 0,\\n \\"FailedInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-b45f28650ffe4591bf4c5c95996a428c\\",\\n \\"ErrMessage\\": \\"Rejected due to timeout\\",\\n \\"ErrCode\\": 300000\\n }\\n ]\\n}","type":"json"}]', ], - 'ListCloudAppInstallations' => [ - 'summary' => '查询云应用安装信息列表', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateDirectory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '207921', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '云应用ID，对应唯一的应用包', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', - ], + 'schema' => ['description' => 'Folder name.', 'type' => 'string', 'required' => true, 'example' => '目录1', 'title' => ''], ], [ - 'name' => 'RenderingInstanceId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例ID，用于查询指定实例上安装的云应用', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'Folder description.', 'type' => 'string', 'required' => false, 'example' => '目录1', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'title' => '应用名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'com.aaa.bbb', - ], + 'schema' => ['description' => 'Space ID to which the folder belongs.', 'type' => 'string', 'required' => true, 'example' => '348*****174-cn-qingdao', 'title' => ''], ], [ - 'name' => 'AppVersion', + 'name' => 'ParentId', 'in' => 'query', + 'schema' => ['description' => 'Parent folder ID.'."\n" + ."\n" + .'> When you create a device space, the system automatically creates a root directory for that space. Use the [DescribeDirectories](https://next.api.aliyun.com/document/vs/2018-12-12/DescribeDirectories) API to query the corresponding root directory.', 'type' => 'string', 'required' => true, 'example' => '399*****774-cn-qingdao', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '应用版本', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Folder ID.', 'type' => 'string', 'example' => '399*****488-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1.0', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"399*****488-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Create Folder', + 'summary' => 'Creates a new folder.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDirectory'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'type' => 'string', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'CreateGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '查询列表的页码。起始值为1。'."\n" - .'默认值：1。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '分页查询时设置的每页行数，最大值为100行。'."\n" - .'默认值：10。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => '我的视频监控', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Workspace description', 'type' => 'string', 'required' => false, 'example' => '我的视频监控', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'App', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Application name used by the workspace. Default value: live', 'type' => 'string', 'required' => false, 'example' => 'live', 'title' => ''], ], [ - 'name' => 'PatchId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'title' => 'Patch包ID，仅win场景支持。'."\n" - .'1. 输入值origin，表示仅过滤出原始版本', - 'type' => 'string', - 'example' => 'patch-7bdf679812484df08a956b73e0b3bdf6', - ], + 'schema' => ['description' => 'Region where the workspace is located, that is, the service center', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + ], + [ + 'name' => 'InProtocol', + 'in' => 'query', + 'schema' => ['description' => 'Ingest protocol used by the workspace. Valid values:'."\n" + ."\n" + .'- gb28181'."\n" + ."\n" + .'- rtmp', 'type' => 'string', 'required' => true, 'example' => 'rtmp', 'title' => ''], + ], + [ + 'name' => 'OutProtocol', + 'in' => 'query', + 'schema' => ['description' => 'Playback protocols used by the workspace. Separate multiple values with commas. Valid values:'."\n" + ."\n" + .'- flv'."\n" + ."\n" + .'- hls'."\n" + ."\n" + .'- rtmp', 'type' => 'string', 'required' => false, 'example' => 'flv,rtmp', 'title' => ''], + ], + [ + 'name' => 'PushDomain', + 'in' => 'query', + 'schema' => ['description' => 'Ingest domain used by the workspace', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', 'title' => ''], + ], + [ + 'name' => 'PlayDomain', + 'in' => 'query', + 'schema' => ['description' => 'Streaming domain used by the workspace', 'type' => 'string', 'required' => false, 'example' => 'demo.aliyundoc.com', 'title' => ''], + ], + [ + 'name' => 'LazyPull', + 'in' => 'query', + 'schema' => ['description' => 'Whether to enable on-demand stream pulling. Valid values:'."\n" + ."\n" + .'- false (default)'."\n" + ."\n" + .'- true', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'Callback', + 'in' => 'query', + 'schema' => ['description' => 'Callback URL triggered when device or stream status updates in the workspace', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'InstallationInfos' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AppVersion' => [ - 'title' => '应用版本', - 'description' => '', - 'type' => 'string', - 'example' => '1.5.0', - ], - 'Status' => [ - 'title' => '云应用安装状态，取值范围：'."\n" - .'1. 中间态：install-init、installing、uninstall-init、uninstalling'."\n" - .'2. 终态：installed、install-failed、uninstall-failed', - 'description' => '', - 'type' => 'string', - 'example' => 'installed', - ], - 'AppId' => [ - 'title' => '应用ID', - 'description' => '', - 'type' => 'string', - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', - ], - 'RenderingInstanceId' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - 'StatusDescription' => [ - 'title' => '状态描述信息', - 'description' => '', - 'type' => 'string', - 'example' => 'install success', - ], - 'UpdateTime' => [ - 'title' => '状态最新更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-05-28T14:50:04+08:00', - ], - 'PatchId' => [ - 'title' => 'PatchId包ID', - 'type' => 'string', - 'example' => 'patch-7bdf679812484df08a956b73e0b3bdf6', - ], - 'InstallationTime' => [ - 'title' => '安装时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-05-28T14:48:34+08:00', - ], - 'AppName' => [ - 'title' => '应用名', - 'description' => '', - 'type' => 'string', - 'example' => 'com.aaa.bbb', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '记录总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageNumber' => [ - 'title' => '查询列表的页码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页查询时设置的每页行数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'GbId' => ['description' => 'National standard ID associated with the workspace. (Applies only to workspaces using national standard ingest.)', 'type' => 'string', 'example' => '31000000****00000001', 'title' => ''], + 'GbIp' => ['description' => 'IP address of the national standard signaling gateway server associated with the workspace. (Applies only to workspaces using national standard ingest.)', 'type' => 'string', 'example' => '10.10.10.10', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'GbPort' => ['description' => 'National standard signaling server port provided by the workspace. (Applies only to workspaces using national standard ingest.)', 'type' => 'integer', 'format' => 'int64', 'example' => '5060', 'title' => ''], + 'Id' => ['description' => 'Workspace ID', 'type' => 'string', 'example' => '33763****77224964-cn-qingdao', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"InstallationInfos\\": [\\n {\\n \\"AppVersion\\": \\"1.5.0\\",\\n \\"Status\\": \\"installed\\",\\n \\"AppId\\": \\"cap-b06b26edfhytbn b94a75ae1a79efc90eb\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"StatusDescription\\": \\"install success\\",\\n \\"UpdateTime\\": \\"2024-05-28T14:50:04+08:00\\",\\n \\"PatchId\\": \\"patch-7bdf679812484df08a956b73e0b3bdf6\\",\\n \\"InstallationTime\\": \\"2024-05-28T14:48:34+08:00\\",\\n \\"AppName\\": \\"com.aaa.bbb\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', - ], - 'UninstallCloudApp' => [ - 'summary' => '卸载云应用', - 'methods' => [ - 'post', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GbId\\": \\"31000000****00000001\\",\\n \\"GbIp\\": \\"10.10.10.10\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"GbPort\\": 5060,\\n \\"Id\\": \\"33763****77224964-cn-qingdao\\"\\n}","type":"json"}]', + 'title' => 'Create Workspace', + 'summary' => 'Create a new workspace.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateHive' => [ + 'summary' => 'Creates a cluster.', + 'description' => '## Description'."\n" + ."\n" + .'- This operation creates an empty cluster to manage workloads.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4397,204 +3475,203 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '207920', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '云应用服务实例ID。'."\n" - .'RenderingInstanceId、RenderingInstanceIds、ProjectId至少必选其一。'."\n" - .'优先级RenderingInstanceId > RenderingInstanceIds > ProjectId', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Test'], ], [ - 'name' => 'AppId', + 'name' => 'Description', 'in' => 'query', + 'schema' => ['description' => 'A description of the cluster.', 'type' => 'string', 'required' => false, 'example' => 'G49单卡集群', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '云应用ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'HiveId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'hive-6c1418bf513e400bb697307c077a0ec3', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateHive', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"HiveId\\": \\"hive-6c1418bf513e400bb697307c077a0ec3\\"\\n}","type":"json"}]', + ], + 'CreateParentPlatform' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RenderingInstanceIds', + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'Name', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '云应用服务实例ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '云应用服务实例ID', - 'type' => 'string', - ], - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The name of the parent platform.', 'type' => 'string', 'required' => true, 'example' => '级联平台测试', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'The description of the parent platform.', 'type' => 'string', 'required' => false, 'example' => '级联平台测试', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Protocol', 'in' => 'query', - 'schema' => [ - 'title' => '项目下被选中的实例最大个数。仅ProjectId非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认100。取值1-100。', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '1', - 'default' => '100', - ], + 'schema' => ['description' => 'The protocol of the parent platform. Valid values:'."\n" + .'- gb28181: Chinese National Standard (GB28181).', 'type' => 'string', 'required' => false, 'default' => 'gb28181', 'example' => 'gb28181', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'GbId', 'in' => 'query', - 'schema' => [ - 'title' => '项目下实例关联关系分页页码（分页查询默认按实例关联时间倒序）。仅ProjectId非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认1。'."\n" - .'1. 关于PageNumber取值范围：'."\n" - .' a. 【推荐】方法一：根据项目关联实例总数（接口ListRenderingProjectInstances可获取），换算出上限值。'."\n" - .' b. 方法二：可以通过接口返回值判断PageNumber是否达到Project上限值，【优点：不用换算取值范围】。接口返回满足以下任意一个条件时，就可以认为PageNumber达到上限值：'."\n" - .' ⅰ. 接口返回403+错误码Code 200301'."\n" - .' ⅱ. 接口的返回值SuccessInstanceCount+FailedInstanceCount 'integer', - 'format' => 'int32', - 'minimum' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The national standard ID of the parent platform.', 'type' => 'string', 'required' => true, 'example' => '31000*****2170123451', 'title' => ''], ], [ - 'name' => 'PatchId', + 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'title' => '要卸载的Patch包ID，仅win场景支持。'."\n" - .'1. 默认卸载StablePatchId'."\n" - .'2. 输入值origin，表示卸载原始版本'."\n" - .'3. 输入值all，表示卸载所有已安装版本', - 'type' => 'string', - 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', - ], + 'schema' => ['description' => 'The SIP service IP address of the parent platform.', 'type' => 'string', 'required' => true, 'example' => '10.10.10.10', 'title' => ''], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => ['description' => 'The SIP service port of the parent platform.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5060', 'title' => ''], + ], + [ + 'name' => 'ClientAuth', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable local authentication. Valid values:'."\n" + .'- true (default)'."\n" + .'- false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'ClientUsername', + 'in' => 'query', + 'schema' => ['description' => 'The local username.', 'type' => 'string', 'required' => false, 'example' => 'user01', 'title' => ''], + ], + [ + 'name' => 'ClientPassword', + 'in' => 'query', + 'schema' => ['description' => 'The local password.', 'type' => 'string', 'required' => false, 'example' => 'admin123', 'title' => ''], + ], + [ + 'name' => 'AutoStart', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to automatically enable the parent platform. Valid values:'."\n" + .'- false (default)'."\n" + .'- true.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'SuccessInstanceCount' => [ - 'title' => '成功的云应用服务实例量', - 'type' => 'integer', - 'format' => 'int32', - ], - 'SuccessInstances' => [ - 'title' => '成功的云应用服务实例列表', - 'type' => 'array', - 'items' => [ - 'title' => '云应用服务实例', - 'type' => 'object', - 'properties' => [ - 'RenderingInstanceId' => [ - 'title' => '云应用服务实例ID', - 'type' => 'string', - ], - ], - ], - ], - 'FailedInstanceCount' => [ - 'title' => '失败的云应用服务实例量', - 'type' => 'integer', - 'format' => 'int32', - ], - 'FailedInstances' => [ - 'title' => '失败的云应用服务实例列表', - 'type' => 'array', - 'items' => [ - 'title' => '失败的云应用服务实例', - 'type' => 'object', - 'properties' => [ - 'RenderingInstanceId' => [ - 'title' => '云应用服务实例ID', - 'type' => 'string', - ], - 'ErrMessage' => [ - 'title' => '失败原因信息', - 'type' => 'string', - ], - 'ErrCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - ], + 'Id' => ['description' => '上级平台ID。', 'type' => 'string', 'example' => '359*****374-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"359*****374-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Add parent platform', + 'summary' => 'Adds a new parent platform.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateParentPlatform'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateParentPlatform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SuccessInstanceCount\\": 5,\\n \\"SuccessInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-e6cf423c787e4e43b460a788da254fe3\\"\\n }\\n ],\\n \\"FailedInstanceCount\\": 0,\\n \\"FailedInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-b45f28650ffe4591bf4c5c95996a428c\\",\\n \\"ErrMessage\\": \\"Rejected due to timeout\\",\\n \\"ErrCode\\": 300000\\n }\\n ]\\n}","type":"json"}]', ], - 'DeleteCloudApp' => [ - 'summary' => '删除云应用', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateRenderingDataPackage' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '208098', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREvsJ3UH6I'], ], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'RenderingInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Cloud application service instance ID (Note: This operation is only for crs.cp.\\* series instance types.)', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'Description.', 'type' => 'string', 'maxLength' => 64, 'required' => false, 'example' => 'testdescription', 'title' => ''], + ], + [ + 'name' => 'Category', 'in' => 'query', 'schema' => [ - 'title' => '云应用ID，对应唯一的应用包', - 'description' => '', + 'description' => 'Data type. Valid values:'."\n" + ."\n" + .'- Package (default value).'."\n" + ."\n" + .'- Baseline.', 'type' => 'string', - 'required' => true, - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', + 'enum' => ['Package', 'Baseline'], + 'required' => false, + 'example' => 'Package', + 'title' => '', + ], + ], + [ + 'name' => 'InstanceBillingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => 'Billing type. Valid values:'."\n" + ."\n" + .'- Hour: Hour.', + 'type' => 'string', + 'enum' => ['Hour', 'Day', 'Month'], + 'required' => false, + 'example' => 'Hour', + 'title' => '', ], ], ], @@ -4605,241 +3682,233 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'DataPackageId' => ['description' => 'Cloud application service data pack ID', 'type' => 'string', 'example' => 'dp-9f8c57355d224ad7beaf95e145f22111'."\n" + ."\n", 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Cloud Application Service Data Pack Creation ', + 'summary' => 'Creates a data pack for a cloud application service.', + 'changeSet' => [ + ['createdAt' => '2025-07-11T06:23:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-27T09:22:47.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'DescribeRenderingInstanceConfiguration' => [ - 'summary' => '查询云渲染实例模块配置参数', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRenderingDataPackage'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:CreateRenderingDataPackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DataPackageId\\": \\"dp-9f8c57355d224ad7beaf95e145f22111\\\\n\\\\n\\"\\n}","type":"json"}]', + ], + 'CreateRenderingInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '213856', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREvsJ3UH6I'], ], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'RenderingSpec', 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'Cloud application service instance specifications.'."\n" + ."\n" + .'- For crs.cp.\\* series specifications, choose between subscription or pay-as-you-go billing.'."\n" + ."\n" + .'- For crs.vm.\\* series specifications, choose between subscription or pay-as-you-go billing.'."\n" + ."\n" + .'- For other series, only subscription billing is supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'crs.cp.l1'], ], [ - 'name' => 'Configuration', + 'name' => 'ClientInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '配置内容', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ModuleName' => [ - 'title' => '模块名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'location', - ], - 'AttributeNames' => [ - 'title' => '模块对应的属性列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lon', - ], - 'required' => false, - ], - ], - 'required' => false, + 'title' => '', + 'description' => 'Client information.', + 'type' => 'object', + 'properties' => [ + 'ClientIp' => ['description' => 'Client IP address.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '172.21.128.110'], ], - 'deprecated' => false, 'required' => false, + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'InternetMaxBandwidth', + 'in' => 'query', + 'schema' => ['description' => 'Maximum bandwidth, in Mbps. Default is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => ['description' => '> This value is valid only when `InstanceChargeType` is `PrePaid` (subscription).'."\n" + ."\n" + .'Enable or disable auto-renewal. Values:'."\n" + ."\n" + .'- **true**: Enable.'."\n" + ."\n" + .'- **false**: Disable.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Configuration' => [ - 'title' => '配置内容', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ModuleName' => [ - 'title' => '模块名称', - 'description' => '', - 'type' => 'string', - 'example' => 'location', - ], - 'Attributes' => [ - 'title' => '属性列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '属性名', - 'description' => '', - 'type' => 'string', - 'example' => 'lon', - ], - 'Value' => [ - 'title' => '属性值', - 'description' => '', - 'type' => 'any', - 'example' => '100', - ], - ], - ], - ], - ], - ], - ], - ], + 'description' => '> This value is valid only when `InstanceChargeType` is `PrePaid` (subscription).'."\n" + ."\n" + .'The subscription period. Valid values (Note: 12 is converted to one year; other values are in months):'."\n" + ."\n" + .'- 1 (default)'."\n" + ."\n" + .'- 2'."\n" + ."\n" + .'- 3'."\n" + ."\n" + .'- 4'."\n" + ."\n" + .'- 5'."\n" + ."\n" + .'- 6'."\n" + ."\n" + .'- 7'."\n" + ."\n" + .'- 8'."\n" + ."\n" + .'- 9'."\n" + ."\n" + .'- 12', + 'type' => 'string', + 'enum' => ['1', '2', '3', '4', '5', '6', '7', '8', '9', '12'], + 'required' => false, + 'example' => '1', + 'title' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Configuration\\": [\\n {\\n \\"ModuleName\\": \\"location\\",\\n \\"Attributes\\": [\\n {\\n \\"Name\\": \\"lon\\",\\n \\"Value\\": \\"100\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - ], - 'UpdateRenderingInstanceConfiguration' => [ - 'summary' => '更新云渲染实例配置参数', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'InstanceChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method for the instance. Valid values:'."\n" + ."\n" + .'- PrePaid (default): Subscription.'."\n" + ."\n" + .'- PostPaid: Pay-as-you-go.', + 'type' => 'string', + 'enum' => ['PrePaid', 'PostPaid'], + 'required' => false, + 'example' => 'PrePaid', + 'title' => '', + ], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '213807', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', + [ + 'name' => 'InternetChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '> Only one billing method is allowed. If a billing method already exists, the new value is invalid by default, and the existing one prevails. Note that this field is required when a user makes the first purchase.'."\n" + ."\n" + .'Network billing type. Value:'."\n" + ."\n" + .'- 95BandwidthByMonth: Monthly 95th percentile bandwidth.', + 'type' => 'string', + 'required' => false, + 'enum' => ['95BandwidthByMonth', 'BandwidthByDay'], + 'example' => '95BandwidthByMonth', + 'title' => '', + ], ], - ], - 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'StorageSize', + 'in' => 'query', + 'schema' => ['description' => 'The cloud storage capacity used by the cloud application service instance (Note: not local storage).', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'InstanceBillingCycle', 'in' => 'query', 'schema' => [ - 'title' => '云渲染实例ID', - 'description' => '', + 'description' => '> This value is valid only when `InstanceChargeType` is `PostPaid` (pay-as-you-go).'."\n" + ."\n" + .'Billing type. Valid values:'."\n" + ."\n" + .'- Hour: Hourly.', 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', + 'enum' => ['Hour'], + 'required' => false, + 'example' => 'Hour', + 'title' => '', ], ], [ - 'name' => 'Configuration', - 'in' => 'formData', + 'name' => 'Attributes', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '配置内容', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ModuleName' => [ - 'title' => '模块名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'location', - ], - 'Attributes' => [ - 'title' => '模块对应的属性列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '属性名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'lon', - ], - 'Value' => [ - 'title' => '属性值', - 'description' => '', - 'type' => 'any', - 'required' => true, - 'example' => '100', - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'description' => '> Unless you have specific requirements, keep the default values. For customers with special requirements, fill in the relevant parameters after communication and confirmation.'."\n" + ."\n" + .'Attribute information.', + 'type' => 'object', + 'properties' => [ + 'Zone' => [ + 'description' => 'Resource domain.', + 'enumValueTitles' => ['Private' => 'Private', 'Public' => 'Public'], + 'type' => 'string', + 'required' => false, + 'example' => 'Public', + 'title' => '', + ], + 'OutAccess' => [ + 'description' => 'Outbound access configuration.', + 'enumValueTitles' => ['OFF' => 'OFF', 'ON' => 'ON'], + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'title' => '', + ], + 'InAccess' => [ + 'description' => 'Inbound access configuration.', + 'enumValueTitles' => ['OFF' => 'OFF', 'ON' => 'ON'], + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'title' => '', + ], + 'EdgeMediaService' => [ + 'description' => 'Streaming service.', + 'enumValueTitles' => ['OFF' => 'OFF', 'ON' => 'ON'], + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'title' => '', ], - 'required' => false, ], - 'deprecated' => false, - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -4850,92 +3919,71 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'RenderingInstanceId' => ['description' => 'The ID of the cloud application service instance.', 'type' => 'string', 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Cloud Application Service Instance Creation ', + 'summary' => 'Call CreateRenderingInstance to create a cloud application service instance.', + 'changeSet' => [ + ['createdAt' => '2025-12-03T03:07:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-11T03:43:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-24T12:19:39.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'DeleteRenderingInstanceConfiguration' => [ - 'summary' => '删除云渲染实例配置参数', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRenderingInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:CreateRenderingInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\"\\n}","type":"json"}]', + ], + 'CreateRenderingInstanceGateway' => [ + 'summary' => 'Creates a custom gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '213808', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247654', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'The ID of the cloud application service instance.', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], ], [ - 'name' => 'Configuration', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '配置内容', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ModuleName' => [ - 'title' => '模块名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'location', - ], - 'AttributeNames' => [ - 'title' => '模块对应的属性列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'lon', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'deprecated' => false, - 'required' => false, - ], + 'name' => 'GatewayInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the custom gateway instance.', 'type' => 'string', 'required' => true, 'example' => 'render-xxx', 'title' => ''], ], ], 'responses' => [ @@ -4945,75 +3993,98 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'DescribeRenderingInstanceSettings' => [ - 'summary' => '查询实例配置', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'title' => 'Create a Custom gateway', + 'description' => '> You can specify a template ID or a template type.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRenderingInstanceGateway'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:CreateRenderingInstanceGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateRenderingProject' => [ + 'summary' => 'Creates a cloud application service project and configures its properties, such as session attributes.', + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvs4YZ3LQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'The custom name of the project. This name is the unique identifier for the project.'."\n" + .'The name must meet the following requirements:'."\n" + ."\n" + .'1. Be 1 to 128 characters in length.'."\n" + ."\n" + .'2. Contain only lowercase letters, digits, underscores (\\_), hyphens (-), and periods (.).'."\n" + ."\n" + .'3. Start and end with a letter or a digit.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'title' => '', 'example' => 'du_merchant_d'], ], [ - 'name' => 'AttributeNames', + 'name' => 'SessionAttribs', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'navbar.hide', + 'title' => '', + 'description' => 'The session properties.', + 'type' => 'object', + 'properties' => [ + 'StartMode' => [ + 'description' => 'The mode to start the cloud application service for the session. Valid values:'."\n" + ."\n" + .'1. Async: asynchronous'."\n" + ."\n" + .'2. Sync: synchronous', + 'type' => 'string', + 'enum' => ['Async', 'Sync'], + 'title' => '', + 'required' => false, + 'example' => 'Async', + ], ], 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the project. The description can be 0 to 255 characters in length.', 'type' => 'string', 'required' => false, 'maxLength' => 255, 'title' => '', 'example' => '项目概述'], + ], ], 'responses' => [ 200 => [ @@ -5022,427 +4093,423 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Settings' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AttributeName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'navbar.hide', - ], - 'AttributeValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'ProjectId' => ['description' => 'The project ID. Call ListRenderingProjects to view the project ID.', 'type' => 'string', 'example' => 'project-b93ea81de76f48609eed3cd420f0399f', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Settings\\": [\\n {\\n \\"AttributeName\\": \\"navbar.hide\\",\\n \\"AttributeValue\\": \\"1\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'UpdateRenderingInstanceSettings' => [ - 'summary' => '更新实例设置', - 'path' => '', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"ProjectId\\": \\"project-b93ea81de76f48609eed3cd420f0399f\\"\\n}","type":"json"}]', + 'title' => 'Create Project', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateRenderingProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'CreateStreamSnapshot' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvs4YZ3LQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'Stream ID.', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', 'title' => ''], ], [ - 'name' => 'Settings', + 'name' => 'Location', 'in' => 'query', - 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AttributeName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'navbar.hide', - ], - 'AttributeValue' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], + 'description' => 'Screenshot method. Valid values:'."\n" + ."\n" + .'- center (cloud screenshot) (default)'."\n" + ."\n" + .'- device (device screenshot)', + 'enumValueTitles' => ['center' => 'Cloud screenshot', 'device' => 'Device screenshot'], + 'type' => 'string', 'required' => false, + 'default' => 'center', + 'example' => 'device', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'OssObject' => ['description' => 'The OSS object of the snapshot file.', 'type' => 'string', 'example' => 'photos/live/340200*****100049/ondemand-1639126601767.jpg', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Width' => ['description' => 'Image width.', 'type' => 'integer', 'format' => 'int64', 'example' => '1280', 'title' => ''], + 'Height' => ['description' => 'Image height.', 'type' => 'integer', 'format' => 'int64', 'example' => '720', 'title' => ''], + 'Url' => ['description' => 'The URL of the snapshot file.', 'type' => 'string', 'example' => 'http://examplebucket.oss-*****.aliyuncs.com/photos/live/340200*****100049/ondemand-1639126601767.jpg', 'title' => ''], + 'Timestamp' => ['description' => 'The snapshot timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1639126601767', 'title' => ''], + 'OssBucket' => ['description' => 'The OSS bucket of the snapshot file.', 'type' => 'string', 'example' => 'examplebucket', 'title' => ''], + 'Format' => ['description' => 'Image format.', 'type' => 'string', 'example' => 'jpg', 'title' => ''], + 'OssEndpoint' => ['description' => 'The OSS endpoint of the snapshot file.', 'type' => 'string', 'example' => 'oss-cn-qingdao.aliyuncs.com', 'title' => ''], + 'Id' => ['description' => 'Stream ID.', 'type' => 'string', 'example' => '323*****997-cn-qingdao', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'DeleteRenderingInstanceSettings' => [ - 'summary' => '清除实例设置', - 'path' => '', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OssObject\\": \\"photos/live/340200*****100049/ondemand-1639126601767.jpg\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"Url\\": \\"http://examplebucket.oss-*****.aliyuncs.com/photos/live/340200*****100049/ondemand-1639126601767.jpg\\",\\n \\"Timestamp\\": 1639126601767,\\n \\"OssBucket\\": \\"examplebucket\\",\\n \\"Format\\": \\"jpg\\",\\n \\"OssEndpoint\\": \\"oss-cn-qingdao.aliyuncs.com\\",\\n \\"Id\\": \\"323*****997-cn-qingdao\\"\\n}","type":"json"}]', + 'title' => 'Trigger On-Demand Screenshot', + 'summary' => 'Creates an on-demand snapshot for the specified stream.', + 'description' => '> You must first enable the on-demand snapshot feature in the attached snapshot template.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamSnapshot'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateStreamSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvs4YZ3LQ', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'Template Name.', 'type' => 'string', 'required' => true, 'example' => '录制模板', 'title' => ''], ], [ - 'name' => 'AttributeNames', + 'name' => 'Description', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'statbar.hide' => 'statbar.hide', - 'navbar.hide' => 'navbar.hide', - ], - 'example' => 'navbar.hide', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Template description.', 'type' => 'string', 'required' => false, 'example' => '录制模板', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'Template type. Valid values: '."\n" + .'- record (recording) '."\n" + .'- snapshot (snapshot) '."\n" + .'- transcode (transcoding) '."\n" + .'- timeshift (time shifting) ', 'type' => 'string', 'required' => true, 'example' => 'record', 'title' => ''], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => 'Region where the OSS bucket resides, that is, the service center. ', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => ['description' => 'OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'bucketname', 'title' => ''], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => ['description' => 'Domain name of OSS. ', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-qingdao.aliyuncs.com', 'title' => ''], + ], + [ + 'name' => 'OssFilePrefix', + 'in' => 'query', + 'schema' => ['description' => 'OSS file prefix. ', 'type' => 'string', 'required' => false, 'example' => 'oss-prefix', 'title' => ''], + ], + [ + 'name' => 'Trigger', + 'in' => 'query', + 'schema' => ['description' => 'Template trigger type. Default value: auto. Valid values: '."\n" + .'- auto (automatic) '."\n" + .'- ondemand (on-demand) ', 'type' => 'string', 'required' => false, 'example' => 'auto', 'title' => ''], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'Operation epoch, in seconds. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', 'title' => ''], + ], + [ + 'name' => 'Retention', + 'in' => 'query', + 'schema' => ['description' => 'Time-shift retention period, in days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'FileFormat', + 'in' => 'query', + 'schema' => ['description' => 'Storage file format. Multiple values are separated by commas. Valid values:'."\n" + .'- mp4'."\n" + .'- flv'."\n" + .'- hls'."\n" + .'> The Qingdao ingest endpoint does not support recording in FLV or MP4 formats.', 'type' => 'string', 'required' => false, 'example' => 'hls', 'title' => ''], + ], + [ + 'name' => 'JpgOverwrite', + 'in' => 'query', + 'schema' => ['description' => 'Storage path for JPG files used in overwrite snapshots. '."\n" + .'- Only JPG images are currently supported. '."\n" + .'- Supports variable substitution with {AppName} and {StreamName}. ', 'type' => 'string', 'required' => false, 'example' => 'osspath/snapshot/{AppName}/{StreamName}.jpg', 'title' => ''], + ], + [ + 'name' => 'JpgSequence', + 'in' => 'query', + 'schema' => ['description' => 'Storage path for JPG files used in sequential snapshots. '."\n" + .'- Only JPG images are currently supported. '."\n" + .'- Supports variable substitution with {AppName}, {StreamName}, {UnixTimestamp}, and {Sequence}. '."\n" + .'- Either {UnixTimestamp} or {Sequence} is required. ', 'type' => 'string', 'required' => false, 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', 'title' => ''], + ], + [ + 'name' => 'JpgOnDemand', + 'in' => 'query', + 'schema' => ['description' => 'Storage path for on-demand JPG screenshots.'."\n" + .'- Only JPG images are currently supported.'."\n" + .'- Variables can be used in the path. Supported variables include {AppName}, {StreamName}, {UnixTimestamp}, and {Sequence}.'."\n" + .'- Either {UnixTimestamp} or {Sequence} must be included.', 'type' => 'string', 'required' => false, 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg', 'title' => ''], + ], + [ + 'name' => 'Mp4', + 'in' => 'query', + 'schema' => ['description' => 'Storage path for MP4 files. '."\n" + .'- The path supports variable substitution. Available variables include {AppName}, {StreamName}, {Sequence}, {EscapedStartTime}, and {EscapedEndTime}. '."\n" + .'- {EscapedStartTime} and {EscapedEndTime} are required. ', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', 'title' => ''], + ], + [ + 'name' => 'Flv', + 'in' => 'query', + 'schema' => ['description' => 'Storage path for FLV files. For the format, see the description for Mp4. ', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', 'title' => ''], + ], + [ + 'name' => 'HlsM3u8', + 'in' => 'query', + 'schema' => ['description' => 'Storage path for HLS m3u8 files. For the format, see the description for Mp4. ', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', 'title' => ''], + ], + [ + 'name' => 'HlsTs', + 'in' => 'query', + 'schema' => ['description' => 'Storage path for HLS .ts files.'."\n" + .'- Variables can be used in the path. Supported variables include {AppName}, {StreamName}, {UnixTimestamp}, and {Sequence}.'."\n" + .'- The variables {UnixTimestamp} and {Sequence} must both be included.', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}', 'title' => ''], + ], + [ + 'name' => 'Callback', + 'in' => 'query', + 'schema' => ['description' => 'Callback URL to be invoked after template execution. '."\n" + ."\n" + .'> Note: Templates triggered on demand do not support callback parameters. ', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback', 'title' => ''], + ], + [ + 'name' => 'TransConfigsJSON', + 'in' => 'query', + 'schema' => ['description' => 'An array of TransConfig-type transcoding configurations, formatted as a JSON string.', 'type' => 'string', 'required' => false, 'example' => '[{"Fps":25,"Gop":50,"Height":720,"VideoCodec":"h264","Width":1280,"Name":"sd","VideoBitrate":800}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'Id' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '399*****735-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'UploadFile' => [ - 'summary' => '文件上传', - 'methods' => [ - 'post', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"399*****735-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Create Template', + 'summary' => 'Create a new template.', + 'requestParamsDescription' => '## TransConfig type'."\n" + ."\n" + .'|Parameter|Type|Required|Example Value|Description|'."\n" + .'| -----| ---- | ---- |----|---- |'."\n" + .'|Name|String|Yes|sd|Transcoding rule name. The transcoding rule name is used as the suffix of the transcoded stream. We recommend setting it to an easily identifiable suffix such as "sd" or "200k" based on your usage habits. Only letters and digits are supported.|'."\n" + .'|VideoCodec|String|Yes|h264|Video encoding. Valid value: h264|'."\n" + .'|VideoBitrate|Long|Yes|800|Video bitrate, in kbps|'."\n" + .'|Fps|Long|Yes|25|Video frame rate, in fps|'."\n" + .'|Gop|Long|Yes|50|Video GOP, in frames|'."\n" + .'|Height|Long|Yes|640|Video height|'."\n" + .'|Width|Long|Yes|1280|Video width|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTemplate'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DelHiveEdgeWorkers' => [ + 'summary' => '', + 'description' => '## 请求说明'."\n" + .'- **HiveId** 是必填参数，表示要操作的集群ID。'."\n" + .'- **InstanceIds** 是必填参数，需要提供一个负载ID列表，用于指定要从集群中解绑的负载实例。'."\n" + .'- 解绑操作成功后，会返回成功和失败的负载实例列表及其相关信息。'."\n", + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '215923', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'FileName', + 'name' => 'HiveId', 'in' => 'query', - 'schema' => [ - 'title' => '文件名。'."\n" - .'默认取值规范：'."\n" - .'1. 长度8-255'."\n" - .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" - .'3. 首、尾字符必须为字母或数字', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'mytest', - 'maxLength' => 255, - 'minLength' => 8, - ], + 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'hive-xxxx-xxx-xxx'], ], [ - 'name' => 'OriginUrl', + 'name' => 'InstanceIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '文件下载地址。', - 'description' => '', - 'type' => 'string', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'ew-xxxx', 'title' => ''], 'required' => true, - 'example' => 'https://xxx.xxx.xxx.tar', - ], - ], - [ - 'name' => 'Md5', - 'in' => 'query', - 'schema' => [ - 'title' => '文件md5，用于检查文件完整性', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '150b6083f50dd08159d45a0d5e4b56f9', - ], - ], - [ - 'name' => 'TargetPath', - 'in' => 'query', - 'schema' => [ - 'title' => '向云渲染实例推送的目标路径，必须是绝对路径，不支持输入目录。目标路径所在上级目录有范围限制，取值范围：'."\n" - .'1. /data/local'."\n" - .'2. /data/user'."\n" - .'3. /data/data'."\n" - .'4. /data/cache'."\n" - .'5. /data/tmp'."\n" - .'6. /storage', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '/data/tmp/test/xxx.tar', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '文件描述信息', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 255, + 'description' => '', + 'example' => '["ew-xxxx"]', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', + 'RequestId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => 'xxxx-xxx-xxx'], + 'SuccessInstanceCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '5', 'title' => ''], + 'FailedInstanceCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '0', 'title' => ''], + 'SuccessInstances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'ew-1226d588c69449209ee963161c067b04'], + 'Message' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'SUCCESS'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'title' => '', + 'example' => '', ], - 'FileId' => [ - 'title' => '文件ID，对应唯一的文件，如f-xxx', + 'FailedInstances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'ew-1226d588c69449209ee963161c067b04'], + 'Message' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'Error 1062 (23000): Duplicate entry \'hive-4fbf3928d40e43948b98acdb4fb5aaed-ew-1226d588c69449209ee9631\' for key \'PRIMARY\''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'type' => 'string', - 'example' => 'f-1671330gr7934d4771813f7141d28db2f7', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"FileId\\": \\"f-1671330gr7934d4771813f7141d28db2f7\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxx-xxx\\",\\n \\"SuccessInstanceCount\\": 5,\\n \\"FailedInstanceCount\\": 0,\\n \\"SuccessInstances\\": [\\n {\\n \\"InstanceId\\": \\"ew-1226d588c69449209ee963161c067b04\\",\\n \\"Message\\": \\"SUCCESS\\"\\n }\\n ],\\n \\"FailedInstances\\": [\\n {\\n \\"InstanceId\\": \\"ew-1226d588c69449209ee963161c067b04\\",\\n \\"Message\\": \\"Error 1062 (23000): Duplicate entry \'hive-4fbf3928d40e43948b98acdb4fb5aaed-ew-1226d588c69449209ee9631\' for key \'PRIMARY\'\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListFiles' => [ - 'summary' => '查询可用文件列表。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteCloudApp' => [ + 'summary' => 'Deletes a cloud application. You cannot delete a cloud application that is in use.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '215929', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'abilityTreeCode' => '208098', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'title' => '文件ID，对应唯一的可用文件', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f-1671accd4dafdag3er256cvgewt13f7141db2f7', - ], - ], - [ - 'name' => 'FileName', - 'in' => 'query', - 'schema' => [ - 'title' => '文件名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'myfile', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '查询列表的页码。起始值为1。'."\n" - .'默认值：1。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页查询时设置的每页行数，最大值为100行。'."\n" - .'默认值：10。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The cloud application ID, which corresponds to a unique application package.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], ], ], 'responses' => [ @@ -5452,459 +4519,302 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Files' => [ - 'title' => '文件信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'title' => '文件上传状态，取值范围：'."\n" - .'1. Created'."\n" - .'2. Making'."\n" - .'3. Success：终态'."\n" - .'4. Failed：终态', - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Description' => [ - 'title' => '文件描述信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'TargetPath' => [ - 'title' => '向云渲染实例推送的目标路径', - 'description' => '', - 'type' => 'string', - 'example' => '/data/tmp/test/xxx.tar', - ], - 'StatusDescription' => [ - 'title' => '状态描述信息', - 'description' => '', - 'type' => 'string', - 'example' => 'upload success', - ], - 'FileName' => [ - 'title' => '文件名', - 'description' => '', - 'type' => 'string', - 'example' => 'myfile', - ], - 'UpdateTime' => [ - 'title' => '状态最新更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-28T14:15:08+08:00', - ], - 'FileId' => [ - 'title' => '文件ID', - 'description' => '', - 'type' => 'string', - 'example' => 'f-1671accd4dafdag3er256cvgewt13f7141db2f7', - ], - 'UploadTime' => [ - 'title' => '上传开始时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-28T14:10:12+08:00', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '记录总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'PageNumber' => [ - 'title' => '查询列表的页码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页查询时设置的每页行数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Delete Application', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCloudApp'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteCloudApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Files\\": [\\n {\\n \\"Status\\": \\"Success\\",\\n \\"Description\\": \\"我的文件\\",\\n \\"TargetPath\\": \\"/data/tmp/test/xxx.tar\\",\\n \\"StatusDescription\\": \\"upload success\\",\\n \\"FileName\\": \\"myfile\\",\\n \\"UpdateTime\\": \\"2024-03-28T14:15:08+08:00\\",\\n \\"FileId\\": \\"f-1671accd4dafdag3er256cvgewt13f7141db2f7\\",\\n \\"UploadTime\\": \\"2024-03-28T14:10:12+08:00\\"\\n }\\n ],\\n \\"TotalCount\\": 200,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', ], - 'UpdateFileInfo' => [ - 'summary' => '更新文件信息。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteComfyProduction' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '215941', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'title' => '文件ID，对应唯一的文件。如f-xxx', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'f-16713accddtgtj6340jgnclhwsg1813f718db2f7', - ], - ], - [ - 'name' => 'Description', + 'name' => 'ProductionId', 'in' => 'query', - 'schema' => [ - 'title' => '文件描述信息', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - 'maxLength' => 255, - ], + 'schema' => ['description' => 'The ID of the production.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '3e5bda20-5cd4-4d55-8d23-88d624a18caa'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The message that is returned.', 'type' => 'string', 'title' => '', 'example' => 'success'], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteComfyProduction', + 'summary' => 'Deleting artifacts', + 'description' => '> Stop the parent platform before you delete a production.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], - 'PushFile' => [ - 'summary' => '预推文件到云渲染实例。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteComfyUserData' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '215938', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - ], - [ - 'name' => 'FileId', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'title' => '文件ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'f-1671accd4dafdag3er256cvgewt13f7141db2f7', - ], + 'schema' => ['description' => 'The file or directory to delete. To specify a directory, provide a path that ends with a forward slash (/).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'mytest'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteComfyUserData', + 'summary' => 'Deletes a file or directory from user data.', + 'description' => '> You must stop the upper-level platform before performing this operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], - 'ListFilePushStatuses' => [ - 'summary' => '查询文件的实例推送状态信息列表。', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteComfyWorkflow' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '215940', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'FileId', + 'name' => 'WorkflowId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the workflow.', 'type' => 'string', 'required' => true, 'example' => 'wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5f', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '文件ID，对应唯一的文件。如f-xxx', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'f-1671accd4dafdag3er256cvgewt13f7141db2f7', - ], - ], - [ - 'name' => 'RenderingInstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '云渲染实例ID，用于查询指定实例上安装的云应用', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteComfyWorkflow', + 'summary' => 'Deletes a Comfy workflow.', + 'description' => '> You must stop the parent platform before you can delete the workflow.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DeleteDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FileName', - 'in' => 'query', - 'schema' => [ - 'title' => '文件名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'myfile', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'Id', 'in' => 'query', + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '3238848****092996', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '查询列表的页码。起始值为1。'."\n" - .'默认值：1。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID of this operation.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页查询时设置的每页行数，最大值为100行。'."\n" - .'默认值：10。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Delete Device', + 'summary' => 'Deletes a device from a space.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteDirectory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'EndTime', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The folder ID.', 'type' => 'string', 'required' => true, 'example' => '348*****174-cn-qingdao', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'PushStatuses' => [ - 'title' => '文件预推信息列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'title' => '文件预推状态，取值范围：'."\n" - .'1. Created'."\n" - .'2. Doing'."\n" - .'3. Success：终态'."\n" - .'4. Failed：终态', - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'PushTime' => [ - 'title' => '预推开始时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-26T16:32:20+08:00', - ], - 'RenderingInstanceId' => [ - 'title' => '云渲染实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'."\n", - ], - 'StatusDescription' => [ - 'title' => '状态描述信息', - 'description' => '', - 'type' => 'string', - 'example' => 'push success', - ], - 'FileName' => [ - 'title' => '文件名', - 'description' => '', - 'type' => 'string', - 'example' => 'myfile', - ], - 'UpdateTime' => [ - 'title' => '状态最新更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-26T17:02:10+08:00', - ], - 'FileId' => [ - 'title' => '文件ID', - 'description' => '', - 'type' => 'string', - 'example' => 'f-1671accd4dafdag3er256cvgewt13f7141db2f7', - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '记录总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageNumber' => [ - 'title' => '查询列表的页码。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页查询时设置的每页行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Delete a folder', + 'summary' => 'Deletes a folder.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDirectory'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"PushStatuses\\": [\\n {\\n \\"Status\\": \\"Success\\",\\n \\"PushTime\\": \\"2024-03-26T16:32:20+08:00\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\\\n\\",\\n \\"StatusDescription\\": \\"push success\\",\\n \\"FileName\\": \\"myfile\\",\\n \\"UpdateTime\\": \\"2024-03-26T17:02:10+08:00\\",\\n \\"FileId\\": \\"f-1671accd4dafdag3er256cvgewt13f7141db2f7\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', ], 'DeleteFile' => [ - 'summary' => '删除文件对象。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'You cannot delete a file while it is uploading or pre-pushing. After deletion, all related push records become invalid. You can push a file with the same name again.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5914,315 +4824,292 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '215939', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'title' => '文件ID，对应唯一的文件。如f-xxx', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'f-167131acd45omat771813f7141d28db2f7', - ], + 'schema' => ['description' => 'File ID. Each file has a unique ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'f-167131acd45omat771813f7141d28db2f7'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'CreateRenderingInstanceGateway' => [ - 'summary' => '创建自定义网关', - 'methods' => [ - 'get', - 'post', + 'title' => 'Delete File', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DeleteFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFile'], + ], ], + ], + 'DeleteGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '247654', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - ], - [ - 'name' => 'GatewayInstanceId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'render-xxx', - ], + 'schema' => ['description' => 'Space ID', 'type' => 'string', 'required' => true, 'example' => '33763950751395843', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['description' => 'Request Id', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'ListRenderingInstanceGateway' => [ - 'summary' => '查询自定义网关', - 'methods' => [ - 'get', - 'post', + 'title' => 'Delete a workspace', + 'summary' => 'Delete a workspace.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroup'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteHive' => [ + 'summary' => '', + 'description' => '## 请求说明'."\n" + .'- 需要确保该集群内所有应用服务已清空，否则无法执行删除操作。'."\n" + .'- `HiveId` 是必填参数，用于标识待删除的集群。'."\n", + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '247655', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'HiveId', 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'g-xxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => 'xxxx-xxx-xxx'], + ], + 'title' => '', 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxx-xxx\\"\\n}","type":"json"}]', + ], + 'DeleteParentPlatform' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GatewayInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-xxx', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'Id', 'in' => 'query', + 'schema' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'required' => true, 'example' => '359*****374-cn-qingdao', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'default' => '1', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'default' => '10', + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Delete a parent platform', + 'summary' => 'Deletes a parent platform.', + 'description' => '> You must stop the parent platform before you delete it.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteParentPlatform'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteParentPlatform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeletePreset' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'PresetId', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The preset ID.', 'type' => 'string', 'required' => true, 'example' => '2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'GatewayConfigurationInfos' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GatewayInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'render-xxx', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'available', - ], - 'RenderingInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'render-342012a227dc4ddf91f024639e43051a', - ], - 'CreationTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-15 10:19:13', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-11-02 12:08:26', - ], - ], - ], - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10', - ], + 'Id' => ['description' => 'The device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F18FD685-B194-4489-9609-F80A9490A258', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"GatewayConfigurationInfos\\": [\\n {\\n \\"GatewayInstanceId\\": \\"render-xxx\\",\\n \\"Status\\": \\"available\\",\\n \\"RenderingInstanceId\\": \\"render-342012a227dc4ddf91f024639e43051a\\",\\n \\"CreationTime\\": \\"2024-10-15 10:19:13\\",\\n \\"UpdateTime\\": \\"2024-11-02 12:08:26\\"\\n }\\n ],\\n \\"TotalCount\\": \\"100\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\"\\n}","type":"json"}]', - ], - 'DeleteRenderingInstanceGateway' => [ - 'summary' => '删除自定义网关', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"F18FD685-B194-4489-9609-F80A9490A258\\"\\n}","type":"json"}]', + 'title' => 'Delete Preset', + 'summary' => 'Deletes a preset.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePreset'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeletePreset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeletePublicKey' => [ + 'summary' => 'Deletes a specified public key. This action automatically revokes logon authorization for all associated cloud application service instances.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '247658', - 'abilityTreeNodes' => [ - 'FEATUREvs8VD2LG', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '207905', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'RenderingInstanceId', + 'name' => 'KeyName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], + 'schema' => ['description' => 'The name of the public key.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'appKey'], ], ], 'responses' => [ @@ -6232,99 +5119,85 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'CreateRenderingProject' => [ - 'summary' => '创建一个新的云应用服务项目，并设置相关属性。', - 'path' => '/', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'title' => 'Delete Public Key', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePublicKey'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DeletePublicKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteRenderingInstanceConfiguration' => [ + 'summary' => 'Deletes the configuration of a cloud application service instance. This operation deletes only module properties that are configured using the UpdateRenderingInstanceConfiguration operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '213808', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'ProjectName', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '自定义项目名，将作为项目的唯一标记。'."\n" - .'默认取值规范：'."\n" - .'1. 长度1-128'."\n" - .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" - .'3. 首、尾字符必须为字母或数字', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'du_merchant_d', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'schema' => ['description' => 'Cloud application service instance ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'SessionAttribs', - 'in' => 'query', + 'name' => 'Configuration', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '会话属性', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StartMode' => [ - 'title' => '会话启动云应用服务的模式，取值范围，'."\n" - .'1. Async：异步'."\n" - .'2. Sync：同步', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Async', - 'enum' => [ - 'Async', - 'Sync', + 'title' => '', + 'description' => 'Configuration content. Purge all configured modules by default.', + 'type' => 'array', + 'items' => [ + 'description' => 'Real device simulation module properties.', + 'type' => 'object', + 'properties' => [ + 'ModuleName' => ['description' => 'Module name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'location'], + 'AttributeNames' => [ + 'title' => '', + 'description' => 'List attribute names to purge. Purge all configured attributes for this module by default.', + 'type' => 'array', + 'items' => ['description' => 'Attribute name.', 'type' => 'string', 'required' => false, 'example' => 'lon', 'title' => ''], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '项目描述信息，0-255', - 'description' => '', - 'type' => 'string', + 'deprecated' => false, 'required' => false, 'example' => '', - 'maxLength' => 255, ], ], ], @@ -6335,123 +5208,60 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'ProjectId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'project-b93ea81de76f48609eed3cd420f0399f', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"ProjectId\\": \\"project-b93ea81de76f48609eed3cd420f0399f\\"\\n}","type":"json"}]', - ], - 'ListRenderingProjects' => [ - 'summary' => '分页查询用户下的云应用服务项目基本信息列表。', - 'description' => '## 请求说明'."\n" - .'- 该接口用于分页查询指定用户下的渲染项目基本信息列表。'."\n" - .'- 可通过 `ProjectId` 和 `ProjectName` 进行过滤查询。'."\n", - 'path' => '/', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Delete configuration settings of a Graphic Computing Service instance', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DeleteRenderingInstanceConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRenderingInstanceConfiguration'], + ], ], + ], + 'DeleteRenderingInstanceGateway' => [ + 'summary' => 'Deletes a custom gateway.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], + 'abilityTreeCode' => '247658', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', - ], - ], - [ - 'name' => 'ProjectName', - 'in' => 'query', - 'schema' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'idata_content', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '页码，起始值为1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页查询时设置的每页行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Cloud application service instance ID', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], ], ], 'responses' => [ @@ -6461,87 +5271,41 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Projects' => [ - 'title' => '项目列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'title' => '项目描述信息', - 'description' => '', - 'type' => 'string', - 'example' => 'description', - ], - 'ProjectName' => [ - 'title' => '项目名称', - 'description' => '', - 'type' => 'string', - 'example' => 'prod-project', - ], - 'ProjectId' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', - ], - 'CreationTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-09-09T18:44:49+08:00', - ], - 'UpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-09T18:44:49+08:00', - ], - 'SessionAttribs' => [ - 'title' => '项目会话属性', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StartMode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Sync', - ], - ], - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '匹配的项目总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Delete a custom gateway', + 'description' => '> Stop the parent platform before you delete the gateway.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DeleteRenderingInstanceGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRenderingInstanceGateway'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Projects\\": [\\n {\\n \\"Description\\": \\"description\\",\\n \\"ProjectName\\": \\"prod-project\\",\\n \\"ProjectId\\": \\"project-422bc38dfgh5eb44149f135ef76304f63b\\",\\n \\"CreationTime\\": \\"2024-09-09T18:44:49+08:00\\",\\n \\"UpdateTime\\": \\"2024-10-09T18:44:49+08:00\\",\\n \\"SessionAttribs\\": {\\n \\"StartMode\\": \\"Sync\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]', ], - 'UpdateRenderingProject' => [ - 'summary' => '更新一个项目的属性信息', + 'DeleteRenderingInstanceSettings' => [ + 'summary' => 'You can call DeleteRenderingInstanceSettings to delete the settings of a cloud application service instance.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6550,77 +5314,37 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], + 'abilityTreeNodes' => ['FEATUREvs4YZ3LQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', - ], - ], - [ - 'name' => 'ProjectName', - 'in' => 'query', - 'schema' => [ - 'title' => '自定义项目名，将作为项目的唯一标记。'."\n" - .'默认取值规范：'."\n" - .'1. 长度1-128'."\n" - .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" - .'3. 首、尾字符必须为字母或数字'."\n" - .'ProjectName/SessionAttribs/Description 至少一项非空', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'idata_content', - ], + 'schema' => ['description' => 'ID of the cloud application service instance.', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], ], [ - 'name' => 'SessionAttribs', + 'name' => 'AttributeNames', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '会话属性', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'StartMode' => [ - 'title' => '会话启动云应用服务的模式，取值范围，'."\n" - .'1. Async：异步'."\n" - .'2. Sync：同步', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Async', - 'enum' => [ - 'Async', - 'Sync', - ], - ], + 'description' => 'List of attribute names.', + 'type' => 'array', + 'items' => [ + 'description' => 'Attribute name.', + 'enumValueTitles' => ['statbar.hide' => 'statbar.hide', 'navbar.hide' => 'navbar.hide'], + 'type' => 'string', + 'required' => false, + 'example' => 'navbar.hide', + 'title' => '', ], 'required' => false, - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '项目描述', - 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', - 'maxLength' => 255, ], ], ], @@ -6628,35 +5352,43 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'AssociateRenderingProjectInstances' => [ - 'summary' => '云应用服务实例与项目进行关联。', - 'description' => '## 请求说明'."\n" - .'- 该接口用于将满足特定条件的实例与指定项目进行关联。'."\n", - 'path' => '/', - 'methods' => [ - 'post', + 'title' => 'Delete settings of a cloud application service instance', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DeleteRenderingInstanceSettings', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRenderingInstanceSettings'], + ], ], + ], + 'DeleteRenderingProject' => [ + 'summary' => 'Delete a Data Service Project. Projects that have business scheduling data, such as active sessions, cannot be deleted.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6665,40 +5397,16 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', - ], - ], - [ - 'name' => 'RenderingInstanceIds', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-4523e7b93ca246febd10cd12347d70c0', - ], - 'required' => true, - ], + 'schema' => ['title' => '', 'description' => 'Project ID', 'type' => 'string', 'required' => true, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], ], ], 'responses' => [ @@ -6708,361 +5416,416 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'SuccessInstanceCount' => [ - 'title' => '成功的云应用服务实例量', - 'description' => '', - 'type' => 'string', - 'example' => '5', - ], - 'FailedInstanceCount' => [ - 'title' => '失败的云应用服务实例量', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'SuccessInstances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RenderingInstanceId' => [ - 'title' => '云应用服务实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'render-5130e2feb23f442fb9456a3d977f03d4', - ], - 'Message' => [ - 'title' => '描述信息', - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - ], - ], - ], - 'FailedInstances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RenderingInstanceId' => [ - 'title' => '云应用服务实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'render-b45f28650ffe4591bf4c5c95996a428c', - ], - 'Message' => [ - 'title' => '失败原因', - 'description' => '', - 'type' => 'string', - 'example' => 'invalid id', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SuccessInstanceCount\\": \\"5\\",\\n \\"FailedInstanceCount\\": \\"0\\",\\n \\"SuccessInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-5130e2feb23f442fb9456a3d977f03d4\\",\\n \\"Message\\": \\"SUCCESS\\"\\n }\\n ],\\n \\"FailedInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-b45f28650ffe4591bf4c5c95996a428c\\",\\n \\"Message\\": \\"invalid id\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'ListRenderingProjectInstances' => [ - 'summary' => '分页查询项目关联的云应用服务实例列表。', - 'description' => '## 请求说明'."\n" - .'- 该接口支持通过多种筛选条件（如状态、实例ID等）来查询指定项目下的云应用服务实例。'."\n", - 'path' => '/', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Delete Project', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteRenderingProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'DeleteTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', - ], + 'schema' => ['description' => 'The ID of the template.', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', 'title' => ''], ], - [ - 'name' => 'RenderingInstanceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '云应用服务实例ID', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Delete template', + 'summary' => 'Deletes a template.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplate'], + ], + ], + 'ramActions' => [ [ - 'name' => 'State', - 'in' => 'query', - 'schema' => [ - 'title' => '云应用服务实例业务调度状态，取值范围，'."\n" - .'1. Idle：空闲'."\n" - .'2. Locked：锁定中'."\n" - .'3. InUse：使用中', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Idle', - 'enum' => [ - 'Idle', - 'Locked', - 'InUse', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'DeleteVsPullStreamInfoConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '页码，起始值为1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'title' => '分页查询时设置的每页行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'Your stream pulling domain.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The application name for the live stream.', 'type' => 'string', 'required' => true, 'example' => 'xxxApp', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'StreamName', 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the live stream.', 'type' => 'string', 'required' => true, 'example' => 'xxxStream', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'RenderingInstances' => [ - 'title' => '云应用服务实例列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AssociationTime' => [ - 'title' => '关联时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-09-11T18:19:04+08:00', - ], - 'RenderingInstanceId' => [ - 'title' => '云应用服务实例', - 'description' => '', - 'type' => 'string', - 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', - ], - 'StateInfo' => [ - 'title' => '业务调度状态信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Comment' => [ - 'title' => '状态描述信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'State' => [ - 'title' => '业务调度状态', - 'description' => '', - 'type' => 'string', - 'example' => 'InUse', - ], - 'UpdateTime' => [ - 'title' => '状态最新更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-11-11T18:19:04+08:00', - ], - ], - ], - ], - ], - ], - 'TotalCount' => [ - 'title' => '云应用服务实例数目', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Delete stream pulling configuration', + 'summary' => 'Delete stream pulling information.', + 'extraInfo' => '## Special error codes'."\n" + .'| Error code | Description | HTTP status code | Semantics |'."\n" + .'|------------|-------------|------------------|-----------|'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | An unknown error occurred in the backend. |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain was not found under the current account. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | The current operation is not supported, such as using a non-live streaming domain. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteVsPullStreamInfoConfig'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteVsPullStreamInfoConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstances\\": [\\n {\\n \\"AssociationTime\\": \\"2024-09-11T18:19:04+08:00\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"StateInfo\\": {\\n \\"Comment\\": \\"正在会话中\\",\\n \\"State\\": \\"InUse\\",\\n \\"UpdateTime\\": \\"2024-11-11T18:19:04+08:00\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 8\\n}","type":"json"}]', ], - 'GetRenderingProjectInstanceStateMetrics' => [ - 'summary' => '输出满足特定条件的资源各状态数据量统计值。', - 'path' => '/', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteVsStreamsNotifyUrlConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'The accelerated domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4C747C97-7ECD-4C61-8A92-67AD806331FF', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], ], ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C747C97-7ECD-4C61-8A92-67AD806331FF\\"\\n}","type":"json"}]', + 'title' => 'Delete stream ingest callback configuration', + 'summary' => 'Deletes the callback configuration for stream ingest.', + 'extraInfo' => '## Special error codes'."\n" + .'| Error code | Description | HTTP status code | Semantics |'."\n" + .'|------------|-------------|------------------|-----------|'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | An unknown error occurred in the backend. |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain name was not found under the current account. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | The current operation is not supported, such as when the domain is not of the live streaming type. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteVsStreamsNotifyUrlConfig'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteVsStreamsNotifyUrlConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeAccountStat' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Id', 'in' => 'query', + 'schema' => ['description' => 'Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '1165*****601', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '项目ID', + 'type' => 'object', + 'properties' => [ + 'TemplateNum' => ['description' => 'Current number of templates.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'GroupLimit' => ['description' => 'The maximum number of device spaces.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'TemplateLimit' => ['description' => 'Maximum number of templates.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'GroupNum' => ['description' => 'Number of device groups in the current region.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'Id' => ['description' => 'Alibaba Cloud account ID.', 'type' => 'string', 'example' => '1165*****601', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TemplateNum\\": 10,\\n \\"GroupLimit\\": 100,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TemplateLimit\\": 20,\\n \\"GroupNum\\": 6,\\n \\"Id\\": \\"1165*****601\\"\\n}","type":"json"}]', + 'title' => 'Query Account Status', + 'summary' => 'Query all resource information for an account in a specified region.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccountStat'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeAccountStat', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeComfyProductionDownloadUrl' => [ + 'summary' => 'Retrieves a download link for a production.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], + 'parameters' => [ + [ + 'name' => 'ProductionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the production.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '3e5bda20-5cd4-4d55-8d23-88d624a18caa'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'DownloadUrl' => ['description' => 'The download link for the production. Use an Alibaba Cloud Object Storage Service (OSS) SDK to download the file.', 'type' => 'string', 'title' => '', 'example' => 'https://xxx.xxx.xxx'], + 'ExpiredTime' => ['description' => 'The download link\'s expiration time.', 'type' => 'string', 'title' => '', 'example' => '2029-03-28T16:00Z'], + ], + 'title' => '', + 'description' => 'The data returned for the request.', + 'example' => '', ], ], ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeComfyProductionDownloadUrl', + 'description' => '> Screenshot queries do not support pagination and must be performed iteratively. To fetch the next page, use the extStartTime value from the response as the StartTime for your subsequent request.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"DownloadUrl\\": \\"https://xxx.xxx.xxx\\",\\n \\"ExpiredTime\\": \\"2029-03-28T16:00Z\\"\\n}","type":"json"}]', + ], + 'DescribeComfyProductions' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Comfy task whose productions you want to list.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '6c8234f4-d1e1-4cea-b08b-7926fbdea144'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the results to return. Pages are 1-indexed. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'StateMetrics' => [ - 'description' => '', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'success'], + 'Productions' => [ 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'State' => [ - 'title' => '项目实例状态', - 'description' => '', - 'type' => 'string', - 'example' => 'Idle', - ], - 'Count' => [ - 'title' => '实例数量', - 'description' => '', - 'type' => 'string', - 'example' => '10', - ], + 'ProductionId' => ['description' => 'The ID of the production.', 'type' => 'string', 'title' => '', 'example' => '3e5bda20-5cd4-4d55-8d23-88d624a18caa'], + 'ComfyTaskId' => ['description' => 'The ID of the Comfy task.', 'type' => 'string', 'title' => '', 'example' => '6c8234f4-d1e1-4cea-b08b-7926fbdea144'], + 'State' => ['description' => 'The state of the production.', 'type' => 'string', 'title' => '', 'example' => 'NORMAL'], + 'FileName' => ['description' => 'The file name of the production.', 'type' => 'string', 'title' => '', 'example' => '1755051607877.mp4'], + 'CreationTime' => ['description' => 'The creation time of the production, in ISO 8601 format.', 'type' => 'string', 'title' => '', 'example' => '2026-02-06T20:20:26+08:00'], + 'UpdatedTime' => ['description' => 'The last modification time of the production, as a Unix timestamp.', 'type' => 'string', 'title' => '', 'example' => '1773707865'], ], + 'description' => 'The details of a production.', + 'title' => '', + 'example' => '', ], + 'description' => 'A list of productions.', + 'title' => '', + 'example' => '', ], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total count of productions.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"StateMetrics\\": [\\n {\\n \\"State\\": \\"Idle\\",\\n \\"Count\\": \\"10\\"\\n }\\n ]\\n}","type":"json"}]', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeComfyProductions', + 'summary' => 'Lists a user\'s productions.', + 'description' => '> This API uses pagination. Use the PageNumber and PageSize parameters to navigate through the results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Productions\\": [\\n {\\n \\"ProductionId\\": \\"3e5bda20-5cd4-4d55-8d23-88d624a18caa\\",\\n \\"ComfyTaskId\\": \\"6c8234f4-d1e1-4cea-b08b-7926fbdea144\\",\\n \\"State\\": \\"NORMAL\\",\\n \\"FileName\\": \\"1755051607877.mp4\\",\\n \\"CreationTime\\": \\"2026-02-06T20:20:26+08:00\\",\\n \\"UpdatedTime\\": \\"1773707865\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 1\\n}","type":"json"}]', ], - 'DisassociateRenderingProjectInstances' => [ - 'summary' => '云应用服务实例与项目解除关联', - 'path' => '/', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeComfyTasks' => [ + 'summary' => 'Queries a list of Comfy tasks.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7071,128 +5834,97 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'WorkflowId', + 'in' => 'query', + 'schema' => ['description' => 'If you specify this parameter, the operation returns only tasks for the specified workflow.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5f'], + ], + [ + 'name' => 'TaskState', 'in' => 'query', 'schema' => [ - 'title' => '项目ID', - 'description' => '', + 'description' => 'The task state. If specified, the operation returns only tasks in that state.', 'type' => 'string', - 'required' => true, - 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', + 'required' => false, + 'enum' => ['QUEUED', 'SCHEDULING', 'SCHEDULED', 'EXECUTING', 'COMPLETED', 'FAILED', 'CANCELLED'], + 'title' => '', + 'example' => 'QUEUED', ], ], [ - 'name' => 'RenderingInstanceIds', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'render-a371588064324c57b7b0133a96cbd17a', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of tasks per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '20'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'SuccessInstances' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The error code. A value of 0 indicates a successful request.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The message that provides details about the result of the request.', 'type' => 'string', 'title' => '', 'example' => 'success'], + 'Tasks' => [ 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'RenderingInstanceId' => [ - 'title' => '云应用服务实例ID', - 'description' => '', - 'type' => 'string', - 'example' => 'render-e6cf423c787e4e43b460a788da254fe3', - ], - 'Message' => [ - 'title' => '描述信息', - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'title' => '', 'example' => '6c8234f4-d1e1-4cea-b08b-7926fbdea144'], + 'WorkflowId' => ['description' => 'The ID of the Comfy workflow associated with the task.', 'type' => 'string', 'title' => '', 'example' => 'wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5f'], + 'HiveId' => ['description' => 'The ID of the resource pool used by the task.', 'type' => 'string', 'title' => '', 'example' => 'hive-26cd567b35c04a0a90f017388207b2'], + 'TaskState' => ['description' => 'The task state.', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'CreationTime' => ['description' => 'The creation time of the task.', 'type' => 'string', 'title' => '', 'example' => '1780387493000'], + 'UpdatedTime' => ['description' => 'The last modified time of the task.', 'type' => 'string', 'title' => '', 'example' => '1780387494000'], + 'EndTime' => ['description' => 'The end time of the task.', 'type' => 'string', 'title' => '', 'example' => '1780387494000'], ], - ], - ], - 'FailedInstances' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RenderingInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'render-421cd2a1125947c19fcd5c7dd2c7d31e', - ], - 'Message' => [ - 'title' => '失败原因', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], + 'title' => '', + 'example' => '', ], + 'description' => 'A list of Comfy tasks.', + 'title' => '', + 'example' => '', ], - 'SuccessInstanceCount' => [ - 'title' => '成功的云应用服务实例量', - 'description' => '', - 'type' => 'string', - 'example' => '5', - ], - 'FailedInstanceCount' => [ - 'title' => '失败的云应用服务实例量', - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], + 'PageNumber' => ['description' => 'The page number of the returned data. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of tasks per page.'."\n" + ."\n" + .'> This parameter applies only to recording queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of tasks that match the filter criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'description' => 'The object that contains the response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SuccessInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-e6cf423c787e4e43b460a788da254fe3\\",\\n \\"Message\\": \\"success\\"\\n }\\n ],\\n \\"FailedInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-421cd2a1125947c19fcd5c7dd2c7d31e\\",\\n \\"Message\\": \\"会话中\\"\\n }\\n ],\\n \\"SuccessInstanceCount\\": \\"5\\",\\n \\"FailedInstanceCount\\": \\"0\\"\\n}","type":"json"}]', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeComfyTasks', + 'description' => '> Querying by screenshot does not support pagination and only supports iteration. To request the next page, use the extStartTime parameter value from the response as the StartTime for the new request.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Tasks\\": [\\n {\\n \\"TaskId\\": \\"6c8234f4-d1e1-4cea-b08b-7926fbdea144\\",\\n \\"WorkflowId\\": \\"wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5f\\",\\n \\"HiveId\\": \\"hive-26cd567b35c04a0a90f017388207b2\\",\\n \\"TaskState\\": \\"RUNNING\\",\\n \\"CreationTime\\": \\"1780387493000\\",\\n \\"UpdatedTime\\": \\"1780387494000\\",\\n \\"EndTime\\": \\"1780387494000\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 1\\n}","type":"json"}]', ], - 'DeleteRenderingProject' => [ - 'summary' => '删除一个云应用服务项目，有在线会话等业务调度数据的项目不允许删除。', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeComfyUserDataDownloadUrl' => [ + 'summary' => 'Gets a download URL for user data.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7201,57 +5933,50 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', - ], + 'schema' => ['description' => 'The name of the file to download.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'myfile'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The result message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'DownloadUrl' => ['description' => 'The download URL for the application package.', 'type' => 'string', 'example' => 'https://xxx.xxx.xxx.', 'title' => ''], + 'ExpiredTime' => ['description' => 'The expiration time for the download link.', 'type' => 'string', 'example' => '1752805579553', 'title' => ''], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeComfyUserDataDownloadUrl', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"DownloadUrl\\": \\"https://xxx.xxx.xxx.\\",\\n \\"ExpiredTime\\": \\"1752805579553\\"\\n}","type":"json"}]', ], - 'StartRenderingSession' => [ - 'summary' => '调度一个空闲云应用服务实例，并完成服务启动。', - 'path' => '/', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeComfyUserDataUploadUrl' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7260,196 +5985,156 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', - ], + 'schema' => ['description' => 'The name of the file to upload. The filename can be a single file, such as \\`1.jpg\\`, or include a path, such as \\`directory1/1.jpg\\`.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'myfile'], ], [ - 'name' => 'ClientId', + 'name' => 'FileSizeBytes', 'in' => 'query', - 'schema' => [ - 'title' => '终端客户的唯一ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '04c30850-1d91-4da1-b811-66d0ee94af7d', - ], + 'schema' => ['description' => 'The actual size of the file in bytes. This value must be the exact size of the file. The file size is verified when you use the upload URL.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1024'], ], [ - 'name' => 'AppId', + 'name' => 'FileMd5', 'in' => 'query', - 'schema' => [ - 'title' => '云应用ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', - ], + 'schema' => ['description' => 'The MD5 hash of the file to be uploaded. This value must be the file\'s actual MD5 hash. The file size is also verified during the upload.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '54d6911ba6d59dbe68990835a409f18c'], ], [ - 'name' => 'ClientParams', + 'name' => 'ContentType', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The content type of the file.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'application/jpeg'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '终端客户的参数信息', - 'description' => '', 'type' => 'object', 'properties' => [ - 'ClientIp' => [ - 'title' => '终端客户Ip，将默认用于位置就近实例调度', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '106.11.43.1', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The description.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'UploadUrl' => ['description' => 'The URL for uploading the user file.', 'type' => 'string', 'title' => '', 'example' => 'oss-bucket.oss-cn-shanghai-cloudspe.aliyuncs.com/path/userid/test.png?x-oss-date=20260602T093618Z&x-oss-expires=29&x-oss-security-token=xxxxx%2F68FY2NI6nyNgueynMjneKjKXD6l5tS5h3S2%xxxxx%xxxx%xxxxxxx%2Fb%xxxx%sdffeeeaasdf%xxx%xx%xx%xxxx%2BeASOv2N8q%xxx%2B6XBxllroojFliSTfsqGI2YMHpoRwJmyfXK32BQPb2SvQ0AM23soq%2FspAI4f9vtFG0yv9fKWMw%xxxxxxxxx%xxxxxxxx%3D%3D&x-oss-signature-version=OSS4-HMAC&x-oss-credential=STS.xxxxx%2F20260dfa202%2Fcn-shanghai-cloud%2Foss%2Faliyun_v4_request&x-oss-signature=xxxxxxxxxxxxxx'], + 'ExpiredTime' => ['description' => 'The expiration time of the upload URL.', 'type' => 'string', 'title' => '', 'example' => '2026-08-28T16:00Z'], ], - 'required' => false, + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], - [ - 'name' => 'PatchId', + ], + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeComfyUserDataUploadUrl', + 'summary' => 'Retrieves a URL to upload a user file.', + 'description' => 'You can upload files using the retrieved URL and the Alibaba Cloud OSS software development kit (SDK).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"UploadUrl\\": \\"oss-bucket.oss-cn-shanghai-cloudspe.aliyuncs.com/path/userid/test.png?x-oss-date=20260602T093618Z&x-oss-expires=29&x-oss-security-token=xxxxx%2F68FY2NI6nyNgueynMjneKjKXD6l5tS5h3S2%xxxxx%xxxx%xxxxxxx%2Fb%xxxx%sdffeeeaasdf%xxx%xx%xx%xxxx%2BeASOv2N8q%xxx%2B6XBxllroojFliSTfsqGI2YMHpoRwJmyfXK32BQPb2SvQ0AM23soq%2FspAI4f9vtFG0yv9fKWMw%xxxxxxxxx%xxxxxxxx%3D%3D&x-oss-signature-version=OSS4-HMAC&x-oss-credential=STS.xxxxx%2F20260dfa202%2Fcn-shanghai-cloud%2Foss%2Faliyun_v4_request&x-oss-signature=xxxxxxxxxxxxxx\\",\\n \\"ExpiredTime\\": \\"2026-08-28T16:00Z\\"\\n}","type":"json"}]', + ], + 'DescribeComfyUserDatas' => [ + 'summary' => 'Lists all files and folders in the user data.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], + 'parameters' => [ + [ + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'title' => '云应用补丁包ID。'."\n" - .'1. 默认启动AppId稳定版本（未设置稳定Patch版本时，默认为原始版本）'."\n" - .'2. 输入origin时，启动原始版本', - 'type' => 'string', - 'example' => 'patch-03fa76e8e13a49b63456b063dgh309b4', - ], + 'schema' => ['description' => 'The name of the file to query, or the folder to query. For a folder, provide the path ending with a forward slash (/).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'myfile'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the list to query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'SessionId' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', - 'example' => 'session-i205217481741918129226', - ], - 'Hostname' => [ - 'title' => '实例hostname,默认为出口Eip', - 'description' => '', - 'type' => 'string', - 'example' => 'cn-xxx.ecr.aliyuncs.com', - ], - 'PortMappings' => [ - 'title' => '端口映射信息', - 'description' => '', + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => 'success'], + 'UserDatas' => [ 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'ExternalPort' => [ - 'title' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', - 'description' => '', - 'type' => 'string', - 'example' => '10013/10020', - ], - 'InternalPort' => [ - 'title' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', - 'description' => '', - 'type' => 'string', - 'example' => '49008/49015', - ], - ], - ], - ], - 'StateInfo' => [ - 'title' => '业务调度状态信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'State' => [ - 'title' => '业务调度状态', - 'description' => '', - 'type' => 'string', - 'example' => 'SessionStarting', - ], - 'Comment' => [ - 'title' => '状态描述信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'UpdateTime' => [ - 'title' => '状态最新更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2021-05-06T06:37Z', - ], - ], - ], - 'Location' => [ - 'title' => '云应用服务实例位置信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ProvinceCode' => [ - 'title' => '云应用服务实例所属省份码', - 'description' => '', - 'type' => 'string', - 'example' => '610000', + 'Type' => ['description' => 'The entry type. Valid values are \\`file\\` and \\`dir\\`.', 'type' => 'string', 'title' => '', 'example' => 'file'], + 'FileSize' => ['description' => 'The file size in bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1024'], + 'FileName' => ['description' => 'The name of the file or folder.', 'type' => 'string', 'title' => '', 'example' => 'myfile'], + 'UpdatedTime' => ['description' => 'The time the file was last modified.', 'type' => 'string', 'title' => '', 'example' => '1776646928000'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'IsRepeatedRequest' => [ - 'title' => '是否是重复请求', 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'RenderingInstanceId' => [ - 'title' => '云应用服务实例ID', - 'type' => 'string', + 'title' => '', + 'example' => '', ], + 'PageNumber' => ['description' => 'The page number of the returned list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. The default value is 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SessionId\\": \\"session-i205217481741918129226\\",\\n \\"Hostname\\": \\"cn-xxx.ecr.aliyuncs.com\\",\\n \\"PortMappings\\": [\\n {\\n \\"ExternalPort\\": \\"10013/10020\\",\\n \\"InternalPort\\": \\"49008/49015\\"\\n }\\n ],\\n \\"StateInfo\\": {\\n \\"State\\": \\"SessionStarting\\",\\n \\"Comment\\": \\"会话启动中\\",\\n \\"UpdateTime\\": \\"2021-05-06T06:37Z\\"\\n },\\n \\"Location\\": {\\n \\"ProvinceCode\\": \\"610000\\"\\n },\\n \\"IsRepeatedRequest\\": false,\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\"\\n}","type":"json"}]', + 'errorCodes' => [], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeComfyUserDatas', + 'description' => 'If StartTime and EndTime are not specified, data from the last 24 hours is read by default. To query a specific time range, you must specify both StartTime and EndTime. The maximum time range for a query is 31 days.'."\n" + ."\n" + .'- You can query multiple domain names in a batch. Separate the domain names with a comma (,).'."\n" + ."\n" + .'- You can retrieve data from the last 90 days.'."\n" + ."\n" + .'- The time granularity is one hour.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"UserDatas\\": [\\n {\\n \\"Type\\": \\"file\\",\\n \\"FileSize\\": 1024,\\n \\"FileName\\": \\"myfile\\",\\n \\"UpdatedTime\\": \\"1776646928000\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 1\\n}","type":"json"}]', ], - 'ListRenderingSessions' => [ - 'summary' => '分页查询指定条件下的渲染会话列表。', - 'description' => '## 请求说明'."\n" - .'- 该接口支持通过多种参数组合来过滤和分页查询用户的渲染会话列表。'."\n" - .'- `SessionId` 和 `ClientId` 参数至少需要提供一个，但两者都不是必选的。如果同时提供了两个参数，则将根据这两个参数进行更精确的匹配。'."\n", - 'path' => '/', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeComfyWorkflows' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7458,554 +6143,341 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], + 'abilityTreeNodes' => ['FEATUREvs4YZ3LQ'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'session-i205217481741918129226', - ], - ], - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'title' => '终端客户的唯一ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ae7990f4-203d-494b-a5ea-e0babe9fa13d', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'title' => '云应用ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', - ], - ], - [ - 'name' => 'State', - 'in' => 'query', - 'schema' => [ - 'title' => '云应用服务实例调度状态，取值范围，'."\n" - .'1. SessionStarting：会话启动中'."\n" - .'2. SessionStartSuspended：会话启动暂停，重新发起start可重试'."\n" - .'3. SessionStarted：会话已启动/使用中'."\n" - .'4. SessionStartFailed：会话启动失败'."\n" - .'5. SessionAbnormal：会话启动成功后，出现状态异常'."\n" - .'6. SessionStopping：会话停止中'."\n" - .'7. SessionStopFailed：会话停止失败', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SessionStarting', - 'enum' => [ - 'SessionStarting', - 'SessionStartSuspended', - 'SessionStarted', - 'SessionAbnormal', - 'SessionStartFailed', - 'SessionStopping', - 'SessionStopFailed', - ], - ], - ], - [ - 'name' => 'RenderingInstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '云应用服务实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'The workflow name.', 'type' => 'string', 'required' => false, 'example' => '图生视频工作流', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '页码，起始值为1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '分页查询时设置的每页行数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'PatchId', - 'in' => 'query', - 'schema' => [ - 'title' => '云应用补丁包ID。'."\n" - .'1. 输入origin时，仅过滤启动了App原始版本的会话', - 'type' => 'string', - 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The number of Comfy workflows per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Sessions' => [ - 'title' => '会话列表', - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Workflows' => [ 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'AppId' => [ - 'title' => '云应用ID', - 'description' => '', - 'type' => 'string', - 'example' => 'cap-4e1a6a425495458ba78693b8ac6600ea', - ], - 'RenderingInstanceId' => [ - 'title' => '云应用服务实例ID', - 'type' => 'string', - ], - 'StartTime' => [ - 'title' => '启动时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-07-04T01:23:00Z', - ], - 'ClientId' => [ - 'title' => '终端客户端ID', - 'description' => '', - 'type' => 'string', - 'example' => 'fd6b2134-7954-4754-8915-5fb8b0469622', - ], - 'PatchId' => [ - 'title' => '云应用补丁包ID。空值表示为原始版本', - 'type' => 'string', - 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', - ], - 'SessionId' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', - 'example' => 'session-i205217481741918129226', - ], + 'WorkflowId' => ['description' => 'The workflow ID.', 'type' => 'string', 'title' => '', 'example' => 'wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5f'], + 'Name' => ['description' => 'The workflow name.', 'type' => 'string', 'title' => '', 'example' => '图生视频工作流'], + 'CreationTime' => ['description' => 'The time when the workflow was created.', 'type' => 'string', 'title' => '', 'example' => '2026-02-03T07:31:45+08:00'], + 'Description' => ['description' => 'The workflow description.', 'type' => 'string', 'title' => '', 'example' => '这是一个图生视频工作流'], + 'UpdatedTime' => ['description' => 'The time when the workflow was last updated.', 'type' => 'string', 'title' => '', 'example' => '1778897586'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'description' => 'A list of Comfy workflows.', + 'example' => '', ], - 'TotalCount' => [ - 'title' => '匹配的会话总数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], + 'TotalCount' => ['description' => 'The total number of workflows that match the query.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of workflows on the current page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeComfyWorkflows', + 'summary' => 'This operation retrieves a paginated list of your Comfy workflows.', + 'description' => '\\> 截图查询目前不支持分页，仅支持按迭代方式。使用返回结果里的extStartTime参数值，作为新请求的StartTime可请求下一页。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Sessions\\": [\\n {\\n \\"AppId\\": \\"cap-4e1a6a425495458ba78693b8ac6600ea\\",\\n \\"RenderingInstanceId\\": \\"render-a10722fb84b243f6ba02a89a2e5c838d\\",\\n \\"StartTime\\": \\"2024-07-04T01:23:00Z\\",\\n \\"ClientId\\": \\"fd6b2134-7954-4754-8915-5fb8b0469622\\",\\n \\"PatchId\\": \\"patch-03fa76e8e13a49b6a966b063d9d309b4\\",\\n \\"SessionId\\": \\"session-i205217481741918129226\\"\\n }\\n ],\\n \\"TotalCount\\": 8\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": 0,\\n \\"Message\\": \\"success\\",\\n \\"Workflows\\": [\\n {\\n \\"WorkflowId\\": \\"wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5f\\",\\n \\"Name\\": \\"图生视频工作流\\",\\n \\"CreationTime\\": \\"2026-02-03T07:31:45+08:00\\",\\n \\"Description\\": \\"这是一个图生视频工作流\\",\\n \\"UpdatedTime\\": \\"1778897586\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', ], - 'DescribeRenderingSession' => [ - 'summary' => '输出会话的详情信息，包含关联的实例、网络出口等信息。', - 'path' => '/', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '3238848****092996-cn-qingdao', 'title' => ''], ], [ - 'name' => 'SessionId', + 'name' => 'IncludeStats', 'in' => 'query', - 'schema' => [ - 'title' => '会话ID。SessionId/ClientId至少必选一项', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'session-i205217481741918129226', - ], + 'schema' => ['description' => 'Return stream statistics. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'ClientId', + 'name' => 'IncludeDirectory', 'in' => 'query', - 'schema' => [ - 'title' => '终端客户的唯一ID。SessionId/ClientId至少必选一项', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'd27c89d6-4fe3-4855-a89c-ea721c708b0b', - ], + 'schema' => ['description' => 'Return directory information. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'SessionId' => [ - 'title' => '会话ID', - 'description' => '', - 'type' => 'string', - 'example' => 'session-i205217481741918129226', + 'Type' => ['description' => 'Device type. Valid values:'."\n" + ."\n" + .'- ipc (camera)'."\n" + ."\n" + .'- platform (platform)'."\n" + ."\n" + .'- ied (intelligent device)', 'type' => 'string', 'example' => 'ipc', 'title' => ''], + 'Status' => ['description' => 'Device status. Valid values:'."\n" + ."\n" + .'- on (online)'."\n" + ."\n" + .'- off (offline)'."\n" + ."\n" + .'- failed (locked)'."\n" + ."\n" + .'- new (unregistered)', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'AlarmMethod' => ['description' => 'Subscribed GB alarm method. Valid values:'."\n" + ."\n" + .'- 0 (all)'."\n" + ."\n" + .'- 5 (video alarm)'."\n" + ."\n" + .'- 7 (other alarms)'."\n" + ."\n" + .'> * An empty value means no subscription.'."\n" + .'>'."\n" + .'> * Multiple values are supported, separated by commas (,).', 'type' => 'string', 'example' => '5', 'title' => ''], + 'Dsn' => ['description' => 'Device serial number.', 'type' => 'string', 'example' => '7D0*****4C0', 'title' => ''], + 'Port' => ['description' => 'Device port.', 'type' => 'integer', 'format' => 'int64', 'example' => '8080', 'title' => ''], + 'PosInterval' => ['description' => 'Position subscription interval, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''], + 'ParentId' => ['description' => 'Parent device ID. For example, the platform ID to which a camera belongs.', 'type' => 'string', 'example' => '3238848****092995-cn-qingdao', 'title' => ''], + 'Password' => ['description' => 'Device password.', 'type' => 'string', 'example' => 'admin', 'title' => ''], + 'AutoPos' => ['description' => 'Indicates whether device location subscription is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Params' => ['description' => 'Other device parameters.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Description' => ['description' => 'Device description.', 'type' => 'string', 'example' => 'xxx路口摄像头', 'title' => ''], + 'Enabled' => ['description' => 'Whether the device is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Name' => ['description' => 'Device name.', 'type' => 'string', 'example' => 'xxx路口摄像头', 'title' => ''], + 'ChannelSyncTime' => ['description' => 'Channel synchronization time.', 'type' => 'string', 'example' => '2019-02-28T17:01:17Z', 'title' => ''], + 'CreatedTime' => ['description' => 'Device creation time.', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', 'title' => ''], + 'DirectoryId' => ['description' => 'Directory ID.', 'type' => 'string', 'example' => '3238848****092994-cn-qingdao', 'title' => ''], + 'RegisteredTime' => ['description' => 'Device registration time.', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', 'title' => ''], + 'Protocol' => ['description' => 'Device registration protocol.', 'type' => 'string', 'example' => 'gb28181', 'title' => ''], + 'Ip' => ['description' => 'Device IP address.', 'type' => 'string', 'example' => '10.10.10.10', 'title' => ''], + 'Url' => ['description' => 'Stream URL on the device.', 'type' => 'string', 'example' => 'rtmp://xxx/xxx', 'title' => ''], + 'AutoStart' => ['description' => 'Automatically start the stream.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Vendor' => ['description' => 'Device vendor.', 'type' => 'string', 'example' => '公司A', 'title' => ''], + 'GbId' => ['description' => 'GB device ID.'."\n" + ."\n" + .'> This applies only to GB protocols.', 'type' => 'string', 'example' => '31000000****00000002', 'title' => ''], + 'GroupId' => ['description' => 'Space ID to which the device belongs.', 'type' => 'string', 'example' => '3238848****092994-cn-qingdao', 'title' => ''], + 'Longitude' => ['description' => 'Device longitude.', 'type' => 'string', 'example' => '45.00', 'title' => ''], + 'Latitude' => ['description' => 'Device latitude.', 'type' => 'string', 'example' => '119.20', 'title' => ''], + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '3238848****092996-cn-qingdao', 'title' => ''], + 'Username' => ['description' => 'Device username.', 'type' => 'string', 'example' => 'admin', 'title' => ''], + 'Stats' => [ + 'description' => 'Device stream statistics.', + 'type' => 'object', + 'properties' => [ + 'FailedNum' => ['description' => 'Number of failed streams.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'StreamNum' => ['description' => 'Number of streams.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ChannelNum' => ['description' => 'Number of channels.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'OnlineNum' => ['description' => 'Number of online streams.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'OfflineNum' => ['description' => 'Number of offline streams.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'ClientId' => [ - 'title' => '终端客户端ID', - 'description' => '', - 'type' => 'string', - 'example' => 'c91263a0-f9ac-45bd-bbe9-6e293ad32d91', - ], - 'AppId' => [ - 'title' => '云应用ID', - 'description' => '', - 'type' => 'string', - 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', - ], - 'StartTime' => [ - 'title' => '启动时间', - 'description' => '', - 'type' => 'string', - 'example' => '2025-05-18T02:20:00Z', - ], - 'Hostname' => [ - 'title' => '云应用服务实例域名/IP。默认该域名/IP相关信息将自动传递给边缘实例。', - 'description' => '', - 'type' => 'string', - 'example' => '111.45.29.96', - ], - 'Isp' => [ - 'title' => '运营商编码，取值范围：'."\n" - .'1. cmcc'."\n" - .'2. unicom'."\n" - .'3. telecom', - 'type' => 'string', - ], - 'PortMappings' => [ - 'title' => '端口映射信息', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ExternalPort' => [ - 'title' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', - 'description' => '', - 'type' => 'string', - 'example' => '10013/10020', - ], - 'InternalPort' => [ - 'title' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', - 'description' => '', - 'type' => 'string', - 'example' => '49008/49015', - ], - ], - ], - ], - 'StateInfo' => [ - 'title' => '业务调度状态信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'State' => [ - 'title' => '业务调度状态', - 'description' => '', - 'type' => 'string', - 'example' => 'SessionStarted', - ], - 'Comment' => [ - 'title' => '状态描述信息', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'UpdateTime' => [ - 'title' => '状态最新更新时间', - 'description' => '', - 'type' => 'string', - 'example' => '2024-10-15T10:05:20+08:00', - ], - ], - ], - 'Location' => [ - 'title' => '云应用服务实例位置信息', - 'description' => '', + 'Directory' => [ + 'description' => 'Directory information.', 'type' => 'object', 'properties' => [ - 'ProvinceCode' => [ - 'title' => '云应用服务实例所属省份码', - 'description' => '', - 'type' => 'string', - 'example' => '310000', - ], - ], - ], - 'AdditionalIngresses' => [ - 'title' => '其他可选的入口网络信息', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PortMappings' => [ - 'title' => '端口映射列表', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ExternalPort' => [ - 'title' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', - 'type' => 'string', - ], - 'InternalPort' => [ - 'title' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', - 'type' => 'string', - ], - ], - ], - ], - 'Isp' => [ - 'title' => '运营商编码，取值范围：'."\n" - .'1. cmcc'."\n" - .'2. unicom'."\n" - .'3. telecom', - 'type' => 'string', - ], - 'Hostname' => [ - 'title' => '云应用服务实例域名/IP', - 'type' => 'string', - ], - ], + 'ParentId' => ['description' => 'Parent directory ID.', 'type' => 'string', 'example' => '3238848****092995-cn-qingdao', 'title' => ''], + 'Description' => ['description' => 'Directory description.', 'type' => 'string', 'example' => '目录1', 'title' => ''], + 'GroupId' => ['description' => 'Space ID to which the directory belongs.', 'type' => 'string', 'example' => '3238848****092994-cn-qingdao', 'title' => ''], + 'Name' => ['description' => 'Directory name.', 'type' => 'string', 'example' => '目录1', 'title' => ''], + 'CreatedTime' => ['description' => 'Directory creation time.', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', 'title' => ''], + 'Id' => ['description' => 'Directory ID.', 'type' => 'string', 'example' => '3238848****092994-cn-qingdao', 'title' => ''], ], - ], - 'RenderingInstanceId' => [ - 'title' => '云应用服务实例ID', - 'type' => 'string', - ], - 'PatchId' => [ - 'title' => '云应用补丁包ID。空值表示为原始版本', - 'type' => 'string', - 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SessionId\\": \\"session-i205217481741918129226\\",\\n \\"ClientId\\": \\"c91263a0-f9ac-45bd-bbe9-6e293ad32d91\\",\\n \\"AppId\\": \\"cap-b06b26edfhytbn b94a75ae1a79efc90eb\\",\\n \\"StartTime\\": \\"2025-05-18T02:20:00Z\\",\\n \\"Hostname\\": \\"111.45.29.96\\",\\n \\"Isp\\": \\"telecom\\",\\n \\"PortMappings\\": [\\n {\\n \\"ExternalPort\\": \\"10013/10020\\",\\n \\"InternalPort\\": \\"49008/49015\\"\\n }\\n ],\\n \\"StateInfo\\": {\\n \\"State\\": \\"SessionStarted\\",\\n \\"Comment\\": \\"已启动\\",\\n \\"UpdateTime\\": \\"2024-10-15T10:05:20+08:00\\"\\n },\\n \\"Location\\": {\\n \\"ProvinceCode\\": \\"310000\\"\\n },\\n \\"AdditionalIngresses\\": [\\n {\\n \\"PortMappings\\": [\\n {\\n \\"ExternalPort\\": \\"11060/11079\\",\\n \\"InternalPort\\": \\"11060/11079\\"\\n }\\n ],\\n \\"Isp\\": \\"unicom\\",\\n \\"Hostname\\": \\"111.45.29.96\\"\\n }\\n ],\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"PatchId\\": \\"patch-03fa76e8e13a49b6a966b063d9d309b4\\"\\n}","type":"json"}]', - ], - 'StopRenderingSession' => [ - 'summary' => '关闭指定的云应用服务会话并回收相关实例资源。', - 'description' => '## 请求说明'."\n", - 'path' => '/', - 'methods' => [ - 'post', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Type\\": \\"ipc\\",\\n \\"Status\\": \\"on\\",\\n \\"AlarmMethod\\": \\"5\\",\\n \\"Dsn\\": \\"7D0*****4C0\\",\\n \\"Port\\": 8080,\\n \\"PosInterval\\": 300,\\n \\"ParentId\\": \\"3238848****092995-cn-qingdao\\",\\n \\"Password\\": \\"admin\\",\\n \\"AutoPos\\": false,\\n \\"Params\\": \\"{}\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Description\\": \\"xxx路口摄像头\\",\\n \\"Enabled\\": true,\\n \\"Name\\": \\"xxx路口摄像头\\",\\n \\"ChannelSyncTime\\": \\"2019-02-28T17:01:17Z\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"DirectoryId\\": \\"3238848****092994-cn-qingdao\\",\\n \\"RegisteredTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Protocol\\": \\"gb28181\\",\\n \\"Ip\\": \\"10.10.10.10\\",\\n \\"Url\\": \\"rtmp://xxx/xxx\\",\\n \\"AutoStart\\": false,\\n \\"Vendor\\": \\"公司A\\",\\n \\"GbId\\": \\"31000000****00000002\\",\\n \\"GroupId\\": \\"3238848****092994-cn-qingdao\\",\\n \\"Longitude\\": \\"45.00\\",\\n \\"Latitude\\": \\"119.20\\",\\n \\"Id\\": \\"3238848****092996-cn-qingdao\\",\\n \\"Username\\": \\"admin\\",\\n \\"Stats\\": {\\n \\"FailedNum\\": 1,\\n \\"StreamNum\\": 1,\\n \\"ChannelNum\\": 1,\\n \\"OnlineNum\\": 1,\\n \\"OfflineNum\\": 1\\n },\\n \\"Directory\\": {\\n \\"ParentId\\": \\"3238848****092995-cn-qingdao\\",\\n \\"Description\\": \\"目录1\\",\\n \\"GroupId\\": \\"3238848****092994-cn-qingdao\\",\\n \\"Name\\": \\"目录1\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Id\\": \\"3238848****092994-cn-qingdao\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query device ', + 'summary' => 'Query information about a device.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDevice'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDeviceChannels' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREvsGPC7NJ', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '项目ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', - ], + 'schema' => ['description' => 'Query by device ID', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], [ - 'name' => 'SessionId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '会话ID。SessionId/ClientId至少必选一项', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'session-i205217481741918129226', - ], + 'schema' => ['description' => 'The number of entries per page. The default value is 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'ClientId', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'title' => '终端客户的唯一ID。SessionId/ClientId至少必选一项', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '04c30850-1d91-4da1-b811-66d0ee94af7d', - ], + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4641C72D-462E-4AEA-8485-FC267AF90B0A', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of channels.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Channels' => [ + 'description' => 'The list of channels.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StreamStatus' => ['description' => 'The status of the stream.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'GbId' => ['description' => 'The GB ID.', 'type' => 'string', 'example' => '3100000****000000002', 'title' => ''], + 'Params' => ['description' => 'Other configurations of the device.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'DeviceStatus' => ['description' => 'The status of the device.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'Name' => ['description' => 'The name of the channel.', 'type' => 'string', 'example' => '通道1', 'title' => ''], + 'StreamId' => ['description' => 'The stream ID.', 'type' => 'string', 'example' => '323*****997-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'DescribeAccountStat' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"4641C72D-462E-4AEA-8485-FC267AF90B0A\\",\\n \\"TotalCount\\": 1,\\n \\"PageCount\\": 1,\\n \\"Channels\\": [\\n {\\n \\"StreamStatus\\": \\"off\\",\\n \\"GbId\\": \\"3100000****000000002\\",\\n \\"Params\\": \\"{}\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\",\\n \\"ChannelId\\": 0,\\n \\"DeviceStatus\\": \\"on\\",\\n \\"Name\\": \\"通道1\\",\\n \\"StreamId\\": \\"323*****997-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query device channel list ', + 'summary' => 'Queries a list of device channels.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeviceChannels'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDeviceChannels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDeviceGateway' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '24611****70597051-cn-beijing', 'title' => ''], + ], + [ + 'name' => 'ClientIp', + 'in' => 'query', + 'schema' => ['description' => 'Client IP address.', 'type' => 'string', 'required' => false, 'example' => '192.168.0.1', 'title' => ''], + ], + [ + 'name' => 'Expire', + 'in' => 'query', + 'schema' => ['description' => 'Time-to-live (TTL).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', 'title' => ''], ], ], 'responses' => [ @@ -8013,271 +6485,245 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TemplateNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'GroupLimit' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'TemplateLimit' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'GroupNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'Id' => [ - 'description' => 'ID', - 'type' => 'string', - 'example' => '3238848****092996', - ], + 'Host' => ['description' => 'Alibaba Cloud service endpoint.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], + 'Token' => ['description' => 'Token code.', 'type' => 'string', 'example' => 'f5578fbc-694c-461d-a2a2-eb090775cef0', 'title' => ''], + 'RequestId' => ['description' => 'Request ID for this task.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Port' => ['description' => 'Port number.', 'type' => 'integer', 'format' => 'int64', 'example' => '8080', 'title' => ''], + 'Protocol' => ['description' => 'Device registration protocol.', 'type' => 'string', 'example' => 'gb28181', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TemplateNum\\": 10,\\n \\"GroupLimit\\": 100,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TemplateLimit\\": 20,\\n \\"GroupNum\\": 6,\\n \\"Id\\": \\"1165*****601\\"\\n}","type":"json"}]', - ], - 'DescribeVsUserResourcePackage' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Host\\": \\"192.168.0.1\\",\\n \\"Token\\": \\"f5578fbc-694c-461d-a2a2-eb090775cef0\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Port\\": 8080,\\n \\"Protocol\\": \\"gb28181\\"\\n}","type":"json"}]', + 'title' => 'Query Device Gateway', + 'summary' => 'Queries a device gateway.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeviceGateway'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDeviceGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDeviceURL' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'Stream', + 'in' => 'query', + 'schema' => ['description' => 'Stream name.', 'type' => 'string', 'required' => true, 'example' => 'live001', 'title' => ''], + ], + [ + 'name' => 'OutProtocol', + 'in' => 'query', + 'schema' => ['description' => 'Stream protocol. Valid values:'."\n" + ."\n" + .'- rtmp'."\n" + ."\n" + .'- flv'."\n" + ."\n" + .'- hls'."\n" + ."\n" + .'> When Mode is set to push, only rtmp is supported.', 'type' => 'string', 'required' => true, 'example' => 'rtmp', 'title' => ''], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => ['description' => 'Stream mode. Valid values:'."\n" + ."\n" + .'- play'."\n" + ."\n" + .'- push', 'type' => 'string', 'required' => false, 'default' => 'play', 'example' => 'push', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'default' => 'live', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Auth', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'true', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Expire', + 'in' => 'query', + 'schema' => ['description' => 'Authentication validity period, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', 'title' => ''], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'ResourcePackageInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ResourcePackageInfo' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'type' => 'string', - ], - 'Status' => [ - 'type' => 'string', - ], - 'CommodityCode' => [ - 'type' => 'string', - ], - 'CurrCapacity' => [ - 'type' => 'string', - ], - 'InitCapacity' => [ - 'type' => 'string', - ], - 'InstanceId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], + 'Url' => ['description' => 'Stream URL.', 'type' => 'string', 'example' => 'rtmp://demo.aliyundoc.com/live/live001?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'ExpireTime' => ['description' => 'URL expiration time.
'."\n" + .'UNIX timestamp, in seconds.
', 'type' => 'integer', 'format' => 'int64', 'example' => '1639130258', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => null, - ], - 'OpenVsService' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'APP' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '150275784', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Url\\": \\"rtmp://demo.aliyundoc.com/live/live001?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"ExpireTime\\": 1639130258\\n}","type":"json"}]', + 'title' => 'Query Device URL', + 'summary' => 'Queries the URL information for a device stream.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeviceURL'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDeviceURL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"150275784\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', ], - 'CreateGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The device ID.'."\n" + ."\n" + .'> Specify multiple IDs. Separate them with commas (,).', 'type' => 'string', 'required' => false, 'example' => '348*****380-cn-qingdao', 'title' => ''], + ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The device name.'."\n" + ."\n" + .'> Specify multiple names. Separate them with commas (,).', 'type' => 'string', 'required' => false, 'example' => '摄像头A', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The device type. Valid values:'."\n" + ."\n" + .'- ipc (camera)'."\n" + ."\n" + .'- platform'."\n" + ."\n" + .'- ied (intelligent edge device)', 'type' => 'string', 'required' => false, 'example' => 'ipc', 'title' => ''], ], [ - 'name' => 'App', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'live', - ], + 'schema' => ['description' => 'Query by device Space ID.', 'type' => 'string', 'required' => false, 'example' => '348*****174-cn-qingdao', 'title' => ''], ], [ - 'name' => 'Region', + 'name' => 'ParentId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'The ID of the parent device.', 'type' => 'string', 'required' => false, 'example' => '399*****774-cn-qingdao', 'title' => ''], ], [ - 'name' => 'InProtocol', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rtmp', - ], + 'schema' => ['description' => 'The ID of the directory to which the device belongs.', 'type' => 'string', 'required' => false, 'example' => '399*****488-cn-qingdao', 'title' => ''], ], [ - 'name' => 'OutProtocol', + 'name' => 'GbId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'flv,rtmp', - ], + 'schema' => ['description' => 'You can query by device national standard ID.', 'type' => 'string', 'required' => false, 'example' => '310000000****0000002', 'title' => ''], ], [ - 'name' => 'PushDomain', + 'name' => 'Dsn', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example.aliyundoc.com', - ], + 'schema' => ['description' => 'The serial number of the device. The value must be unique.', 'type' => 'string', 'required' => false, 'example' => '7D0*****4C0', 'title' => ''], ], [ - 'name' => 'PlayDomain', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'demo.aliyundoc.com', - ], + 'schema' => ['description' => 'Query devices by status.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ - 'name' => 'LazyPull', + 'name' => 'Vendor', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Query by device manufacturer.', 'type' => 'string', 'required' => false, 'example' => '8yd*****qem', 'title' => ''], ], [ - 'name' => 'Callback', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://example.com/callback', - ], + 'schema' => ['description' => 'The field by which to sort the results. Valid value:'."\n" + ."\n" + .'> id (default)', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], + ], + [ + 'name' => 'SortDirection', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- asc (ascending) (default)'."\n" + ."\n" + .'- desc (descending)', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IncludeStats', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return stream statistics. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'IncludeDirectory', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return directory information. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -8285,70 +6731,191 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'GbId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '31000000****00000001', - ], - 'GbIp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.10.10.10', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'GbPort' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5060', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '33763****77224964-cn-qingdao', + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of devices.', 'type' => 'integer', 'format' => 'int64', 'example' => '77', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'Devices' => [ + 'description' => 'The list of devices.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The device type. Valid values:'."\n" + ."\n" + .'- ipc (camera)'."\n" + ."\n" + .'- platform'."\n" + ."\n" + .'- ied (intelligent edge device)', 'type' => 'string', 'example' => 'ipc', 'title' => ''], + 'Status' => ['description' => 'The device status. Valid values:'."\n" + ."\n" + .'- on (online)'."\n" + ."\n" + .'- off (offline)'."\n" + ."\n" + .'- failed'."\n" + ."\n" + .'- new (unregistered)', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'AlarmMethod' => ['description' => 'The GB/T 28181 alarm subscription method. Valid values:'."\n" + ."\n" + .'- 0 (all)'."\n" + ."\n" + .'- 5 (video alarm)'."\n" + ."\n" + .'- 7 (other alarm)'."\n" + ."\n" + .'> * An empty value indicates that no alarm is subscribed.'."\n" + .'>'."\n" + .'> * Specify multiple values. Separate them with commas (,).', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Dsn' => ['description' => 'The serial number of the device.'."\n" + ."\n" + .'> This parameter applies only to the AUVSP and ODCAP protocols.', 'type' => 'string', 'example' => '7D0*****4C0', 'title' => ''], + 'Port' => ['description' => 'The device port.', 'type' => 'integer', 'format' => 'int64', 'example' => '8080', 'title' => ''], + 'PosInterval' => ['description' => 'The position subscription interval, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''], + 'AutoDirectory' => ['description' => 'Indicates whether directory reporting is enabled for the platform device.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ParentId' => ['description' => 'The ID of the parent device, such as the ID of the platform to which a camera belongs.', 'type' => 'string', 'example' => '3238848****092995', 'title' => ''], + 'Password' => ['description' => 'The device password.', 'type' => 'string', 'example' => 'admin', 'title' => ''], + 'AutoPos' => ['description' => 'Indicates whether to enable position subscription for the device.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Params' => ['description' => 'Other parameters of the device.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Description' => ['description' => 'The description of the device.', 'type' => 'string', 'example' => 'xxx路口摄像头', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the device is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Name' => ['description' => 'The device name.', 'type' => 'string', 'example' => 'xxx路口摄像头', 'title' => ''], + 'ChannelSyncTime' => ['description' => 'The time when the channels were synchronized.', 'type' => 'string', 'example' => '2019-02-28T17:01:17Z', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the device was created.', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', 'title' => ''], + 'DirectoryId' => ['description' => 'The directory ID.', 'type' => 'string', 'example' => '399*****488-cn-qingdao', 'title' => ''], + 'RegisteredTime' => ['description' => 'The time when the device was registered.', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', 'title' => ''], + 'Protocol' => ['description' => 'The device protocol.', 'type' => 'string', 'example' => 'gb28181', 'title' => ''], + 'Ip' => ['description' => 'The IP address of the device.', 'type' => 'string', 'example' => '10.10.10.10', 'title' => ''], + 'Url' => ['description' => 'The stream URL on the device.', 'type' => 'string', 'example' => 'rtmp://xxx/xxx', 'title' => ''], + 'AutoStart' => ['description' => 'Indicates whether to automatically start the stream.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Vendor' => ['description' => 'The manufacturer of the device.', 'type' => 'string', 'example' => '公司A', 'title' => ''], + 'GbId' => ['description' => 'The GB/T 28181 ID of the device.'."\n" + ."\n" + .'> This parameter applies only to the GB/T 28181 protocol.', 'type' => 'string', 'example' => '310000000****0000002', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the group to which the device belongs.', 'type' => 'string', 'example' => '348*****174-cn-qingdao', 'title' => ''], + 'Longitude' => ['description' => 'The longitude of the device.', 'type' => 'string', 'example' => '45.00', 'title' => ''], + 'Latitude' => ['description' => 'The latitude of the device.', 'type' => 'string', 'example' => '119.20', 'title' => ''], + 'Id' => ['description' => 'The device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'Username' => ['description' => 'The username for the device.', 'type' => 'string', 'example' => 'admin', 'title' => ''], + 'Stats' => [ + 'description' => 'The stream statistics of the device.', + 'type' => 'object', + 'properties' => [ + 'FailedNum' => ['description' => 'The number of failed streams.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'StreamNum' => ['description' => 'The number of streams.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ChannelNum' => ['description' => 'The number of channels.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'OnlineNum' => ['description' => 'The number of online streams.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'OfflineNum' => ['description' => 'The number of offline streams.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Directory' => [ + 'description' => 'The directory information.', + 'type' => 'object', + 'properties' => [ + 'ParentId' => ['description' => 'The ID of the parent directory.', 'type' => 'string', 'example' => '399*****774-cn-qingdao', 'title' => ''], + 'Description' => ['description' => 'The description of the directory.', 'type' => 'string', 'example' => '目录1', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the group to which the directory belongs.', 'type' => 'string', 'example' => '348*****174-cn-qingdao', 'title' => ''], + 'Name' => ['description' => 'The name of the directory.', 'type' => 'string', 'example' => '目录1', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the directory was created.', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', 'title' => ''], + 'Id' => ['description' => 'The directory ID.', 'type' => 'string', 'example' => '399*****488-cn-qingdao', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"GbId\\": \\"31000000****00000001\\",\\n \\"GbIp\\": \\"10.10.10.10\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"GbPort\\": 5060,\\n \\"Id\\": \\"33763****77224964-cn-qingdao\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreateGroup', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 77,\\n \\"PageCount\\": 5,\\n \\"Devices\\": [\\n {\\n \\"Type\\": \\"ipc\\",\\n \\"Status\\": \\"on\\",\\n \\"AlarmMethod\\": \\"0\\",\\n \\"Dsn\\": \\"7D0*****4C0\\",\\n \\"Port\\": 8080,\\n \\"PosInterval\\": 300,\\n \\"AutoDirectory\\": true,\\n \\"ParentId\\": \\"3238848****092995\\",\\n \\"Password\\": \\"admin\\",\\n \\"AutoPos\\": false,\\n \\"Params\\": \\"{}\\",\\n \\"Description\\": \\"xxx路口摄像头\\",\\n \\"Enabled\\": true,\\n \\"Name\\": \\"xxx路口摄像头\\",\\n \\"ChannelSyncTime\\": \\"2019-02-28T17:01:17Z\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"DirectoryId\\": \\"399*****488-cn-qingdao\\",\\n \\"RegisteredTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Protocol\\": \\"gb28181\\",\\n \\"Ip\\": \\"10.10.10.10\\",\\n \\"Url\\": \\"rtmp://xxx/xxx\\",\\n \\"AutoStart\\": false,\\n \\"Vendor\\": \\"公司A\\",\\n \\"GbId\\": \\"310000000****0000002\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"Longitude\\": \\"45.00\\",\\n \\"Latitude\\": \\"119.20\\",\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"Username\\": \\"admin\\",\\n \\"Stats\\": {\\n \\"FailedNum\\": 0,\\n \\"StreamNum\\": 0,\\n \\"ChannelNum\\": 0,\\n \\"OnlineNum\\": 0,\\n \\"OfflineNum\\": 0\\n },\\n \\"Directory\\": {\\n \\"ParentId\\": \\"399*****774-cn-qingdao\\",\\n \\"Description\\": \\"目录1\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"Name\\": \\"目录1\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Id\\": \\"399*****488-cn-qingdao\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query device list', + 'summary' => 'Queries a list of devices.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDevices'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDirectories' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '33763950751395843', - ], + 'schema' => ['description' => 'ID of the group to which the directory belongs.', 'type' => 'string', 'required' => true, 'example' => '348*****174-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => ['description' => 'Query by parent directory ID.', 'type' => 'string', 'required' => false, 'example' => '399*****774-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'Sort by the specified field. Default is by ID.', 'type' => 'string', 'required' => false, 'example' => 'ID', 'title' => ''], + ], + [ + 'name' => 'SortDirection', + 'in' => 'query', + 'schema' => ['description' => 'Sort order. Default is ascending. Values:'."\n" + ."\n" + .'- asc (ascending)'."\n" + ."\n" + .'- desc (descending)', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size. Default is 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'Page number. Default is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'NoPagination', + 'in' => 'query', + 'schema' => ['description' => 'Disable paging. Default is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -8356,214 +6923,143 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Request Id', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'PageNum' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of directories.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageCount' => ['description' => 'Total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Directories' => [ + 'description' => 'List of directories.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentId' => ['description' => 'Parent directory ID.', 'type' => 'string', 'example' => '399*****774-cn-qingdao', 'title' => ''], + 'Description' => ['description' => 'Directory description.', 'type' => 'string', 'example' => '目录2', 'title' => ''], + 'GroupId' => ['description' => 'ID of the group to which the directory belongs.', 'type' => 'string', 'example' => '348*****174-cn-qingdao', 'title' => ''], + 'Name' => ['description' => 'Directory name.', 'type' => 'string', 'example' => '目录2', 'title' => ''], + 'CreatedTime' => ['description' => 'Directory creation time.', 'type' => 'string', 'example' => '2021-09-10T10:00:00Z', 'title' => ''], + 'Id' => ['description' => 'Directory ID.', 'type' => 'string', 'example' => '399*****488-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteGroup', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 1,\\n \\"PageCount\\": 1,\\n \\"Directories\\": [\\n {\\n \\"ParentId\\": \\"399*****774-cn-qingdao\\",\\n \\"Description\\": \\"目录2\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"Name\\": \\"目录2\\",\\n \\"CreatedTime\\": \\"2021-09-10T10:00:00Z\\",\\n \\"Id\\": \\"399*****488-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the folder list', + 'summary' => 'Query the list of directories.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDirectories'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDirectories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDirectory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', + 'schema' => ['description' => 'The directory ID.', 'type' => 'string', 'required' => true, 'example' => '399*****488-cn-qingdao', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ParentId' => ['description' => 'The parent directory ID.', 'type' => 'string', 'example' => '399*****774-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Description' => ['description' => 'The directory description.', 'type' => 'string', 'example' => '目录1', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the group that owns the folder.', 'type' => 'string', 'example' => '348*****174-cn-qingdao', 'title' => ''], + 'Name' => ['description' => 'The directory name.', 'type' => 'string', 'example' => '目录1', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the directory was created.', 'type' => 'string', 'example' => '2021-09-10T10:00:00Z', 'title' => ''], + 'Id' => ['description' => 'The directory ID.', 'type' => 'string', 'example' => '399*****488-cn-qingdao', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '32388487739092994-cn-qingdao', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'myGroup', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-qingdao', - ], - ], - [ - 'name' => 'InProtocol', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gb28181', - ], - ], - [ - 'name' => 'OutProtocol', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'flv,rtmp,hls', - ], - ], - [ - 'name' => 'Enabled', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'PushDomain', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'mypush.com', - ], - ], - [ - 'name' => 'PlayDomain', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'myplay.com', - ], - ], - [ - 'name' => 'LazyPull', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'Callback', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://example.com/callback', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '32388487739092994-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ParentId\\": \\"399*****774-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Description\\": \\"目录1\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"Name\\": \\"目录1\\",\\n \\"CreatedTime\\": \\"2021-09-10T10:00:00Z\\",\\n \\"Id\\": \\"399*****488-cn-qingdao\\"\\n}","type":"json"}]', + 'title' => 'Query Folder', + 'summary' => 'Queries a directory.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDirectory'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"32388487739092994-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ModifyGroup', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], 'DescribeGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'Space ID.', 'type' => 'string', 'required' => true, 'example' => '337639*****224964-cn-qingdao', 'title' => ''], ], [ 'name' => 'IncludeStats', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to return the statistics of devices in the group. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -8571,287 +7067,201 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'on', - ], - 'LazyPull' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Callback' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://example.com/callback', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'App' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'live', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'Enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'InProtocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gb28181', - ], - 'OutProtocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'flv,hls,rtmp', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'PushDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'demo.aliyundoc.com', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-02-28T17:00:17Z', - ], - 'PlayDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'GbPort' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5060', - ], - 'GbId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3100000*****0000001', - ], - 'GbIp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.10.10.10', - ], - 'AliasId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '337639*****24964-cn-qingdao', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '337639****224964-cn-qingdao', - ], + 'Status' => ['description' => 'The status of the group.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'LazyPull' => ['description' => 'Indicates whether on-demand stream pulling is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Callback' => ['description' => 'The callback URL that is used to receive device status updates in the group.', 'type' => 'string', 'example' => 'http://example.com/callback', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Description' => ['description' => 'A description of the group.', 'type' => 'string', 'example' => '上海高速监控', 'title' => ''], + 'App' => ['description' => 'The name of the application used by the group.', 'type' => 'string', 'example' => 'live', 'title' => ''], + 'Region' => ['description' => 'The region where the space is located, which is the service center.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the group is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'InProtocol' => ['description' => 'The ingest protocol used by the group. Valid values:'."\n" + ."\n" + .'- gb28181'."\n" + ."\n" + .'- rtmp', 'type' => 'string', 'example' => 'gb28181', 'title' => ''], + 'OutProtocol' => ['description' => 'The streaming protocol used by the group. Valid values:'."\n" + ."\n" + .'- flv'."\n" + ."\n" + .'- hls'."\n" + ."\n" + .'- rtmp'."\n" + ."\n" + .'> You can specify multiple protocols. Separate them with commas (,).', 'type' => 'string', 'example' => 'flv,hls,rtmp', 'title' => ''], + 'Name' => ['description' => 'The name of the space.', 'type' => 'string', 'example' => '上海高速监控', 'title' => ''], + 'PushDomain' => ['description' => 'The ingest domain used by the group.', 'type' => 'string', 'example' => 'demo.aliyundoc.com', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the group was created.', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', 'title' => ''], + 'PlayDomain' => ['description' => 'The streaming domain used by the group.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'GbPort' => ['description' => 'The port of the GB/T 28181 signaling server that is associated with the group.'."\n" + ."\n" + .'> This parameter is returned only for groups that use the GB/T 28181 protocol for stream ingest.', 'type' => 'integer', 'format' => 'int64', 'example' => '5060', 'title' => ''], + 'GbId' => ['description' => 'The GB/T 28181 ID that is associated with the group.'."\n" + ."\n" + .'> This parameter is returned only for groups that use the GB/T 28181 protocol for stream ingest.', 'type' => 'string', 'example' => '3100000*****0000001', 'title' => ''], + 'GbIp' => ['description' => 'The IP address of the GB/T 28181 signaling server that is associated with the group.'."\n" + ."\n" + .'> This parameter is returned only for groups that use the GB/T 28181 protocol for stream ingest.', 'type' => 'string', 'example' => '10.10.10.10', 'title' => ''], + 'AliasId' => ['description' => 'Alias for the space ID.', 'type' => 'string', 'example' => '337639*****24964-cn-qingdao', 'title' => ''], + 'Id' => ['description' => 'The ID of the space.', 'type' => 'string', 'example' => '337639****224964-cn-qingdao', 'title' => ''], 'GbTcpPorts' => [ - 'description' => '', + 'description' => 'The TCP ports of the GB/T 28181 signaling server that are provided by the group.'."\n" + ."\n" + .'> This parameter is returned only for groups that use the GB/T 28181 protocol for stream ingest.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[6060, 6160]', - ], + 'items' => ['description' => 'The TCP ports of the GB/T 28181 signaling server that are provided by the group.'."\n" + ."\n" + .'> This parameter is returned only for groups that use the GB/T 28181 protocol for stream ingest.', 'type' => 'string', 'example' => '[6060, 6160]', 'title' => ''], + 'title' => '', + 'example' => '', ], 'GbUdpPorts' => [ - 'description' => '', + 'description' => 'The UDP ports of the GB/T 28181 signaling server that are provided by the group.'."\n" + ."\n" + .'> This parameter is returned only for groups that use the GB/T 28181 protocol for stream ingest.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'items' => ['description' => 'The UDP ports of the GB/T 28181 signaling server that are provided by the group.'."\n" + ."\n" + .'> This parameter is returned only for groups that use the GB/T 28181 protocol for stream ingest.', 'type' => 'string', 'example' => '['."\n" + .' 5060,'."\n" + .' 5160'."\n" + .']', 'title' => ''], + 'title' => '', + 'example' => '', ], 'Stats' => [ - 'description' => '', + 'description' => 'The statistics of devices in the group.', 'type' => 'object', 'properties' => [ - 'PlatformNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'DeviceNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'IpcNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'IedNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'PlatformNum' => ['description' => 'The number of platforms in the group.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'DeviceNum' => ['description' => 'The total number of devices in the group.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'IpcNum' => ['description' => 'The number of cameras in the group.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'IedNum' => ['description' => 'The number of intelligent electronic devices (IEDs) in the group.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"on\\",\\n \\"LazyPull\\": false,\\n \\"Callback\\": \\"http://example.com/callback\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Description\\": \\"上海高速监控\\",\\n \\"App\\": \\"live\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"Enabled\\": true,\\n \\"InProtocol\\": \\"gb28181\\",\\n \\"OutProtocol\\": \\"flv,hls,rtmp\\",\\n \\"Name\\": \\"上海高速监控\\",\\n \\"PushDomain\\": \\"demo.aliyundoc.com\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"PlayDomain\\": \\"example.aliyundoc.com\\",\\n \\"GbPort\\": 5060,\\n \\"GbId\\": \\"3100000*****0000001\\",\\n \\"GbIp\\": \\"10.10.10.10\\",\\n \\"AliasId\\": \\"337639*****24964-cn-qingdao\\",\\n \\"Id\\": \\"337639****224964-cn-qingdao\\",\\n \\"GbTcpPorts\\": [\\n \\"[6060, 6160]\\"\\n ],\\n \\"GbUdpPorts\\": [\\n \\"[\\\\n 5060,\\\\n 5160\\\\n]\\"\\n ],\\n \\"Stats\\": {\\n \\"PlatformNum\\": 100,\\n \\"DeviceNum\\": 200,\\n \\"IpcNum\\": 100,\\n \\"IedNum\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"on\\",\\n \\"LazyPull\\": false,\\n \\"Callback\\": \\"http://example.com/callback\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Description\\": \\"上海高速监控\\",\\n \\"App\\": \\"live\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"Enabled\\": true,\\n \\"InProtocol\\": \\"gb28181\\",\\n \\"OutProtocol\\": \\"flv,hls,rtmp\\",\\n \\"Name\\": \\"上海高速监控\\",\\n \\"PushDomain\\": \\"demo.aliyundoc.com\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"PlayDomain\\": \\"example.aliyundoc.com\\",\\n \\"GbPort\\": 5060,\\n \\"GbId\\": \\"3100000*****0000001\\",\\n \\"GbIp\\": \\"10.10.10.10\\",\\n \\"AliasId\\": \\"337639*****24964-cn-qingdao\\",\\n \\"Id\\": \\"337639****224964-cn-qingdao\\",\\n \\"GbTcpPorts\\": [\\n \\"[6060, 6160]\\"\\n ],\\n \\"GbUdpPorts\\": [\\n \\"[\\\\n 5060,\\\\n 5160\\\\n]\\"\\n ],\\n \\"Stats\\": {\\n \\"PlatformNum\\": 100,\\n \\"DeviceNum\\": 200,\\n \\"IpcNum\\": 100,\\n \\"IedNum\\": 0\\n }\\n}","type":"json"}]', + 'title' => 'Query workspace', + 'summary' => 'Retrieves information about a space.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeGroups' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeGroups' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '33763950877224964-cn-qingdao', - ], + 'schema' => ['description' => 'The space ID.', 'type' => 'string', 'required' => false, 'example' => '33763950877224964-cn-qingdao', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Space name.', 'type' => 'string', 'required' => false, 'example' => '我的视频监控', 'title' => ''], ], [ 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-qingdao', - ], + 'schema' => ['description' => 'The service region where the group is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao', 'title' => ''], ], [ 'name' => 'InProtocol', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Ingest protocol used by the group. Valid values:'."\n" + ."\n" + .'- gb28181'."\n" + ."\n" + .'- rtmp', + 'enumValueTitles' => ['rtmp' => 'rtmp', 'gb28181' => 'gb28181'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'rtmp' => 'rtmp', - 'gb28181' => 'gb28181', - ], 'example' => 'rtmp', + 'title' => '', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Group status. Valid values:'."\n" + ."\n" + .'- on (enabled)'."\n" + ."\n" + .'- off (disabled)', + 'enumValueTitles' => ['off' => 'disabled', 'on' => 'enabled'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], 'example' => 'on', + 'title' => '', ], ], [ 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Field to sort by. Valid values:'."\n" + ."\n" + .'- Id (default)', 'type' => 'string', 'required' => false, 'example' => 'Id', 'title' => ''], ], [ 'name' => 'SortDirection', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - ], + 'schema' => ['description' => 'Sort order. Valid values:'."\n" + ."\n" + .'- asc (ascending, default)'."\n" + ."\n" + .'- desc (descending)', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'Number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number. Default: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'IncludeStats', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Whether to return device statistics for the group. Default: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -8859,420 +7269,428 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'PageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'PageNum' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'PageSize' => ['description' => 'Number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of groups.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'PageCount' => ['description' => 'Total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'Groups' => [ - 'description' => '', + 'description' => 'List of groups.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'on', - ], - 'LazyPull' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'PlayDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'demo.aliyundoc.com', - ], - 'GbPort' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5060', - ], - 'Callback' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://example.com/callback', - ], - 'GbId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '31000000000000000001', - ], - 'GbIp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.10.10.10', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'App' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'live', - ], - 'AliasId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '337639*****24964-cn-qingdao', - ], - 'Enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'InProtocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gb28181', - ], - 'OutProtocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtmp,flv,hls', - ], - 'PushDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-02-28T17:00:17Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '33763950877224964-cn-qingdao', - ], + 'Status' => ['description' => 'Group status. Valid values:'."\n" + ."\n" + .'- on (enabled)'."\n" + ."\n" + .'- off (disabled)', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'LazyPull' => ['description' => 'Whether on-demand stream pulling is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'PlayDomain' => ['description' => 'Streaming domain used by the group.', 'type' => 'string', 'example' => 'demo.aliyundoc.com', 'title' => ''], + 'GbPort' => ['description' => 'GB signaling server port associated with the group.'."\n" + ."\n" + .'> This applies only to groups that use the GB protocol.', 'type' => 'integer', 'format' => 'int64', 'example' => '5060', 'title' => ''], + 'Callback' => ['description' => 'Callback URL for device status updates in the group.', 'type' => 'string', 'example' => 'http://example.com/callback', 'title' => ''], + 'GbId' => ['description' => 'GB ID provided by the group.'."\n" + ."\n" + .'> This applies only to groups that use the GB protocol.', 'type' => 'string', 'example' => '31000000000000000001', 'title' => ''], + 'GbIp' => ['description' => 'GB signaling server IP address provided by the group.'."\n" + ."\n" + .'> This applies only to groups that use the GB protocol.', 'type' => 'string', 'example' => '10.10.10.10', 'title' => ''], + 'Description' => ['description' => 'Group description.', 'type' => 'string', 'example' => '测试视图计算', 'title' => ''], + 'Region' => ['description' => 'The region where the space is located. This region serves as the service center.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'App' => ['description' => 'Application name used by the group.', 'type' => 'string', 'example' => 'live', 'title' => ''], + 'AliasId' => ['description' => 'Alias for the group ID.', 'type' => 'string', 'example' => '337639*****24964-cn-qingdao', 'title' => ''], + 'Enabled' => ['description' => 'Whether the group is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'InProtocol' => ['description' => 'Ingest protocol used by the group.', 'type' => 'string', 'example' => 'gb28181', 'title' => ''], + 'OutProtocol' => ['description' => 'Playback protocol used by the group.', 'type' => 'string', 'example' => 'rtmp,flv,hls', 'title' => ''], + 'PushDomain' => ['description' => 'Ingest domain used by the group.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'Name' => ['description' => 'Group name.', 'type' => 'string', 'example' => '我的空间', 'title' => ''], + 'CreatedTime' => ['description' => 'Time when the group was created.', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', 'title' => ''], + 'Id' => ['description' => 'Group ID.', 'type' => 'string', 'example' => '33763950877224964-cn-qingdao', 'title' => ''], 'GbTcpPorts' => [ 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[6060,6160]', - ], + 'items' => ['description' => 'TCP ports for the GB signaling server provided by the group.'."\n" + ."\n" + .'> This applies only to groups that use the GB protocol.', 'type' => 'string', 'example' => '[6060,6160]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], 'GbUdpPorts' => [ 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[5060,5160]', - ], + 'items' => ['description' => 'UDP ports for the GB signaling server provided by the group.'."\n" + ."\n" + .'> This applies only to groups that use the GB protocol.', 'type' => 'string', 'example' => '[5060,5160]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], 'Stats' => [ - 'description' => '', + 'description' => 'Device statistics for the group.', 'type' => 'object', 'properties' => [ - 'PlatformNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'DeviceNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'IpcNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'IedNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'PlatformNum' => ['description' => 'Number of platforms in the group.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'DeviceNum' => ['description' => 'Total number of devices in the group.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'IpcNum' => ['description' => 'Number of cameras in the group.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'IedNum' => ['description' => 'Number of intelligent devices in the group.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 5,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 200,\\n \\"PageCount\\": 10,\\n \\"Groups\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"LazyPull\\": false,\\n \\"PlayDomain\\": \\"demo.aliyundoc.com\\",\\n \\"GbPort\\": 5060,\\n \\"Callback\\": \\"http://example.com/callback\\",\\n \\"GbId\\": \\"31000000000000000001\\",\\n \\"GbIp\\": \\"10.10.10.10\\",\\n \\"Description\\": \\"测试视图计算\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"App\\": \\"live\\",\\n \\"AliasId\\": \\"337639*****24964-cn-qingdao\\",\\n \\"Enabled\\": true,\\n \\"InProtocol\\": \\"gb28181\\",\\n \\"OutProtocol\\": \\"rtmp,flv,hls\\",\\n \\"PushDomain\\": \\"example.aliyundoc.com\\",\\n \\"Name\\": \\"我的空间\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Id\\": \\"33763950877224964-cn-qingdao\\",\\n \\"GbTcpPorts\\": [\\n \\"[6060,6160]\\"\\n ],\\n \\"GbUdpPorts\\": [\\n \\"[5060,5160]\\"\\n ],\\n \\"Stats\\": {\\n \\"PlatformNum\\": 0,\\n \\"DeviceNum\\": 200,\\n \\"IpcNum\\": 200,\\n \\"IedNum\\": 0\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 5,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 200,\\n \\"PageCount\\": 10,\\n \\"Groups\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"LazyPull\\": false,\\n \\"PlayDomain\\": \\"demo.aliyundoc.com\\",\\n \\"GbPort\\": 5060,\\n \\"Callback\\": \\"http://example.com/callback\\",\\n \\"GbId\\": \\"31000000000000000001\\",\\n \\"GbIp\\": \\"10.10.10.10\\",\\n \\"Description\\": \\"测试视图计算\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"App\\": \\"live\\",\\n \\"AliasId\\": \\"337639*****24964-cn-qingdao\\",\\n \\"Enabled\\": true,\\n \\"InProtocol\\": \\"gb28181\\",\\n \\"OutProtocol\\": \\"rtmp,flv,hls\\",\\n \\"PushDomain\\": \\"example.aliyundoc.com\\",\\n \\"Name\\": \\"我的空间\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Id\\": \\"33763950877224964-cn-qingdao\\",\\n \\"GbTcpPorts\\": [\\n \\"[6060,6160]\\"\\n ],\\n \\"GbUdpPorts\\": [\\n \\"[5060,5160]\\"\\n ],\\n \\"Stats\\": {\\n \\"PlatformNum\\": 0,\\n \\"DeviceNum\\": 200,\\n \\"IpcNum\\": 200,\\n \\"IedNum\\": 0\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query space list', + 'summary' => 'You can query the list of spaces.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroups'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeParentPlatform' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'required' => true, 'example' => '359*****374-cn-qingdao', 'title' => ''], ], - [ - 'name' => 'Description', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the parent platform. Valid values:'."\n" + .'- on (online)'."\n" + .'- off (offline)'."\n" + .'- failed (failed)', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'ClientPort' => ['description' => 'The local SIP service port.', 'type' => 'integer', 'format' => 'int64', 'example' => '5160', 'title' => ''], + 'ClientGbId' => ['description' => 'The local GB ID.', 'type' => 'string', 'example' => '31010*****317542006', 'title' => ''], + 'Protocol' => ['description' => 'The protocol of the parent platform. Valid values:'."\n" + .'- gb28181 (GB standard)', 'type' => 'string', 'example' => 'gb28181', 'title' => ''], + 'Ip' => ['description' => 'The SIP service IP address of the parent platform.', 'type' => 'string', 'example' => '10.10.10.10', 'title' => ''], + 'Port' => ['description' => 'The SIP service port of the parent platform.', 'type' => 'integer', 'format' => 'int64', 'example' => '5060', 'title' => ''], + 'ClientPassword' => ['description' => 'The local password.', 'type' => 'string', 'example' => 'admin123', 'title' => ''], + 'ClientUsername' => ['description' => 'The local username.', 'type' => 'string', 'example' => 'user01', 'title' => ''], + 'AutoStart' => ['description' => 'Specifies whether to enable the parent platform automatically. Valid values:'."\n" + .'- false (default)'."\n" + .'- true', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ClientAuth' => ['description' => 'Specifies whether to enable local authentication. Valid values:'."\n" + .'- true (default)'."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'GbId' => ['description' => 'The GB ID of the parent platform.', 'type' => 'string', 'example' => '31000*****2170123451', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Description' => ['description' => 'The description of the parent platform.', 'type' => 'string', 'example' => '级联平台描述', 'title' => ''], + 'ClientIp' => ['description' => 'The local SIP service IP address.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], + 'Name' => ['description' => 'The name of the parent platform.', 'type' => 'string', 'example' => '国标级联平台测试', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the parent platform was created.', 'type' => 'string', 'example' => '2018-12-10T21:00:00Z', 'title' => ''], + 'Id' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'example' => '359*****374-cn-qingdao', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', ], ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****174-cn-qingdao', + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"on\\",\\n \\"ClientPort\\": 5160,\\n \\"ClientGbId\\": \\"31010*****317542006\\",\\n \\"Protocol\\": \\"gb28181\\",\\n \\"Ip\\": \\"10.10.10.10\\",\\n \\"Port\\": 5060,\\n \\"ClientPassword\\": \\"admin123\\",\\n \\"ClientUsername\\": \\"user01\\",\\n \\"AutoStart\\": false,\\n \\"ClientAuth\\": true,\\n \\"GbId\\": \\"31000*****2170123451\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Description\\": \\"级联平台描述\\",\\n \\"ClientIp\\": \\"192.168.0.1\\",\\n \\"Name\\": \\"国标级联平台测试\\",\\n \\"CreatedTime\\": \\"2018-12-10T21:00:00Z\\",\\n \\"Id\\": \\"359*****374-cn-qingdao\\"\\n}","type":"json"}]', + 'title' => 'Query parent platform', + 'summary' => 'Queries information about a parent platform.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParentPlatform'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeParentPlatform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeParentPlatformDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ParentId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '399*****774-cn-qingdao', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'DirectoryId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '399*****488-cn-qingdao', - ], + 'schema' => ['description' => 'Query by parent platform ID.', 'type' => 'string', 'required' => true, 'example' => '359*****374-cn-qingdao', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ipc', - ], + 'schema' => ['description' => 'Sort by the specified field. Sorted by id by default.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], ], [ - 'name' => 'AutoStart', + 'name' => 'SortDirection', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Sort order. Ascending by default. Valid values:'."\n" + .'- asc (ascending)'."\n" + .'- desc (descending)', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], [ - 'name' => 'GbId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '31000000****00000002', - ], + 'schema' => ['description' => 'The page size. Default value: 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'Ip', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10.10.10.10', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], - [ - 'name' => 'Port', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of devices.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Devices' => [ + 'description' => 'The list of devices.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentId' => ['description' => 'The parent device ID.', 'type' => 'string', 'example' => '3614*****766212-cn-qingdao', 'title' => ''], + 'GbId' => ['description' => 'The GB ID of the device.', 'type' => 'string', 'example' => '310101*****7542007', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the space to which the device belongs.', 'type' => 'string', 'example' => '3484*****8732174-cn-qingdao', 'title' => ''], + 'Name' => ['description' => 'The name of the device.', 'type' => 'string', 'example' => '测试设备1', 'title' => ''], + 'Id' => ['description' => 'The device ID.', 'type' => 'string', 'example' => '3487*****323380-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8080', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Url', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rtmp://xxx/xxx', + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 1,\\n \\"PageCount\\": 1,\\n \\"Devices\\": [\\n {\\n \\"ParentId\\": \\"3614*****766212-cn-qingdao\\",\\n \\"GbId\\": \\"310101*****7542007\\",\\n \\"GroupId\\": \\"3484*****8732174-cn-qingdao\\",\\n \\"Name\\": \\"测试设备1\\",\\n \\"Id\\": \\"3487*****323380-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the list of devices under a parent platform', + 'summary' => 'Queries the list of devices under a parent platform.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParentPlatformDevices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeParentPlatformDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeParentPlatforms' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Username', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'admin', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'Password', + 'name' => 'GbId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'admin', - ], + 'schema' => ['description' => 'Query by the GB ID of the parent platform.', 'type' => 'string', 'required' => false, 'example' => '31000*****2170123451', 'title' => ''], ], [ - 'name' => 'Vendor', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Query by the status of the parent platform.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], ], [ - 'name' => 'Dsn', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '7D0*****4C0', - ], + 'schema' => ['description' => 'Sort by the specified field. Sorted by id by default.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], ], [ - 'name' => 'Longitude', + 'name' => 'SortDirection', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '45.00', - ], + 'schema' => ['description' => 'Sort order. Ascending by default. Valid values:'."\n" + .'- asc (ascending)'."\n" + .'- desc (descending)', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], [ - 'name' => 'Latitude', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '119.20', - ], + 'schema' => ['description' => 'Page size. Default value is 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'AutoPos', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Page number. Default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], - [ - 'name' => 'PosInterval', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300', + 'type' => 'object', + 'properties' => [ + 'PageNum' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of parent platforms.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageCount' => ['description' => 'Total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Platforms' => [ + 'description' => 'List of parent platforms.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Parent platform status. Valid values:'."\n" + .'- on (online)'."\n" + .'- off (offline)'."\n" + .'- failed (failed)', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'ClientPort' => ['description' => 'Local SIP service port.', 'type' => 'integer', 'format' => 'int64', 'example' => '5160', 'title' => ''], + 'Protocol' => ['description' => 'Parent platform protocol. Valid values:'."\n" + .'- gb28181 (GB standard)', 'type' => 'string', 'example' => 'gb28181', 'title' => ''], + 'ClientGbId' => ['description' => 'Local GB ID.', 'type' => 'string', 'example' => '31010*****317542006', 'title' => ''], + 'Ip' => ['description' => 'Parent platform SIP service IP.', 'type' => 'string', 'example' => '10.10.10.10', 'title' => ''], + 'Port' => ['description' => 'Parent platform SIP service port.', 'type' => 'integer', 'format' => 'int64', 'example' => '5060', 'title' => ''], + 'ClientUsername' => ['description' => 'Local username.', 'type' => 'string', 'example' => 'user01', 'title' => ''], + 'ClientPassword' => ['description' => 'Local password.', 'type' => 'string', 'example' => 'admin123', 'title' => ''], + 'AutoStart' => ['description' => 'Whether to enable automatically. Valid values:'."\n" + .'- false (default)'."\n" + .'- true', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ClientAuth' => ['description' => 'Whether to enable local authentication. Valid values:'."\n" + .'- true (default)'."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'GbId' => ['description' => 'Parent platform GB ID.', 'type' => 'string', 'example' => '31000*****2170123451', 'title' => ''], + 'Description' => ['description' => 'Parent platform description.', 'type' => 'string', 'example' => '国标级联平台描述', 'title' => ''], + 'ClientIp' => ['description' => 'Local SIP service IP.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], + 'Name' => ['description' => 'Parent platform name.', 'type' => 'string', 'example' => '国标级联平台测试', 'title' => ''], + 'CreatedTime' => ['description' => 'Parent platform creation time.', 'type' => 'string', 'example' => '2018-12-10T21:00:00Z', 'title' => ''], + 'Id' => ['description' => 'Parent platform ID.', 'type' => 'string', 'example' => '359*****374-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'AlarmMethod', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 1,\\n \\"PageCount\\": 1,\\n \\"Platforms\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"ClientPort\\": 5160,\\n \\"Protocol\\": \\"gb28181\\",\\n \\"ClientGbId\\": \\"31010*****317542006\\",\\n \\"Ip\\": \\"10.10.10.10\\",\\n \\"Port\\": 5060,\\n \\"ClientUsername\\": \\"user01\\",\\n \\"ClientPassword\\": \\"admin123\\",\\n \\"AutoStart\\": false,\\n \\"ClientAuth\\": true,\\n \\"GbId\\": \\"31000*****2170123451\\",\\n \\"Description\\": \\"国标级联平台描述\\",\\n \\"ClientIp\\": \\"192.168.0.1\\",\\n \\"Name\\": \\"国标级联平台测试\\",\\n \\"CreatedTime\\": \\"2018-12-10T21:00:00Z\\",\\n \\"Id\\": \\"359*****374-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the list of parent platforms', + 'summary' => 'Query the list of parent platforms.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParentPlatforms'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeParentPlatforms', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribePresets' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'Params', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], ], 'responses' => [ @@ -9280,53 +7698,71 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9FE0CA83-BFD3-4EBD-A429-FABB9B9AE772', 'title' => ''], + 'Presets' => [ + 'description' => 'List of presets.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'Preset name.', 'type' => 'string', 'example' => '预置位2', 'title' => ''], + 'Id' => ['description' => 'Preset ID.', 'type' => 'string', 'example' => '2', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"9FE0CA83-BFD3-4EBD-A429-FABB9B9AE772\\",\\n \\"Presets\\": [\\n {\\n \\"Name\\": \\"预置位2\\",\\n \\"Id\\": \\"2\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Presets', + 'summary' => 'Retrieve the list of presets.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePresets'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribePresets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribePublishStreamStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3238848****092996', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -9334,44 +7770,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'Code' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteDevice', - ], - 'BatchDeleteDevices' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePublishStreamStatus'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": 0,\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'DescribePurchasedDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '32388****39092996', - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '3614*****66212-cn-qingdao', 'title' => ''], ], ], 'responses' => [ @@ -9379,267 +7813,1500 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Device not found', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323884****9092996', - ], - ], - ], - ], + 'Type' => ['description' => 'Device type. Valid values:'."\n" + ."\n" + .'- ipc (camera)'."\n" + ."\n" + .'- platform'."\n" + ."\n" + .'- ied (intelligent device)', 'type' => 'string', 'example' => 'ipc', 'title' => ''], + 'SubType' => ['description' => 'Device child type. Valid values:'."\n" + ."\n" + .'- bullet (bullet camera)'."\n" + ."\n" + .'- dome (dome camera)'."\n" + ."\n" + .'- ptz (PTZ)', 'type' => 'string', 'example' => 'dome', 'title' => ''], + 'Vendor' => ['description' => 'Device vendor.', 'type' => 'string', 'example' => '8yd*****qem', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Description' => ['description' => 'Device description.', 'type' => 'string', 'example' => 'xxx路口摄像头', 'title' => ''], + 'RegisterCode' => ['description' => 'Device registration code.', 'type' => 'string', 'example' => '12345*****67890', 'title' => ''], + 'GroupId' => ['description' => 'Space ID.', 'type' => 'string', 'example' => '348*****174-cn-qingdao', 'title' => ''], + 'GroupName' => ['description' => 'Space name.', 'type' => 'string', 'example' => '测试空间', 'title' => ''], + 'Region' => ['description' => 'Region where the space belongs, also known as the service center.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'Name' => ['description' => 'Device name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CreatedTime' => ['description' => 'Device creation time.', 'type' => 'string', 'example' => '2018-12-10T21:00:00Z', 'title' => ''], + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '33763****77224964-cn-qingdao', 'title' => ''], + 'OrderId' => ['description' => 'Order ID.', 'type' => 'string', 'example' => '2117*****0447', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"Device not found\\",\\n \\"Id\\": \\"323884****9092996\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchDeleteDevices', - ], - 'ModifyDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Type\\": \\"ipc\\",\\n \\"SubType\\": \\"dome\\",\\n \\"Vendor\\": \\"8yd*****qem\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Description\\": \\"xxx路口摄像头\\",\\n \\"RegisterCode\\": \\"12345*****67890\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"GroupName\\": \\"测试空间\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"Name\\": \\"test\\",\\n \\"CreatedTime\\": \\"2018-12-10T21:00:00Z\\",\\n \\"Id\\": \\"33763****77224964-cn-qingdao\\",\\n \\"OrderId\\": \\"2117*****0447\\"\\n}","type":"json"}]', + 'title' => 'Query purchased devices', + 'summary' => 'Queries information about purchased devices.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribePurchasedDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribePurchasedDevices' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], + 'schema' => ['description' => 'Queries by device ID.', 'type' => 'string', 'required' => false, 'example' => '4070*****1132-cn-qingdao', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Queries by device name.', 'type' => 'string', 'required' => false, 'example' => 'xxx路口摄像头', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Queries by device type. Valid values:'."\n" + ."\n" + .'- ipc (camera)'."\n" + ."\n" + .'- platform (platform)'."\n" + ."\n" + .'- ied (intelligent edge device)', 'type' => 'string', 'required' => false, 'example' => 'ipc', 'title' => ''], + ], + [ + 'name' => 'SubType', + 'in' => 'query', + 'schema' => ['description' => 'Queries by device subtype. Valid values:'."\n" + ."\n" + .'- bullet (bullet camera)'."\n" + ."\n" + .'- dome (dome camera)'."\n" + ."\n" + .'- ptz (PTZ camera)', 'type' => 'string', 'required' => false, 'example' => 'dome', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '348*****174-cn-qingdao', - ], + 'schema' => ['description' => 'Queries by the ID of the group to which the device belongs.', 'type' => 'string', 'required' => false, 'example' => '348*****174-cn-qingdao', 'title' => ''], ], [ - 'name' => 'ParentId', + 'name' => 'Vendor', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '399*****774-cn-qingdao', - ], + 'schema' => ['description' => 'Queries by device vendor.', 'type' => 'string', 'required' => false, 'example' => '公司A', 'title' => ''], ], [ - 'name' => 'DirectoryId', + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort by. Valid value:'."\n" + ."\n" + .'- id (default)', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], + ], + [ + 'name' => 'SortDirection', + 'in' => 'query', + 'schema' => ['description' => 'The sorting order. The default is ascending. Valid values:'."\n" + ."\n" + .'- asc (ascending)'."\n" + ."\n" + .'- desc (descending)', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. The default is 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNum', 'in' => 'query', + 'schema' => ['description' => 'The page number. The default is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of devices.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Devices' => [ + 'description' => 'The list of devices.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The device type. Valid values:'."\n" + ."\n" + .'- ipc (camera)'."\n" + ."\n" + .'- platform (platform)'."\n" + ."\n" + .'- ied (intelligent edge device)', 'type' => 'string', 'example' => 'ipc', 'title' => ''], + 'SubType' => ['description' => 'The device subtype. Valid values:'."\n" + ."\n" + .'- bullet (bullet camera)'."\n" + ."\n" + .'- dome (dome camera)'."\n" + ."\n" + .'- ptz (PTZ camera)', 'type' => 'string', 'example' => 'dome', 'title' => ''], + 'Vendor' => ['description' => 'The device vendor.', 'type' => 'string', 'example' => '公司A', 'title' => ''], + 'Description' => ['description' => 'The device description.', 'type' => 'string', 'example' => 'xxx路口摄像头', 'title' => ''], + 'RegisterCode' => ['description' => 'The device registration code.', 'type' => 'string', 'example' => '1234*****67890', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the group to which the device belongs.', 'type' => 'string', 'example' => '348*****174-cn-qingdao', 'title' => ''], + 'GroupName' => ['description' => 'Group name.', 'type' => 'string', 'example' => '测试空间', 'title' => ''], + 'Region' => ['description' => 'The region to which the space belongs. This is the service center.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'Name' => ['description' => 'The device name.', 'type' => 'string', 'example' => 'xxx路口摄像头', 'title' => ''], + 'CreatedTime' => ['description' => 'The time the device was created.', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', 'title' => ''], + 'Id' => ['description' => 'The device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '2117*****0447', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '399*****488-cn-qingdao', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 1,\\n \\"PageCount\\": 1,\\n \\"Devices\\": [\\n {\\n \\"Type\\": \\"ipc\\",\\n \\"SubType\\": \\"dome\\",\\n \\"Vendor\\": \\"公司A\\",\\n \\"Description\\": \\"xxx路口摄像头\\",\\n \\"RegisterCode\\": \\"1234*****67890\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"GroupName\\": \\"测试空间\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"Name\\": \\"xxx路口摄像头\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"OrderId\\": \\"2117*****0447\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query purchased device list', + 'summary' => 'Queries the list of purchased devices.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedDevices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribePurchasedDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeRecords' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The type of the recording record to query. Valid values:'."\n" + ."\n" + .'- record (Recording)'."\n" + ."\n" + .'- snapshot', + 'enumValueTitles' => ['record' => 'record', 'snapshot' => 'snapshot'], 'type' => 'string', - 'required' => false, - 'example' => 'ipc', + 'required' => true, + 'example' => 'record', + 'title' => '', ], ], [ - 'name' => 'AutoStart', + 'name' => 'StreamId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Query by stream ID.', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', 'title' => ''], ], [ - 'name' => 'GbId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3100000****000000002', - ], + 'schema' => ['description' => 'Query records by start time.', 'type' => 'string', 'required' => true, 'example' => '2021-11-22T00:00:00Z', 'title' => ''], ], [ - 'name' => 'Ip', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10.10.10.10', - ], + 'schema' => ['description' => 'Specify the end time for the query.', 'type' => 'string', 'required' => true, 'example' => '2021-11-24T00:00:00Z', 'title' => ''], ], [ - 'name' => 'Port', + 'name' => 'PrivateBucket', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8080', - ], + 'schema' => ['description' => 'Specifies whether to use a private bucket.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Url', + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort the records by. Valid value:'."\n" + ."\n" + .'- Id (default)', 'type' => 'string', 'required' => false, 'example' => 'Id', 'title' => ''], + ], + [ + 'name' => 'SortDirection', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The sorting method. Valid values:'."\n" + ."\n" + .'- asc (ascending, default)'."\n" + ."\n" + .'- desc (descending)', + 'enumValueTitles' => ['asc' => 'asc', 'desc' => 'desc'], 'type' => 'string', 'required' => false, - 'example' => 'rtmp://xxx/xxx', + 'example' => 'asc', + 'title' => '', ], ], [ - 'name' => 'Username', + 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => 'Page size. Default value: 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNum' => ['description' => 'The page number.'."\n" + ."\n" + .'> Applies only to recording queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'NextStartTime' => ['description' => 'The start time to query the next record.'."\n" + ."\n" + .'> Applies only to snapshot queries.', 'type' => 'string', 'example' => '2018-12-10T11:00:00Z', 'title' => ''], + 'PageSize' => ['description' => 'The page size.'."\n" + ."\n" + .'> Applies only to recording queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of stored records.'."\n" + ."\n" + .'> Applies only to recording queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'PageCount' => ['description' => 'The total number of pages.'."\n" + ."\n" + .'> Applies only to recording queries.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'Records' => [ + 'description' => 'The list of stored records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the stored record. Valid values:'."\n" + ."\n" + .'- record'."\n" + ."\n" + .'- snapshot', 'type' => 'string', 'example' => 'record', 'title' => ''], + 'Height' => ['description' => 'The height.', 'type' => 'integer', 'format' => 'int64', 'example' => '1080', 'title' => ''], + 'Url' => ['description' => 'The URL of the stored file.', 'type' => 'string', 'example' => 'http://my_oss_bucket.oss-cn-qingdao.aliyuncs.com/record/live/310*****007/2021-11-23-18-19-38_2021-11-23-18-33-48.m3u8', 'title' => ''], + 'OssBucket' => ['description' => 'The bucket where the file is stored.', 'type' => 'string', 'example' => 'my_oss_bucket', 'title' => ''], + 'FileFormat' => ['description' => 'The format of the stored file. Valid values:'."\n" + ."\n" + .'- mp4'."\n" + ."\n" + .'- flv'."\n" + ."\n" + .'- hls'."\n" + ."\n" + .'- jpg', 'type' => 'string', 'example' => 'hls', 'title' => ''], + 'StreamId' => ['description' => 'The stream ID.', 'type' => 'string', 'example' => '323*****997-cn-qingdao', 'title' => ''], + 'OssObject' => ['description' => 'The object of the stored file.', 'type' => 'string', 'example' => 'record/live/310*****007/2021-11-23-18-19-38_2021-11-23-18-33-48.m3u8', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the stored record.', 'type' => 'string', 'example' => '2021-11-23T18:33:48', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the stored record.', 'type' => 'string', 'example' => '2021-11-23T18:19:32', 'title' => ''], + 'Width' => ['description' => 'The width.', 'type' => 'integer', 'format' => 'int64', 'example' => '1920', 'title' => ''], + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '388*****204-cn-qingdao', 'title' => ''], + 'Id' => ['description' => 'The ID of the stored record.'."\n" + ."\n" + .'> Applies only to recording queries.', 'type' => 'string', 'example' => '2be2a673-6033-4874-b6f2-f2bc0a1*****', 'title' => ''], + 'OssEndpoint' => ['description' => 'The OSS endpoint.', 'type' => 'string', 'example' => 'oss-cn-qingdao.aliyuncs.com', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"NextStartTime\\": \\"2018-12-10T11:00:00Z\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 5,\\n \\"Records\\": [\\n {\\n \\"Type\\": \\"record\\",\\n \\"Height\\": 1080,\\n \\"Url\\": \\"http://my_oss_bucket.oss-cn-qingdao.aliyuncs.com/record/live/310*****007/2021-11-23-18-19-38_2021-11-23-18-33-48.m3u8\\",\\n \\"OssBucket\\": \\"my_oss_bucket\\",\\n \\"FileFormat\\": \\"hls\\",\\n \\"StreamId\\": \\"323*****997-cn-qingdao\\",\\n \\"OssObject\\": \\"record/live/310*****007/2021-11-23-18-19-38_2021-11-23-18-33-48.m3u8\\",\\n \\"EndTime\\": \\"2021-11-23T18:33:48\\",\\n \\"StartTime\\": \\"2021-11-23T18:19:32\\",\\n \\"Width\\": 1920,\\n \\"TemplateId\\": \\"388*****204-cn-qingdao\\",\\n \\"Id\\": \\"2be2a673-6033-4874-b6f2-f2bc0a1*****\\",\\n \\"OssEndpoint\\": \\"oss-cn-qingdao.aliyuncs.com\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the list of recording records ', + 'summary' => 'Queries a list of recordings.', + 'description' => '> Paging is not supported for snapshot queries. Only iteration is supported. To request the next page, use the NextStartTime value from the response as the StartTime for the new request.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRecords'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeRenderingInstance' => [ + 'summary' => 'Queries the details of a cloud application service instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199425', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], + 'parameters' => [ + [ + 'name' => 'RenderingInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the rendering instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'RenderingInstanceId' => ['description' => 'The ID of the rendering instance.', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], + 'CreationTime' => ['description' => 'The instance creation time, in UTC (ISO 8601).', 'type' => 'string', 'title' => '', 'example' => '2024-05-07T02:27:06Z'], + 'SystemInfo' => [ + 'description' => 'The system information of the rendering instance, such as its resolution.', + 'type' => 'object', + 'properties' => [ + 'Resolution' => ['description' => 'The resolution. Valid values:'."\n" + ."\n" + .'- `1920*864`'."\n" + ."\n" + .'- `1080*1920`'."\n" + ."\n" + .'- `1920*1080`'."\n" + ."\n" + .'- `720*1280`'."\n" + ."\n" + .'- `2400*1080`'."\n" + ."\n" + .'- `1080*2400`'."\n" + ."\n" + .'- `1280*720`'."\n" + ."\n" + .'- `864*1920`', 'type' => 'string', 'example' => '1920*1080', 'title' => ''], + 'Frequency' => ['description' => 'The refresh rate of the instance, in Hz.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RenderingStatus' => [ + 'title' => '', + 'description' => 'The operational status of the rendering instance.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The operational status of the instance. Valid values:'."\n" + ."\n" + .'1. `Preparing`: The instance is being initialized.'."\n" + ."\n" + .'2. `Rebooting`: The instance is rebooting.'."\n" + ."\n" + .'3. `Resetting`: The instance is being reset.'."\n" + ."\n" + .'4. `Working`: The instance is running normally. This is a terminal state.'."\n" + ."\n" + .'5. `Failure`: The instance has failed to start or operate. This is a terminal state.', 'type' => 'string', 'title' => '', 'example' => 'Working'], + 'LatestAction' => ['description' => 'The name of the last action performed on the instance.', 'type' => 'string', 'title' => '', 'example' => 'MigrateLocalData'], + 'Description' => ['description' => 'Additional details about the current status.', 'type' => 'string', 'title' => '', 'example' => '工作中'], + ], + 'example' => '', + ], + 'ConfigInfo' => [ + 'title' => '', + 'description' => 'The configuration information of the rendering instance.', + 'type' => 'object', + 'properties' => [ + 'NetworkConfig' => [ + 'title' => '', + 'description' => 'Ingress and egress bandwidth limits, in Mbps.', + 'type' => 'object', + 'properties' => [ + 'MaxIngressBandwidth' => ['description' => 'The maximum ingress bandwidth, in Mbps. A value of 0 indicates no limit.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'MaxEgressBandwidth' => ['description' => 'The maximum egress bandwidth, in Mbps. A value of 0 indicates no limit.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'BandwidthStatus' => ['description' => 'The status of the bandwidth configuration. Valid values:'."\n" + ."\n" + .'1. `waiting`: The configuration is being applied.'."\n" + ."\n" + .'2. `success`: The configuration change is complete.'."\n" + ."\n" + .'3. `failed`: The configuration change failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'UpdateTime' => ['description' => 'The time the configuration was last updated.', 'type' => 'string', 'example' => '2023-08-17T09:54:35Z', 'title' => ''], + ], + 'example' => '', + ], + 'Configuration' => [ + 'title' => '', + 'description' => 'A list of configured physical device simulation modules.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a physical device simulation module.', + 'type' => 'object', + 'properties' => [ + 'ModuleName' => ['description' => 'The name of the physical device simulation module. Valid values:'."\n" + ."\n" + .'1. `ctl`: Control module'."\n" + ."\n" + .'2. `prop`: Property module'."\n" + ."\n" + .'3. `location`: Location module'."\n" + ."\n" + .'4. `battery`: Battery module'."\n" + ."\n" + .'5. `network`: Network module'."\n" + ."\n" + .'6. `bluetooth`: Bluetooth module'."\n" + ."\n" + .'7. `sim`: SIM card module'."\n" + ."\n" + .'8. `display`: Display module'."\n" + ."\n" + .'9. `system`: System module', 'type' => 'string', 'example' => 'location', 'title' => ''], + 'Attributes' => [ + 'title' => '', + 'description' => 'A list of attributes.', + 'type' => 'array', + 'items' => [ + 'description' => 'Attribute details.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The value of the attribute.', 'type' => 'any', 'example' => '100', 'title' => ''], + 'Name' => ['description' => 'The name of the attribute.', 'type' => 'string', 'example' => 'lon', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Hostname' => ['description' => 'The domain name or access IP address of the rendering instance.', 'type' => 'string', 'title' => '', 'example' => 'cn-xxx.ecr.aliyuncs.com'], + 'Isp' => ['title' => 'Carrier encoding. Valid values: '."\n" + .'1. cmcc '."\n" + .'2. unicom '."\n" + .'3. telecom ', 'description' => 'The ISP code. Valid values:'."\n" + ."\n" + .'1. `cmcc`'."\n" + ."\n" + .'2. `unicom`'."\n" + ."\n" + .'3. `telecom`', 'type' => 'string', 'example' => 'telecom'], + 'PortMappings' => [ + 'title' => '', + 'description' => 'A list of port mappings.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the port mapping.', + 'type' => 'object', + 'properties' => [ + 'ExternalPort' => ['description' => 'The external port or port range, such as `22`. For a port range, use a forward slash (`/`) to separate the start and end ports, for example, `10/20`.', 'type' => 'string', 'title' => '', 'example' => '10013/10020'], + 'InternalPort' => ['description' => 'The internal port or port range. The ports correspond one-to-one with the external ports. For a port range, use a forward slash (`/`) to separate the start and end ports, for example, `10/20`.', 'type' => 'string', 'title' => '', 'example' => '49008/49015'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'RenderingSpec' => ['description' => 'The specification of the rendering instance.', 'type' => 'string', 'example' => 'crs.cp.l1', 'title' => ''], + 'StorageSize' => ['description' => 'The storage capacity of the rendering instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'EgressIp' => ['title' => 'Egress IP ', 'description' => 'The egress IP address.', 'type' => 'string', 'example' => '1.1.8.8'], + 'AdditionalIngresses' => [ + 'description' => 'A list of optional ingress network information.', + 'title' => 'Additional optional ingress network information ', + 'type' => 'array', + 'items' => [ + 'description' => 'Optional ingress network information.', + 'type' => 'object', + 'properties' => [ + 'Hostname' => ['title' => 'Domain name or IP address of the cloud application service instance ', 'description' => 'The domain name or IP address of the rendering instance.', 'type' => 'string', 'example' => '101.66.165.213'], + 'Isp' => ['title' => 'Carrier encoding. Valid values:'."\n" + .'1. cmcc'."\n" + .'2. unicom'."\n" + .'3. telecom', 'description' => 'The ISP code. Valid values:'."\n" + ."\n" + .'1. `cmcc`'."\n" + ."\n" + .'2. `unicom`'."\n" + ."\n" + .'3. `telecom`', 'type' => 'string', 'example' => 'cmcc'], + 'PortMappings' => [ + 'description' => 'A list of port mappings.', + 'title' => 'List of port mappings', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the port mapping.', + 'type' => 'object', + 'properties' => [ + 'ExternalPort' => ['title' => 'Public network port or port range, such as 22. If it is a port range, separate the start and end ports with a forward slash (/), for example, 10/20.', 'description' => 'The external port or port range, such as `22`. For a port range, use a forward slash (`/`) to separate the start and end ports, for example, `10/20`.', 'type' => 'string', 'example' => '12500/12519'], + 'InternalPort' => ['title' => 'Private network port or port range, which corresponds one-to-one with the public network port. If it is a port range, separate the start and end ports with a forward slash (/), for example, 10/20.', 'description' => 'The internal port or port range. The ports correspond one-to-one with the external ports. For a port range, use a forward slash (`/`) to separate the start and end ports, for example, `10/20`.', 'type' => 'string', 'example' => '11120/11139'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'InternalIp' => ['description' => 'The internal IP address.', 'type' => 'string', 'example' => '10.1.17.32', 'title' => ''], + 'ResourceAttributes' => [ + 'description' => 'The attributes of the rendering instance.', + 'title' => 'Attribute information of the cloud application service instance ', + 'type' => 'object', + 'properties' => [ + 'Zone' => [ + 'title' => 'Resource domain. Valid values: Private, Public ', + 'description' => 'The resource zone. Valid values: `Private` and `Public`.', + 'type' => 'string', + 'example' => 'Public', + 'enum' => ['Private', 'Public'], + ], + 'OutAccess' => [ + 'title' => 'Outbound access configuration. Valid values: '."\n" + .'1. ON: Enabled. The resource can access the Internet. '."\n" + .'2. OFF: Shutdown. ', + 'description' => 'The egress network access configuration. Valid values:'."\n" + ."\n" + .'1. `ON`: Enabled. The rendering instance can access the public internet.'."\n" + ."\n" + .'2. `OFF`: Disabled.', + 'type' => 'string', + 'example' => 'ON', + 'enum' => ['ON', 'OFF'], + ], + 'InAccess' => [ + 'title' => 'Inbound access configuration. Valid values: '."\n" + .'1. ON: Enabled. The resource can be accessed externally. '."\n" + .'2. OFF: Shutdown. ', + 'description' => 'The ingress network access configuration. Valid values:'."\n" + ."\n" + .'1. `ON`: Enabled. The rendering instance can be accessed from the public internet.'."\n" + ."\n" + .'2. `OFF`: Disabled.', + 'type' => 'string', + 'example' => 'ON', + 'enum' => ['ON', 'OFF'], + ], + 'EdgeMediaService' => [ + 'title' => 'Streaming service. Valid values: '."\n" + .'1. ON: Enabled. '."\n" + .'2. OFF: Shutdown. ', + 'description' => 'The configuration of the edge media service. Valid values:'."\n" + ."\n" + .'1. `ON`: Enabled.'."\n" + ."\n" + .'2. `OFF`: Disabled.', + 'type' => 'string', + 'example' => 'ON', + 'enum' => ['ON', 'OFF'], + ], + ], + 'example' => '', + ], + 'InstanceChargeType' => ['title' => 'Instance billing type ', 'description' => 'The billing method of the instance.', 'type' => 'string', 'example' => 'PostPaid'], + 'ResourceStatus' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The running status of the computing resource. Valid values:'."\n" + ."\n" + .'1. `running`: The edge instance is running normally.'."\n" + ."\n" + .'2. `operating`: The edge instance is under maintenance.'."\n" + ."\n" + .'3. `error`: An exception is detected on the edge instance.', + 'type' => 'string', + 'example' => 'running', + 'enum' => ['running', 'error', 'operating'], + 'title' => '', + ], + ], + 'title' => '', + 'description' => 'The status of the underlying computing resource.', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"CreationTime\\": \\"2024-05-07T02:27:06Z\\",\\n \\"SystemInfo\\": {\\n \\"Resolution\\": \\"1920*1080\\",\\n \\"Frequency\\": 60\\n },\\n \\"RenderingStatus\\": {\\n \\"Status\\": \\"Working\\",\\n \\"LatestAction\\": \\"MigrateLocalData\\",\\n \\"Description\\": \\"工作中\\"\\n },\\n \\"ConfigInfo\\": {\\n \\"NetworkConfig\\": {\\n \\"MaxIngressBandwidth\\": 100,\\n \\"MaxEgressBandwidth\\": 100,\\n \\"BandwidthStatus\\": \\"success\\",\\n \\"UpdateTime\\": \\"2023-08-17T09:54:35Z\\"\\n },\\n \\"Configuration\\": [\\n {\\n \\"ModuleName\\": \\"location\\",\\n \\"Attributes\\": [\\n {\\n \\"Value\\": \\"100\\",\\n \\"Name\\": \\"lon\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Hostname\\": \\"cn-xxx.ecr.aliyuncs.com\\",\\n \\"Isp\\": \\"telecom\\",\\n \\"PortMappings\\": [\\n {\\n \\"ExternalPort\\": \\"10013/10020\\",\\n \\"InternalPort\\": \\"49008/49015\\"\\n }\\n ],\\n \\"RenderingSpec\\": \\"crs.cp.l1\\",\\n \\"StorageSize\\": 20,\\n \\"EgressIp\\": \\"1.1.8.8\\",\\n \\"AdditionalIngresses\\": [\\n {\\n \\"Hostname\\": \\"101.66.165.213\\",\\n \\"Isp\\": \\"cmcc\\",\\n \\"PortMappings\\": [\\n {\\n \\"ExternalPort\\": \\"12500/12519\\",\\n \\"InternalPort\\": \\"11120/11139\\"\\n }\\n ]\\n }\\n ],\\n \\"InternalIp\\": \\"10.1.17.32\\",\\n \\"ResourceAttributes\\": {\\n \\"Zone\\": \\"Public\\",\\n \\"OutAccess\\": \\"ON\\",\\n \\"InAccess\\": \\"ON\\",\\n \\"EdgeMediaService\\": \\"ON\\"\\n },\\n \\"InstanceChargeType\\": \\"PostPaid\\",\\n \\"ResourceStatus\\": {\\n \\"Status\\": \\"running\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query detailed information of a cloud application service instance ', + 'changeSet' => [ + ['createdAt' => '2025-11-27T05:35:36.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-10T09:57:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-05-29T05:45:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-24T07:31:18.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRenderingInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeRenderingInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], + ], + ], + 'DescribeRenderingInstanceConfiguration' => [ + 'summary' => 'Queries the real-time configuration of a cloud application service instance.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '213856', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], + 'parameters' => [ + [ + 'name' => 'RenderingInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud application service instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], + ], + [ + 'name' => 'Configuration', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The configuration to query. By default, the configurations of all modules are returned.', + 'type' => 'array', + 'items' => [ + 'description' => 'Physical device emulation module', + 'type' => 'object', + 'properties' => [ + 'ModuleName' => ['description' => 'The name of the module.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'location'], + 'AttributeNames' => [ + 'title' => '', + 'description' => 'The list of attribute names to query. By default, all attributes are returned.', + 'type' => 'array', + 'items' => ['description' => 'The name of the attribute.', 'type' => 'string', 'required' => false, 'example' => 'lon', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'deprecated' => false, + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Configuration' => [ + 'title' => '', + 'description' => 'The configuration.', + 'type' => 'array', + 'items' => [ + 'description' => 'Properties of the real device emulation module', + 'type' => 'object', + 'properties' => [ + 'ModuleName' => ['description' => 'The name of the device simulation feature module. Valid values:'."\n" + ."\n" + .'1. ctl: The control module.'."\n" + ."\n" + .'2. prop: The property module.'."\n" + ."\n" + .'3. location: The location module.'."\n" + ."\n" + .'4. battery: The battery module.'."\n" + ."\n" + .'5. network: The network module.'."\n" + ."\n" + .'6. bluetooth: The Bluetooth module.'."\n" + ."\n" + .'7. sim: The SIM card module.'."\n" + ."\n" + .'8. display: The device module.'."\n" + ."\n" + .'9. system: The basic module.', 'type' => 'string', 'title' => '', 'example' => 'location'], + 'Attributes' => [ + 'title' => '', + 'description' => 'The list of properties for the module.', + 'type' => 'array', + 'items' => [ + 'description' => 'The property information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the attribute.', 'type' => 'string', 'title' => '', 'example' => 'lon'], + 'Value' => ['description' => 'The value of the attribute.', 'type' => 'any', 'title' => '', 'example' => '100'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Configuration\\": [\\n {\\n \\"ModuleName\\": \\"location\\",\\n \\"Attributes\\": [\\n {\\n \\"Name\\": \\"lon\\",\\n \\"Value\\": \\"100\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Configuration Information of a Graphic Computing Service Instance ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRenderingInstanceConfiguration'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DescribeRenderingInstanceConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], + ], + ], + 'DescribeRenderingInstanceSettings' => [ + 'summary' => 'DescribeRenderingInstanceSettings queries the configuration of a Cloud Application service instance.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvs4YZ3LQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RenderingInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Cloud Application service instance.', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], + ], + [ + 'name' => 'AttributeNames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of instance configuration names.', + 'type' => 'array', + 'items' => ['description' => 'The name of an instance configuration.', 'type' => 'string', 'required' => false, 'example' => 'navbar.hide', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Settings' => [ + 'description' => 'The list of instance configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'An instance configuration.', + 'type' => 'object', + 'properties' => [ + 'AttributeName' => ['description' => 'The name of an instance configuration.', 'type' => 'string', 'example' => 'navbar.hide', 'title' => ''], + 'AttributeValue' => ['description' => 'The value of an instance configuration.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Settings\\": [\\n {\\n \\"AttributeName\\": \\"navbar.hide\\",\\n \\"AttributeValue\\": \\"1\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the configuration of a cloud application service instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRenderingInstanceSettings'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DescribeRenderingInstanceSettings', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeRenderingSession' => [ + 'summary' => 'Retrieve details about a rendering session, including the current session state, network access IP address and port, and the location of the cloud application service instance.', + 'path' => '/', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'Project ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['description' => 'Session ID. Specify either SessionId or ClientId.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'session-i205217481741918129226'], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => 'Unique ID of the end client. Specify either SessionId or ClientId.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'd27c89d6-4fe3-4855-a89c-ea721c708b0b'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'admin', + 'title' => 'Schema of Response', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'SessionId' => ['description' => 'Session ID', 'type' => 'string', 'title' => '', 'example' => 'session-i205217481741918129226'], + 'ClientId' => ['description' => 'End client ID', 'type' => 'string', 'title' => '', 'example' => 'c91263a0-f9ac-45bd-bbe9-6e293ad32d91'], + 'AppId' => ['description' => 'Cloud application ID', 'type' => 'string', 'title' => '', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], + 'StartTime' => ['description' => 'Start time', 'type' => 'string', 'title' => '', 'example' => '2025-05-18T02:20:00Z'], + 'Hostname' => ['description' => 'Instance hostname. Defaults to the EIP address.', 'type' => 'string', 'title' => '', 'example' => '111.45.29.96'], + 'Isp' => ['title' => 'Carrier encoding. Valid values:'."\n" + .'1. cmcc'."\n" + .'2. unicom'."\n" + .'3. telecom', 'description' => 'Carrier code. Valid values:'."\n" + ."\n" + .'1. cmcc'."\n" + ."\n" + .'2. unicom'."\n" + ."\n" + .'3. telecom', 'type' => 'string', 'example' => 'telecom'], + 'PortMappings' => [ + 'title' => '', + 'description' => 'Port mapping information', + 'type' => 'array', + 'items' => [ + 'description' => 'Port mapping information', + 'type' => 'object', + 'properties' => [ + 'ExternalPort' => ['description' => 'Public port or port range, such as 22. For a port range, use a forward slash (/) to separate the start and end ports. Example: 10/20.', 'type' => 'string', 'title' => '', 'example' => '10013/10020'], + 'InternalPort' => ['description' => 'Private port or port range. Each private port maps one-to-one with a public port. For a port range, use a forward slash (/) to separate the start and end ports. Example: 10/20.', 'type' => 'string', 'title' => '', 'example' => '49008/49015'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'StateInfo' => [ + 'title' => '', + 'description' => 'Session state information', + 'type' => 'object', + 'properties' => [ + 'State' => ['description' => 'Session state. Valid values:'."\n" + ."\n" + .'1. SessionStarting: Starting the session'."\n" + ."\n" + .'2. SessionStartSuspended: Session start is suspended. Retry by calling Start again.'."\n" + ."\n" + .'3. SessionStarted: Session started or in use'."\n" + ."\n" + .'4. SessionStartFailed: Session failed to start'."\n" + ."\n" + .'5. SessionAbnormal: Session became abnormal after starting successfully'."\n" + ."\n" + .'6. SessionStopping: Stopping the session'."\n" + ."\n" + .'7. SessionStopFailed: Session failed to stop', 'type' => 'string', 'title' => '', 'example' => 'SessionStarted'], + 'Comment' => ['description' => 'State description', 'type' => 'string', 'title' => '', 'example' => '已启动'], + 'UpdateTime' => ['description' => 'Time when the state was last updated', 'type' => 'string', 'title' => '', 'example' => '2024-10-15T10:05:20+08:00'], + ], + 'example' => '', + ], + 'Location' => [ + 'title' => '', + 'description' => 'Cloud application service instance location', + 'type' => 'object', + 'properties' => [ + 'ProvinceCode' => ['description' => 'Province code of the cloud application service instance', 'type' => 'string', 'title' => '', 'example' => '310000'], + ], + 'example' => '', + ], + 'AdditionalIngresses' => [ + 'description' => 'Additional optional ingress network information', + 'title' => 'Additional optional ingress network information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Optional ingress network information', + 'type' => 'object', + 'properties' => [ + 'PortMappings' => [ + 'description' => 'List of port mappings', + 'title' => 'List of port mappings.', + 'type' => 'array', + 'items' => [ + 'description' => 'Port mapping information', + 'type' => 'object', + 'properties' => [ + 'ExternalPort' => ['title' => 'The external port or port range, such as 22. If it is a port range, separate the start and end ports with a forward slash (/), for example, 10/20.', 'description' => 'Public port or port range, such as 22. For a port range, use a forward slash (/) to separate the start and end ports. Example: 10/20.', 'type' => 'string', 'example' => '11060/11079'], + 'InternalPort' => ['title' => 'Internal port or port range, which corresponds one-to-one with the external port. If it is a port range, separate the start and end ports with a forward slash (/), for example, 10/20.', 'description' => 'Private port or port range. Each private port maps one-to-one with a public port. For a port range, use a forward slash (/) to separate the start and end ports. Example: 10/20.', 'type' => 'string', 'example' => '11060/11079'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Isp' => ['title' => 'Carrier encoding. Valid values:'."\n" + .'1. cmcc'."\n" + .'2. unicom'."\n" + .'3. telecom', 'description' => 'Carrier code. Valid values:'."\n" + ."\n" + .'1. cmcc'."\n" + ."\n" + .'2. unicom'."\n" + ."\n" + .'3. telecom', 'type' => 'string', 'example' => 'unicom'], + 'Hostname' => ['title' => 'Domain name or IP address of the cloud application service instance', 'description' => 'Domain name or IP address of the cloud application service instance', 'type' => 'string', 'example' => '111.45.29.96'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'RenderingInstanceId' => ['title' => 'Cloud application service instance ID', 'description' => 'Cloud application service instance ID', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], + 'PatchId' => ['title' => 'The ID of the cloud application patch package. An empty value indicates the original version.', 'description' => 'Cloud application patch package ID. An empty value means the original version.', 'type' => 'string', 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SessionId\\": \\"session-i205217481741918129226\\",\\n \\"ClientId\\": \\"c91263a0-f9ac-45bd-bbe9-6e293ad32d91\\",\\n \\"AppId\\": \\"cap-b06b26edfhytbn b94a75ae1a79efc90eb\\",\\n \\"StartTime\\": \\"2025-05-18T02:20:00Z\\",\\n \\"Hostname\\": \\"111.45.29.96\\",\\n \\"Isp\\": \\"telecom\\",\\n \\"PortMappings\\": [\\n {\\n \\"ExternalPort\\": \\"10013/10020\\",\\n \\"InternalPort\\": \\"49008/49015\\"\\n }\\n ],\\n \\"StateInfo\\": {\\n \\"State\\": \\"SessionStarted\\",\\n \\"Comment\\": \\"已启动\\",\\n \\"UpdateTime\\": \\"2024-10-15T10:05:20+08:00\\"\\n },\\n \\"Location\\": {\\n \\"ProvinceCode\\": \\"310000\\"\\n },\\n \\"AdditionalIngresses\\": [\\n {\\n \\"PortMappings\\": [\\n {\\n \\"ExternalPort\\": \\"11060/11079\\",\\n \\"InternalPort\\": \\"11060/11079\\"\\n }\\n ],\\n \\"Isp\\": \\"unicom\\",\\n \\"Hostname\\": \\"111.45.29.96\\"\\n }\\n ],\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"PatchId\\": \\"patch-03fa76e8e13a49b6a966b063d9d309b4\\"\\n}","type":"json"}]', + 'title' => 'Query session information ', + 'changeSet' => [ + ['createdAt' => '2025-08-21T12:22:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-19T08:44:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-10T09:57:07.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeRenderingSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'DescribeStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'Password', + 'name' => 'Id', 'in' => 'query', + 'schema' => ['description' => 'The stream ID.', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the stream. Valid values:'."\n" + ."\n" + .'- on (online)'."\n" + ."\n" + .'- off (offline)', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'PlayDomain' => ['description' => 'The streaming domain to which the stream belongs.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'Protocol' => ['description' => 'The protocol of the stream.', 'type' => 'string', 'example' => 'gb28181', 'title' => ''], + 'DeviceId' => ['description' => 'The ID of the device to which the stream belongs.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'Height' => ['description' => 'The height of the video stream resolution.', 'type' => 'integer', 'format' => 'int32', 'example' => '720', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the group to which the stream belongs.', 'type' => 'string', 'example' => '348*****174-cn-qingdao', 'title' => ''], + 'Width' => ['description' => 'The width of the video stream resolution.', 'type' => 'integer', 'format' => 'int32', 'example' => '1280', 'title' => ''], + 'App' => ['description' => 'The application to which the stream belongs.', 'type' => 'string', 'example' => 'live', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the stream is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Name' => ['description' => 'The name of the stream.', 'type' => 'string', 'example' => '31000000*****0000002', 'title' => ''], + 'PushDomain' => ['description' => 'The ingest domain to which the stream belongs.', 'type' => 'string', 'example' => 'demo.aliyundoc.com', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the stream was created.', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', 'title' => ''], + 'Id' => ['description' => 'The stream ID.', 'type' => 'string', 'example' => '323*****997-cn-qingdao', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'admin', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"on\\",\\n \\"PlayDomain\\": \\"example.aliyundoc.com\\",\\n \\"Protocol\\": \\"gb28181\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\",\\n \\"Height\\": 720,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"Width\\": 1280,\\n \\"App\\": \\"live\\",\\n \\"Enabled\\": true,\\n \\"Name\\": \\"31000000*****0000002\\",\\n \\"PushDomain\\": \\"demo.aliyundoc.com\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Id\\": \\"323*****997-cn-qingdao\\"\\n}","type":"json"}]', + 'title' => 'Query Stream Details', + 'summary' => 'Queries information about a stream.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStream'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Vendor', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeStreamURL' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The stream ID.', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The type of the stream. The default value is \\`live\\`. Valid values:'."\n" + ."\n" + .'- \\`live\\`: a live stream.'."\n" + ."\n" + .'- \\`vod\\`: a video-on-demand (VOD) stream, such as a historical stream from a Network Video Recorder (NVR).', 'type' => 'string', 'required' => false, 'default' => 'live', 'example' => 'live', 'title' => ''], + ], + [ + 'name' => 'OutProtocol', + 'in' => 'query', + 'schema' => ['description' => 'The playback protocol for the stream. Valid values:'."\n" + ."\n" + .'- rtmp'."\n" + ."\n" + .'- flv'."\n" + ."\n" + .'- hls', 'type' => 'string', 'required' => true, 'example' => 'rtmp', 'title' => ''], + ], + [ + 'name' => 'Auth', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to generate a signed URL. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'default' => 'true', 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'AuthKey', + 'in' => 'query', + 'schema' => ['description' => 'The primary key associated with the playback domain name. This key is used to generate the authentication URL.'."\n" + ."\n" + .'> Call the [DescribeVsDomainConfigs](https://next.api.aliyun.com/document/vs/2018-12-12/DescribeVsDomainConfigs) operation to query the \\`AuthKey\\` information.', 'type' => 'string', 'required' => false, 'example' => 'ocs*****ace', 'title' => ''], + ], + [ + 'name' => 'Expire', + 'in' => 'query', + 'schema' => ['description' => 'The time-to-live (TTL) of the URL. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time. This parameter applies to \\`vod\\` streams.
'."\n" + .'A UNIX timestamp. Unit: seconds.
', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1571639499', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time. This parameter applies to \\`vod\\` streams.
'."\n" + .'A UNIX timestamp. Unit: seconds.
', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1571649499', 'title' => ''], + ], + [ + 'name' => 'Transcode', 'in' => 'query', + 'schema' => ['description' => 'The name of the transcoding rule. This parameter is valid only after a transcoding template is attached.', 'type' => 'string', 'required' => false, 'example' => 'sd', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => 'The URL of the stream.', 'type' => 'string', 'example' => 'rtmp://demo.aliyundoc.com/live/310101*****7542007?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'ExpireTime' => ['description' => 'The time when the URL expires.
'."\n" + .'A UNIX timestamp. Unit: seconds.
', 'type' => 'integer', 'format' => 'int64', 'example' => '1557977029', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Url\\": \\"rtmp://demo.aliyundoc.com/live/310101*****7542007?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"ExpireTime\\": 1557977029\\n}","type":"json"}]', + 'title' => 'Obtain Stream URL', + 'summary' => 'Retrieves the URL of a stream.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreamURL'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Longitude', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeStreamURL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeStreamVodList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'Stream ID.', 'type' => 'string', 'required' => true, 'example' => '18526049*****219118918-cn-beijing', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'VOD record start time (unix timestamp, unit: seconds)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1639077653', 'title' => ''], + ], + [ + 'name' => 'EndTime', 'in' => 'query', + 'schema' => ['description' => 'VOD record end time (unix timestamp, unit: seconds)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1634873413', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID of this task.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Records' => [ + 'description' => 'VOD record list', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'VOD record end time (unix timestamp, unit: seconds)', 'type' => 'integer', 'format' => 'int64', 'example' => '1634873413', 'title' => ''], + 'StartTime' => ['description' => 'VOD record start time (unix timestamp, unit: seconds)', 'type' => 'integer', 'format' => 'int64', 'example' => '1639077653', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '45.00', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Records\\": [\\n {\\n \\"EndTime\\": 1634873413,\\n \\"StartTime\\": 1639077653\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get Stream Video VOD List', + 'summary' => 'Get the stream VOD record list, such as historical stream list from NVR.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreamVodList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeStreamVodList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeStreams' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'Latitude', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'Stream ID.'."\n" + ."\n" + .'> Enter multiple IDs separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '323*****997-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the space to query.', 'type' => 'string', 'required' => false, 'example' => '348*****174-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => 'Filter by device ID.', 'type' => 'string', 'required' => false, 'example' => '348*****380-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => ['description' => 'Parent device ID of the device that hosts this stream.', 'type' => 'string', 'required' => false, 'example' => '399*****774-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'Filter by stream name.'."\n" + ."\n" + .'> Enter multiple names separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '3100000*****00000002', 'title' => ''], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => ['description' => 'Filter by domain name.', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', 'title' => ''], + ], + [ + 'name' => 'App', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '119.20', - ], + 'schema' => ['description' => 'Filter by application.', 'type' => 'string', 'required' => false, 'example' => 'live', 'title' => ''], ], [ - 'name' => 'AutoPos', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Sort results by a field. Valid values:'."\n" + ."\n" + .'- Id (default)'."\n" + ."\n" + .'- GroupId'."\n" + ."\n" + .'- Name'."\n" + ."\n" + .'- DeviceId'."\n" + ."\n" + .'- Protocol'."\n" + ."\n" + .'> You can specify only one field.', 'type' => 'string', 'required' => false, 'example' => 'Id', 'title' => ''], ], [ - 'name' => 'PosInterval', + 'name' => 'SortDirection', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300', - ], + 'schema' => ['description' => 'Sort order. Valid values:'."\n" + ."\n" + .'- asc (ascending, default)'."\n" + ."\n" + .'- desc (descending)', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], [ - 'name' => 'AlarmMethod', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'Number of items per page. Default value: 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'Params', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -9647,73 +9314,90 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'PageNum' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of streams.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'PageCount' => ['description' => 'Total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'Streams' => [ + 'description' => 'List of streams.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Stream status. Valid values:'."\n" + ."\n" + .'- on (online)'."\n" + ."\n" + .'- off (offline)', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'PlayDomain' => ['description' => 'Streaming domain for this stream.', 'type' => 'string', 'example' => 'demo.aliyundoc.com', 'title' => ''], + 'Protocol' => ['description' => 'Stream protocol.', 'type' => 'string', 'example' => 'gb28181', 'title' => ''], + 'DeviceId' => ['description' => 'Device ID of this stream.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'Height' => ['description' => 'Video stream height in pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '720', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the group to which the stream belongs.', 'type' => 'string', 'example' => '348*****174-cn-qingdao', 'title' => ''], + 'App' => ['description' => 'Application that owns this stream.', 'type' => 'string', 'example' => 'live', 'title' => ''], + 'Width' => ['description' => 'Video stream width in pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '1280', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the stream is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Name' => ['description' => 'Stream name.', 'type' => 'string', 'example' => '31000000*****0000002', 'title' => ''], + 'PushDomain' => ['description' => 'Ingest domain for this stream.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'CreatedTime' => ['description' => 'Time when the stream was created.', 'type' => 'string', 'example' => '2018-12-10T17:00:00Z', 'title' => ''], + 'Id' => ['description' => 'Stream ID.', 'type' => 'string', 'example' => '323*****997-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 5,\\n \\"Streams\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"PlayDomain\\": \\"demo.aliyundoc.com\\",\\n \\"Protocol\\": \\"gb28181\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\",\\n \\"Height\\": 720,\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"App\\": \\"live\\",\\n \\"Width\\": 1280,\\n \\"Enabled\\": true,\\n \\"Name\\": \\"31000000*****0000002\\",\\n \\"PushDomain\\": \\"example.aliyundoc.com\\",\\n \\"CreatedTime\\": \\"2018-12-10T17:00:00Z\\",\\n \\"Id\\": \\"323*****997-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query stream list', + 'summary' => 'Lists video streams. You can filter the results by stream ID, name, group ID, device ID, or other criteria.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDevice' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreams'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeStreams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3238848****092996-cn-qingdao', - ], - ], - [ - 'name' => 'IncludeStats', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'IncludeDirectory', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Template ID.', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', 'title' => ''], ], ], 'responses' => [ @@ -9721,414 +9405,375 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ipc', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'on', - ], - 'AlarmMethod' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5', - ], - 'Dsn' => [ - 'description' => '', - 'type' => 'string', - 'example' => '7D0*****4C0', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8080', - ], - 'PosInterval' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', - ], - 'ParentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3238848****092995-cn-qingdao', - ], - 'Password' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'admin', - ], - 'AutoPos' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Params' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ChannelSyncTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-02-28T17:01:17Z', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-02-28T17:00:17Z', - ], - 'DirectoryId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3238848****092994-cn-qingdao', - ], - 'RegisteredTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-02-28T17:00:17Z', - ], - 'Protocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gb28181', - ], - 'Ip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.10.10.10', - ], - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtmp://xxx/xxx', - ], - 'AutoStart' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Vendor' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'GbId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '31000000****00000002', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3238848****092994-cn-qingdao', - ], - 'Longitude' => [ - 'description' => '', - 'type' => 'string', - 'example' => '45.00', - ], - 'Latitude' => [ - 'description' => '', - 'type' => 'string', - 'example' => '119.20', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3238848****092996-cn-qingdao', - ], - 'Username' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'admin', - ], - 'Stats' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'FailedNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StreamNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ChannelNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OnlineNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OfflineNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - 'Directory' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ParentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3238848****092995-cn-qingdao', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3238848****092994-cn-qingdao', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-02-28T17:00:17Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3238848****092994-cn-qingdao', + 'Type' => ['description' => 'Template type. Valid values:'."\n" + ."\n" + .'- record'."\n" + ."\n" + .'- snapshot'."\n" + ."\n" + .'- transcode'."\n" + ."\n" + .'- timeshift', 'type' => 'string', 'example' => 'record', 'title' => ''], + 'Trigger' => ['description' => 'Template trigger type. Valid values:'."\n" + ."\n" + .'- auto'."\n" + ."\n" + .'- ondemand'."\n" + ."\n" + .'> Applies only to recording templates.', 'type' => 'string', 'example' => 'auto', 'title' => ''], + 'HlsTs' => ['description' => 'Storage path for HLS .ts files.'."\n" + ."\n" + .'> Applies only to recording templates.', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}', 'title' => ''], + 'Mp4' => ['description' => 'Storage path for MP4 files.'."\n" + ."\n" + .'> Applies only to recording templates.', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', 'title' => ''], + 'JpgOverwrite' => ['description' => 'Storage path for JPG files used to overwrite snapshots.'."\n" + ."\n" + .'> Applies only to snapshot templates.', 'type' => 'string', 'example' => 'osspath/snapshot/{AppName}/{StreamName}.jpg', 'title' => ''], + 'Callback' => ['description' => 'Callback URL triggered after template execution.', 'type' => 'string', 'example' => 'http://example.com/callback', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Description' => ['description' => 'Template description.', 'type' => 'string', 'example' => '录制模板', 'title' => ''], + 'Region' => ['description' => 'OSS region, which is the service center.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'Retention' => ['description' => 'Timeshift retention period, in days.'."\n" + ."\n" + .'> Applies only to timeshift templates.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'HlsM3u8' => ['description' => 'Storage path for HLS .m3u8 files.'."\n" + ."\n" + .'> Applies only to recording templates.', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', 'title' => ''], + 'Name' => ['description' => 'Template name.', 'type' => 'string', 'example' => '录制模板', 'title' => ''], + 'Flv' => ['description' => 'Storage path for FLV files.'."\n" + ."\n" + .'> Applies only to recording templates.', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', 'title' => ''], + 'CreatedTime' => ['description' => 'Template creation time.', 'type' => 'string', 'example' => '2020-12-10T10:00:00Z', 'title' => ''], + 'OssEndpoint' => ['description' => 'OSS domain name.', 'type' => 'string', 'example' => 'oss-cn-qingdao.aliyuncs.com', 'title' => ''], + 'OssFilePrefix' => ['description' => 'OSS file prefix.', 'type' => 'string', 'example' => 'oss-prefix', 'title' => ''], + 'JpgOnDemand' => ['description' => 'Storage path for JPG files used for on-demand snapshots.'."\n" + ."\n" + .'> Applies only to snapshot templates.', 'type' => 'string', 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg', 'title' => ''], + 'OssBucket' => ['description' => 'OSS bucket.', 'type' => 'string', 'example' => 'my_oss_bucket', 'title' => ''], + 'FileFormat' => ['description' => 'Storage file format. Separate multiple values with commas. Valid values: mp4, flv, hls, jpg', 'type' => 'string', 'example' => 'hls', 'title' => ''], + 'JpgSequence' => ['description' => 'Storage path for JPG files used for sequential snapshots.'."\n" + ."\n" + .'> Applies only to snapshot templates.', 'type' => 'string', 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', 'title' => ''], + 'Interval' => ['description' => 'Operation interval, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3600', 'title' => ''], + 'Id' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '323*****998-cn-qingdao', 'title' => ''], + 'TransConfigs' => [ + 'description' => 'List of transcoding configurations.'."\n" + ."\n" + .'> Applies only to transcoding templates.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Gop' => ['description' => 'Video GOP, in frames.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'Width' => ['description' => 'Video width.', 'type' => 'integer', 'format' => 'int64', 'example' => '1280', 'title' => ''], + 'VideoBitrate' => ['description' => 'Video bitrate, in kbps.', 'type' => 'integer', 'format' => 'int64', 'example' => '800', 'title' => ''], + 'Height' => ['description' => 'Video height.', 'type' => 'integer', 'format' => 'int64', 'example' => '720', 'title' => ''], + 'VideoCodec' => ['description' => 'Video encoding.', 'type' => 'string', 'example' => 'h264', 'title' => ''], + 'Fps' => ['description' => 'Video frame rate, in fps.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''], + 'Name' => ['description' => 'Transcoding rule name. The name appears as a suffix in the transcoded stream. We recommend using recognizable suffixes such as sd or 200k. Only letters and digits are supported.', 'type' => 'string', 'example' => 'sd', 'title' => ''], + 'Id' => ['description' => 'Transcoding configuration ID.', 'type' => 'string', 'example' => '399*****430-cn-qingdao', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"ipc\\",\\n \\"Status\\": \\"on\\",\\n \\"AlarmMethod\\": \\"5\\",\\n \\"Dsn\\": \\"7D0*****4C0\\",\\n \\"Port\\": 8080,\\n \\"PosInterval\\": 300,\\n \\"AutoDirectory\\": true,\\n \\"ParentId\\": \\"3238848****092995-cn-qingdao\\",\\n \\"Password\\": \\"admin\\",\\n \\"AutoPos\\": false,\\n \\"Params\\": \\"{}\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Description\\": \\"xxx路口摄像头\\",\\n \\"Enabled\\": true,\\n \\"Name\\": \\"xxx路口摄像头\\",\\n \\"ChannelSyncTime\\": \\"2019-02-28T17:01:17Z\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"DirectoryId\\": \\"3238848****092994-cn-qingdao\\",\\n \\"RegisteredTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Protocol\\": \\"gb28181\\",\\n \\"Ip\\": \\"10.10.10.10\\",\\n \\"Url\\": \\"rtmp://xxx/xxx\\",\\n \\"AutoStart\\": false,\\n \\"Vendor\\": \\"公司A\\",\\n \\"GbId\\": \\"31000000****00000002\\",\\n \\"GroupId\\": \\"3238848****092994-cn-qingdao\\",\\n \\"Longitude\\": \\"45.00\\",\\n \\"Latitude\\": \\"119.20\\",\\n \\"Id\\": \\"3238848****092996-cn-qingdao\\",\\n \\"Username\\": \\"admin\\",\\n \\"Stats\\": {\\n \\"FailedNum\\": 1,\\n \\"StreamNum\\": 1,\\n \\"ChannelNum\\": 1,\\n \\"OnlineNum\\": 1,\\n \\"OfflineNum\\": 1\\n },\\n \\"Directory\\": {\\n \\"ParentId\\": \\"3238848****092995-cn-qingdao\\",\\n \\"Description\\": \\"目录1\\",\\n \\"GroupId\\": \\"3238848****092994-cn-qingdao\\",\\n \\"Name\\": \\"目录1\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Id\\": \\"3238848****092994-cn-qingdao\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Type\\": \\"record\\",\\n \\"Trigger\\": \\"auto\\",\\n \\"HlsTs\\": \\"osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}\\",\\n \\"Mp4\\": \\"osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"JpgOverwrite\\": \\"osspath/snapshot/{AppName}/{StreamName}.jpg\\",\\n \\"Callback\\": \\"http://example.com/callback\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Description\\": \\"录制模板\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"Retention\\": 3,\\n \\"HlsM3u8\\": \\"osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"Name\\": \\"录制模板\\",\\n \\"Flv\\": \\"osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"CreatedTime\\": \\"2020-12-10T10:00:00Z\\",\\n \\"OssEndpoint\\": \\"oss-cn-qingdao.aliyuncs.com\\",\\n \\"OssFilePrefix\\": \\"oss-prefix\\",\\n \\"JpgOnDemand\\": \\"osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg\\",\\n \\"OssBucket\\": \\"my_oss_bucket\\",\\n \\"FileFormat\\": \\"hls\\",\\n \\"JpgSequence\\": \\"osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg\\",\\n \\"Interval\\": 3600,\\n \\"Id\\": \\"323*****998-cn-qingdao\\",\\n \\"TransConfigs\\": [\\n {\\n \\"Gop\\": 50,\\n \\"Width\\": 1280,\\n \\"VideoBitrate\\": 800,\\n \\"Height\\": 720,\\n \\"VideoCodec\\": \\"h264\\",\\n \\"Fps\\": 25,\\n \\"Name\\": \\"sd\\",\\n \\"Id\\": \\"399*****430-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query template', + 'summary' => 'Query information about a template.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDevices' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTemplate'], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '348*****380-cn-qingdao', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], + 'ramActions' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ipc', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeTemplates' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '348*****174-cn-qingdao', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'ParentId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '399*****774-cn-qingdao', - ], + 'schema' => ['description' => 'Template ID.', 'type' => 'string', 'required' => false, 'example' => '323434****83423432', 'title' => ''], ], [ - 'name' => 'DirectoryId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '399*****488-cn-qingdao', - ], + 'schema' => ['description' => 'Filter templates by template type.', 'type' => 'string', 'required' => false, 'example' => 'record', 'title' => ''], ], [ - 'name' => 'GbId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '310000000****0000002', - ], + 'schema' => ['description' => 'Filter templates by the bound instance ID.', 'type' => 'string', 'required' => false, 'example' => '323*****998-cn-qingdao', 'title' => ''], ], [ - 'name' => 'Dsn', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '7D0*****4C0', - ], + 'schema' => ['description' => 'Sort results by the specified field. Default: sort by ID.', 'type' => 'string', 'required' => false, 'example' => 'id', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'SortDirection', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - ], + 'schema' => ['description' => 'Sort order. Default: ascending. Valid values:'."\n" + ."\n" + .'- asc (ascending)'."\n" + ."\n" + .'- desc (descending)', 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], [ - 'name' => 'Vendor', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '8yd*****qem', - ], + 'schema' => ['description' => 'Number of entries per page. Default: 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'SortBy', + 'name' => 'PageNum', 'in' => 'query', + 'schema' => ['description' => 'Page number. Default: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageNum' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'F3F88C96-CA6E-573E-B8F7-5BE83A1A0BCF', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of templates.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'PageCount' => ['description' => 'Total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'Templates' => [ + 'description' => 'Template list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'Template type. Valid values:'."\n" + ."\n" + .'- record (recording)'."\n" + ."\n" + .'- snapshot (snapshot)'."\n" + ."\n" + .'- transcode (transcoding)'."\n" + ."\n" + .'- timeshift (time shifting)', 'type' => 'string', 'example' => 'record', 'title' => ''], + 'Trigger' => ['description' => 'Template trigger type. Valid values:'."\n" + ."\n" + .'- auto (automatic)'."\n" + ."\n" + .'- ondemand (on demand)'."\n" + ."\n" + .'> This applies only to recording templates.', 'type' => 'string', 'example' => 'auto', 'title' => ''], + 'OssFilePrefix' => ['description' => 'OSS file prefix.', 'type' => 'string', 'example' => 'my_prefix', 'title' => ''], + 'HlsTs' => ['description' => 'HLS storage path for TS files.'."\n" + ."\n" + .'> This applies only to recording templates.', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}', 'title' => ''], + 'Mp4' => ['description' => 'MP4 storage path.'."\n" + ."\n" + .'> This applies only to recording templates.', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', 'title' => ''], + 'JpgOnDemand' => ['description' => 'JPG storage path for on-demand snapshots.'."\n" + ."\n" + .'> This applies only to snapshot templates.', 'type' => 'string', 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg', 'title' => ''], + 'OssBucket' => ['description' => 'The OSS bucket.', 'type' => 'string', 'example' => 'my_oss_bucket', 'title' => ''], + 'JpgSequence' => ['description' => 'JPG storage path for sequential snapshots.'."\n" + ."\n" + .'> This applies only to snapshot templates.', 'type' => 'string', 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', 'title' => ''], + 'JpgOverwrite' => ['description' => 'JPG storage path for overwrite snapshots.'."\n" + ."\n" + .'> This applies only to snapshot templates.', 'type' => 'string', 'example' => 'osspath/snapshot/{AppName}/{StreamName}.jpg', 'title' => ''], + 'FileFormat' => ['description' => 'Storage file format. Separate multiple values with commas. Valid values: mp4, flv, hls, jpg.', 'type' => 'string', 'example' => 'hls', 'title' => ''], + 'Callback' => ['description' => 'Callback URL after template execution.', 'type' => 'string', 'example' => 'http://example.com/callback', 'title' => ''], + 'Interval' => ['description' => 'Operation interval in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3600', 'title' => ''], + 'Description' => ['description' => 'Template description.', 'type' => 'string', 'example' => '录制模板', 'title' => ''], + 'Region' => ['description' => 'OSS region, also known as service center.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'Retention' => ['description' => 'Time-shifting retention period in days.'."\n" + ."\n" + .'> This applies only to time-shifting templates.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'HlsM3u8' => ['description' => 'HLS storage path for M3U8 files.'."\n" + ."\n" + .'> This applies only to recording templates.', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', 'title' => ''], + 'Flv' => ['description' => 'FLV storage path.'."\n" + ."\n" + .'> This applies only to recording templates.', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', 'title' => ''], + 'Name' => ['description' => 'Template name.', 'type' => 'string', 'example' => '录制模板', 'title' => ''], + 'CreatedTime' => ['description' => 'Template creation time.', 'type' => 'string', 'example' => '2018-12-10T10:00:00Z', 'title' => ''], + 'OssEndpoint' => ['description' => 'OSS domain name.', 'type' => 'string', 'example' => 'oss-cn-qingdao.aliyuncs.com', 'title' => ''], + 'Id' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '323*****998-cn-qingdao', 'title' => ''], + 'TransConfigs' => [ + 'description' => 'Transcoding configuration list.'."\n" + ."\n" + .'> This applies only to transcoding templates.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Gop' => ['description' => 'Video GOP in frames.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'Width' => ['description' => 'Video width.', 'type' => 'integer', 'format' => 'int64', 'example' => '1280', 'title' => ''], + 'VideoBitrate' => ['description' => 'Video bitrate in kbps.', 'type' => 'integer', 'format' => 'int64', 'example' => '800', 'title' => ''], + 'Height' => ['description' => 'Video height.', 'type' => 'integer', 'format' => 'int64', 'example' => '720', 'title' => ''], + 'VideoCodec' => ['description' => 'Video encoding.', 'type' => 'string', 'example' => 'h264', 'title' => ''], + 'Fps' => ['description' => 'Video frame rate in fps.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''], + 'Name' => ['description' => 'Transcoding rule name. This name becomes the suffix of the transcoded stream. Use a descriptive suffix such as sd or 200k. Only letters and numbers are allowed.', 'type' => 'string', 'example' => 'sd', 'title' => ''], + 'id' => ['description' => 'Transcoding configuration ID.', 'type' => 'string', 'example' => '399788187729597430-cn-qingdao', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"F3F88C96-CA6E-573E-B8F7-5BE83A1A0BCF\\",\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 5,\\n \\"Templates\\": [\\n {\\n \\"Type\\": \\"record\\",\\n \\"Trigger\\": \\"auto\\",\\n \\"OssFilePrefix\\": \\"my_prefix\\",\\n \\"HlsTs\\": \\"osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}\\",\\n \\"Mp4\\": \\"osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"JpgOnDemand\\": \\"osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg\\",\\n \\"OssBucket\\": \\"my_oss_bucket\\",\\n \\"JpgSequence\\": \\"osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg\\",\\n \\"JpgOverwrite\\": \\"osspath/snapshot/{AppName}/{StreamName}.jpg\\",\\n \\"FileFormat\\": \\"hls\\",\\n \\"Callback\\": \\"http://example.com/callback\\",\\n \\"Interval\\": 3600,\\n \\"Description\\": \\"录制模板\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"Retention\\": 3,\\n \\"HlsM3u8\\": \\"osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"Flv\\": \\"osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"Name\\": \\"录制模板\\",\\n \\"CreatedTime\\": \\"2018-12-10T10:00:00Z\\",\\n \\"OssEndpoint\\": \\"oss-cn-qingdao.aliyuncs.com\\",\\n \\"Id\\": \\"323*****998-cn-qingdao\\",\\n \\"TransConfigs\\": [\\n {\\n \\"Gop\\": 50,\\n \\"Width\\": 1280,\\n \\"VideoBitrate\\": 800,\\n \\"Height\\": 720,\\n \\"VideoCodec\\": \\"h264\\",\\n \\"Fps\\": 25,\\n \\"Name\\": \\"sd\\",\\n \\"id\\": \\"399788187729597430-cn-qingdao\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query template list ', + 'summary' => 'List templates.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTemplates'], + ], + ], + 'ramActions' => [ [ - 'name' => 'SortDirection', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'asc', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeVodStreamURL' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'PageNum', + 'name' => 'Url', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The file URL of the VOD video.', 'type' => 'string', 'required' => true, 'example' => 'http://xxx/xxx.mp4', 'title' => ''], ], [ - 'name' => 'IncludeStats', + 'name' => 'TxId', 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => '流播放URL', 'type' => 'string', 'example' => 'rtsp://domain/live/stream?sign=xxxxxx', 'title' => ''], + 'OutProtocol' => ['description' => '流播放协议', 'type' => 'string', 'example' => 'rtsp', 'title' => ''], + 'RequestId' => ['description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Port' => ['description' => '流播放端口', 'type' => 'integer', 'format' => 'int64', 'example' => '8080', 'title' => ''], + 'TxId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Url\\": \\"rtsp://domain/live/stream?sign=xxxxxx\\",\\n \\"OutProtocol\\": \\"rtsp\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Port\\": 8080,\\n \\"TxId\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'Retrieve VOD stream URL', + 'summary' => 'Retrieves the URL information of a video-on-demand (VOD) stream.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVodStreamURL'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVodStreamURL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeVsCertificateDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'IncludeDirectory', + 'name' => 'CertName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The certificate name.', 'type' => 'string', 'required' => true, 'example' => 'cert-539xxxx', 'title' => ''], ], ], 'responses' => [ @@ -10136,282 +9781,133 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '77', - ], - 'PageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Devices' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ipc', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'on', - ], - 'AlarmMethod' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Dsn' => [ - 'description' => '', - 'type' => 'string', - 'example' => '7D0*****4C0', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8080', - ], - 'PosInterval' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', - ], - 'AutoDirectory' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ParentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3238848****092995', - ], - 'Password' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'admin', - ], - 'AutoPos' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Params' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ChannelSyncTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-02-28T17:01:17Z', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-02-28T17:00:17Z', - ], - 'DirectoryId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****488-cn-qingdao', - ], - 'RegisteredTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-02-28T17:00:17Z', - ], - 'Protocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gb28181', - ], - 'Ip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.10.10.10', - ], - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtmp://xxx/xxx', - ], - 'AutoStart' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Vendor' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'GbId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '310000000****0000002', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****174-cn-qingdao', - ], - 'Longitude' => [ - 'description' => '', - 'type' => 'string', - 'example' => '45.00', - ], - 'Latitude' => [ - 'description' => '', - 'type' => 'string', - 'example' => '119.20', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'Username' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'admin', - ], - 'Stats' => [ - 'description' => '', + 'CertName' => ['description' => 'The certificate name.', 'type' => 'string', 'example' => 'cert-539xxxxx', 'title' => ''], + 'Key' => ['description' => 'The key.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], + 'Cert' => ['description' => 'The certificate content.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----xxxxx-----END CERTIFICATE-----', 'title' => ''], + 'CertId' => ['description' => 'The certificate ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '63000000', 'title' => ''], + 'RequestId' => ['description' => 'The request ID for this operation.', 'type' => 'string', 'example' => 'D94D0E1E-E71B-562D-8C18-969BB3653FBD', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CertName\\": \\"cert-539xxxxx\\",\\n \\"Key\\": \\"xxxxx\\",\\n \\"Cert\\": \\"-----BEGIN CERTIFICATE-----xxxxx-----END CERTIFICATE-----\\",\\n \\"CertId\\": 63000000,\\n \\"RequestId\\": \\"D94D0E1E-E71B-562D-8C18-969BB3653FBD\\"\\n}","type":"json"}]', + 'title' => 'Retrieve Certificate Details', + 'summary' => 'Retrieve certificate details.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsCertificateDetail'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsCertificateDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeVsCertificateList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'Domain name.', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'ID of the request.', 'type' => 'string', 'example' => '6E310519-E035-51AB-80D4-C1CBECD39EB5', 'title' => ''], + 'CertificateListModel' => [ + 'description' => 'Certificate ID.', + 'type' => 'object', + 'properties' => [ + 'Count' => ['description' => 'Number of certificates.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'CertList' => [ + 'description' => 'List of certificates.', + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'FailedNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'StreamNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ChannelNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OnlineNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OfflineNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], + 'LastTime' => ['description' => 'Timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1632462708', 'title' => ''], + 'Fingerprint' => ['description' => 'Fingerprint of the certificate.', 'type' => 'string', 'example' => '3EB2585309AE5C8F369****7CDA6A8F5CEC8B2D4', 'title' => ''], + 'CertName' => ['description' => 'Name of the certificate.', 'type' => 'string', 'example' => 'cert-5391062', 'title' => ''], + 'Issuer' => ['description' => 'Issuer of the certificate.', 'type' => 'string', 'example' => 'xxxxCert Inc', 'title' => ''], + 'CertId' => ['description' => 'ID of the certificate.', 'type' => 'integer', 'format' => 'int64', 'example' => '6338888', 'title' => ''], + 'Common' => ['description' => 'Common Name (CN) field in the certificate. Usually a domain name.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], ], - ], - 'Directory' => [ 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ParentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****774-cn-qingdao', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****174-cn-qingdao', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-02-28T17:00:17Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****488-cn-qingdao', - ], - ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 77,\\n \\"PageCount\\": 5,\\n \\"Devices\\": [\\n {\\n \\"Type\\": \\"ipc\\",\\n \\"Status\\": \\"on\\",\\n \\"AlarmMethod\\": \\"0\\",\\n \\"Dsn\\": \\"7D0*****4C0\\",\\n \\"Port\\": 8080,\\n \\"PosInterval\\": 300,\\n \\"AutoDirectory\\": true,\\n \\"ParentId\\": \\"3238848****092995\\",\\n \\"Password\\": \\"admin\\",\\n \\"AutoPos\\": false,\\n \\"Params\\": \\"{}\\",\\n \\"Description\\": \\"xxx路口摄像头\\",\\n \\"Enabled\\": true,\\n \\"Name\\": \\"xxx路口摄像头\\",\\n \\"ChannelSyncTime\\": \\"2019-02-28T17:01:17Z\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"DirectoryId\\": \\"399*****488-cn-qingdao\\",\\n \\"RegisteredTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Protocol\\": \\"gb28181\\",\\n \\"Ip\\": \\"10.10.10.10\\",\\n \\"Url\\": \\"rtmp://xxx/xxx\\",\\n \\"AutoStart\\": false,\\n \\"Vendor\\": \\"公司A\\",\\n \\"GbId\\": \\"310000000****0000002\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"Longitude\\": \\"45.00\\",\\n \\"Latitude\\": \\"119.20\\",\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"Username\\": \\"admin\\",\\n \\"Stats\\": {\\n \\"FailedNum\\": 0,\\n \\"StreamNum\\": 0,\\n \\"ChannelNum\\": 0,\\n \\"OnlineNum\\": 0,\\n \\"OfflineNum\\": 0\\n },\\n \\"Directory\\": {\\n \\"ParentId\\": \\"399*****774-cn-qingdao\\",\\n \\"Description\\": \\"目录1\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"Name\\": \\"目录1\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Id\\": \\"399*****488-cn-qingdao\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6E310519-E035-51AB-80D4-C1CBECD39EB5\\",\\n \\"CertificateListModel\\": {\\n \\"Count\\": 2,\\n \\"CertList\\": [\\n {\\n \\"LastTime\\": 1632462708,\\n \\"Fingerprint\\": \\"3EB2585309AE5C8F369****7CDA6A8F5CEC8B2D4\\",\\n \\"CertName\\": \\"cert-5391062\\",\\n \\"Issuer\\": \\"xxxxCert Inc\\",\\n \\"CertId\\": 6338888,\\n \\"Common\\": \\"example.aliyundoc.com\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve certificate list ', + 'summary' => 'Retrieves a list of domain name certificates.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SyncCatalogs' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsCertificateList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsCertificateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsDevicesData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10420,14 +9916,31 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3238****739092996', - ], + 'schema' => ['description' => 'You can query by space ID.', 'type' => 'string', 'required' => false, 'example' => '348*****174-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query.'."\n" + ."\n" + .'> - The date must follow the ISO 8601 standard and be in UTC. The format is YYYY-MM-DDThh:mm:ssZ.'."\n" + .'>'."\n" + .'> - The minimum data granularity is 5 minutes.'."\n" + .'>'."\n" + .'> - If you do not specify this parameter, data from the last 24 hours is retrieved by default.', 'type' => 'string', 'required' => false, 'example' => '2022-01-04T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time.'."\n" + ."\n" + .'> - The date must follow the ISO 8601 standard and be in UTC. The format is YYYY-MM-DDThh:mm:ssZ.'."\n" + .'>'."\n" + .'> - The minimum data granularity is 5 minutes.'."\n" + .'>'."\n" + .'> - If you do not specify this parameter, data from the last 24 hours is retrieved by default.', 'type' => 'string', 'required' => false, 'example' => '2022-01-30T16:00:00Z', 'title' => ''], ], ], 'responses' => [ @@ -10435,101 +9948,212 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3238****739092996', - ], - 'RequestId' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'DevicesDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => 'The usage data of connected devices for each time interval.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => ['description' => 'The timestamp of the data point.', 'type' => 'string', 'example' => '2022-01-04T16:00:00Z', 'title' => ''], + 'DevicesDataValue' => ['description' => 'The number of connected devices.', 'type' => 'string', 'example' => '128', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"3238****739092996-cn-shenzhen\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'SyncCatalogs', - ], - 'UnlockDevice' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The format of the specified StartTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The format of the specified EndTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The specified StartTime is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DevicesDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2022-01-04T16:00:00Z\\",\\n \\"DevicesDataValue\\": \\"128\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Obtain usage data of connected devices', + 'summary' => 'Retrieves usage data for connected devices.', + 'description' => 'If you do not specify \\`StartTime\\` and \\`EndTime\\`, the API retrieves data from the last 24 hours by default. To query data for a specific time range, you must specify both \\`StartTime\\` and \\`EndTime\\`. The maximum time range for a single query is 31 days.'."\n" + ."\n" + .'- You can query multiple domain names at once. Separate the domain names with commas.'."\n" + ."\n" + .'- You can retrieve data from the last 90 days.'."\n" + ."\n" + .'- The time granularity is one hour.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDevicesData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDevicesData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsDomainBpsData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'Domain Names. If this parameter is empty, the system returns merged data for all accelerated Domain Names. Enter the accelerated Domain Names to query. Separate multiple Domain Names with commas.', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time for data retrieval. The date format follows ISO8601 notation and uses UTC time. Format: YYYY-MM-DDThh:mm:ssZ. The minimum data granularity is 5 minutes. If not specified, the system reads data from the past 24 hours.', 'type' => 'string', 'required' => false, 'example' => '2021-12-26T16:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '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.', 'type' => 'string', 'required' => false, 'example' => '2021-10-02T02:30:48Z', 'title' => ''], + ], + [ + 'name' => 'Interval', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The time granularity for query data. Supports 300, 3600, and 86400 seconds. If this parameter is not specified or the specified value is not supported, the system uses 300 seconds by default.', 'type' => 'string', - 'required' => true, - 'example' => '323884****9092996', + 'required' => false, + 'example' => '300', + 'enum' => ['300', '3600', '86400'], + 'title' => '', ], ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => ['description' => 'The English name of the carrier (ISP). Obtain this from the DescribeCdnRegionAndIsp interface. If not specified, the system queries all carriers (ISPs).', 'type' => 'string', 'required' => false, 'example' => 'unicom', 'title' => ''], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => ['description' => 'The English name of the region. Obtain this from the DescribeCdnRegionAndIsp interface. If not specified, the system queries all regions.', 'type' => 'string', 'required' => false, 'example' => 'guangdong', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323884****9092996', - ], - 'RequestId' => [ + 'EndTime' => ['description' => 'End time', 'type' => 'string', 'example' => '2021-10-01T07:10:48Z', 'title' => ''], + 'StartTime' => ['description' => 'Start time', 'type' => 'string', 'example' => '2021-09-18T16:00:00Z', 'title' => ''], + 'RequestId' => ['description' => 'Request ID for this operation', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'DomainName' => ['description' => 'Domain name', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'DataInterval' => ['description' => 'The time interval for each record. Unit: seconds.', 'type' => 'string', 'example' => '2100', 'title' => ''], + 'BpsDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => 'Network bandwidth data for each time interval.', + 'type' => 'array', + 'items' => [ + 'description' => 'Network bandwidth data for each time interval.', + 'type' => 'object', + 'properties' => [ + 'BpsValue' => ['description' => 'Bps data value. Unit: bit/second.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'TimeStamp' => ['description' => 'The start time of the time slice.', 'type' => 'string', 'example' => '2015-12-10T20:00:00Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"323884****9092996\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UnlockDevice', - ], - 'StartDevice' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The format of the specified StartTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The format of the specified EndTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The specified StartTime is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-10-01T07:10:48Z\\",\\n \\"StartTime\\": \\"2021-09-18T16:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"2100\\",\\n \\"BpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"BpsValue\\": \\"1000\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query network bandwidth monitoring data for a domain name', + 'summary' => 'Queries network bandwidth monitoring data for Domain Names.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainBpsData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainBpsData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsDomainCertificateInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323884****9092996', - ], + 'schema' => ['description' => 'The domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], ], ], 'responses' => [ @@ -10537,114 +10161,253 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323884****9092996', - ], - 'RequestId' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'CertInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'CertInfo' => [ + 'description' => 'The certificate information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The certificate information.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the certificate.'."\n" + ."\n" + .'- **success**: The certificate is valid.'."\n" + ."\n" + .'- **checking**: Checking if the domain name is added to Alibaba Cloud CDN.'."\n" + ."\n" + .'- **cname\\_error**: The domain name is not mapped to Alibaba Cloud CDN.'."\n" + ."\n" + .'- **top\\_domain\\_cname\\_error**: The top-level domain is not mapped to Alibaba Cloud CDN.'."\n" + ."\n" + .'- **domain\\_invalid**: The domain name contains invalid characters.'."\n" + ."\n" + .'- **unsupport\\_wildcard**: Wildcard domain names are not supported.'."\n" + ."\n" + .'- **applying**: The certificate application is in progress.'."\n" + ."\n" + .'- **get\\_token\\_timeout**: The request for a certificate application token timed out.'."\n" + ."\n" + .'- **check\\_token\\_timeout**: The token verification timed out.'."\n" + ."\n" + .'- **get\\_cert\\_timeout**: The request to obtain the certificate timed out.'."\n" + ."\n" + .'- **failed**: The certificate application failed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'CertLife' => ['description' => 'The unit of the certificate\'s validity period.'."\n" + ."\n" + .'- **months**: Month.'."\n" + ."\n" + .'- **years**: Year.', 'type' => 'string', 'example' => 'months', 'title' => ''], + 'CertExpireTime' => ['description' => 'The expiration time of the certificate. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.', 'type' => 'string', 'example' => '2018-06-03T22:03:39Z', 'title' => ''], + 'SSLPub' => ['description' => 'The public key of the certificate.', 'type' => 'string', 'example' => 'asdadaxxxx', 'title' => ''], + 'CertType' => ['description' => 'The type of the certificate.'."\n" + ."\n" + .'- **free**: A personal test certificate (Free Edition).'."\n" + ."\n" + .'- **cas**: An Alibaba Cloud Security certificate.'."\n" + ."\n" + .'- **upload**: A custom certificate that you uploaded.', 'type' => 'string', 'example' => 'free', 'title' => ''], + 'ServerCertificateStatus' => ['description' => 'The status of HTTPS.'."\n" + ."\n" + .'- **on**: Enabled.'."\n" + ."\n" + .'- **off**: Disabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'CertDomainName' => ['description' => 'The domain name that matches the certificate.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'CertName' => ['description' => 'The name of the certificate.', 'type' => 'string', 'example' => 'myname', 'title' => ''], + 'CertOrg' => ['description' => 'The name of the certificate authority (CA) that issued the certificate.', 'type' => 'string', 'example' => 'Let\'s Encrypt', 'title' => ''], + 'DomainName' => ['description' => 'The accelerated domain name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"323884****9092996\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'StartDevice', - ], - 'StopDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"CertInfos\\": {\\n \\"CertInfo\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"CertLife\\": \\"months\\",\\n \\"CertExpireTime\\": \\"2018-06-03T22:03:39Z\\",\\n \\"SSLPub\\": \\"asdadaxxxx\\",\\n \\"CertType\\": \\"free\\",\\n \\"ServerCertificateStatus\\": \\"on\\",\\n \\"CertDomainName\\": \\"example.com\\",\\n \\"CertName\\": \\"myname\\",\\n \\"CertOrg\\": \\"Let\'s Encrypt\\",\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Obtain the certificate information of a specified accelerated domain name', + 'summary' => 'Retrieves the certificate information for a specified accelerated domain name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainCertificateInfo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainCertificateInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsDomainConfigs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], + 'schema' => ['description' => 'Your accelerated domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'FunctionNames', 'in' => 'query', + 'schema' => ['description' => 'List of feature names.'."\n" + ."\n" + .'> Supports multiple values separated by commas (,).', 'type' => 'string', 'required' => true, 'example' => 'path_based_ttl_set,oss_auth', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D94D0E1E-E71B-562D-8C18-969BB3653FBD', 'title' => ''], + 'DomainConfigs' => [ + 'description' => 'Domain name configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Status. Valid values:'."\n" + ."\n" + .'- success'."\n" + ."\n" + .'- testing'."\n" + ."\n" + .'- failed'."\n" + ."\n" + .'- configuring', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ConfigId' => ['description' => 'The configuration ID.', 'type' => 'string', 'example' => '6295', 'title' => ''], + 'FunctionName' => ['description' => 'The function name.', 'type' => 'string', 'example' => 'aliauth', 'title' => ''], + 'FunctionArgs' => [ + 'description' => 'Each function.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ArgName' => ['description' => 'The name of the configuration.', 'type' => 'string', 'example' => 'auth_type', 'title' => ''], + 'ArgValue' => ['description' => 'The argument value.', 'type' => 'string', 'example' => 'req_auth', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-12-10T10:00:00Z', + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D94D0E1E-E71B-562D-8C18-969BB3653FBD\\",\\n \\"DomainConfigs\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"ConfigId\\": \\"6295\\",\\n \\"FunctionName\\": \\"aliauth\\",\\n \\"FunctionArgs\\": [\\n {\\n \\"ArgName\\": \\"auth_type\\",\\n \\"ArgValue\\": \\"req_auth\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Domain Configuration', + 'summary' => 'Queries domain name configurations. You can query the configurations of multiple features in a single request.', + 'requestParamsDescription' => '### Feature descriptions'."\n" + ."\n" + .'| Name | Parameter |'."\n" + .'| ---------------------- | ----------------------------------------- |'."\n" + .'| referer_white_list_set | Referer whitelist. |'."\n" + .'| referer_black_list_set | Referer blacklist. |'."\n" + .'| filetype_based_ttl_set | File time-to-live (TTL) settings. |'."\n" + .'| path_based_ttl_set | Folder time-to-live (TTL) settings. |'."\n" + .'| cc_defense | CC attack protection. |'."\n" + .'| oss_auth | OSS authentication bucket. |'."\n" + .'| ip_black_list_set | IP address blacklist. |'."\n" + .'| ip_white_list_set | IP address whitelist. |'."\n" + .'| error_page | Error page redirection. |'."\n" + .'| tesla | HTML optimization acceleration. |'."\n" + .'| set_req_host_header | Modify custom origin fetch header. |'."\n" + .'| set_hashkey_args | Ignore URL parameters. |'."\n" + .'| aliauth | Alibaba Cloud authentication. |'."\n" + .'| set_resp_header | Set response header (visible in browser). |'."\n" + .'| video_seek | Video segment seek toggle. |'."\n" + .'| range | Range request feature. |'."\n" + .'| gzip | Gzip compression optimization. |'."\n" + .'| https_force | Force HTTPS redirection. |'."\n" + .'| http_force | Force HTTP redirection. |'."\n" + .'| alilive | ApsaraVideo Live configuration. |'."\n" + .'| forward_scheme | Static protocol follows origin fetch. |'."\n" + .'| tmd_signature | Configure custom rate limiting rules. |'."\n" + .'| cdn_waf | WAF basic protection. |', + 'extraInfo' => '### Special Error Codes'."\n" + .'| Error Code | Description | HTTP Status Code | Semantics |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| InvalidFunctionName.ValueNotSupported | FunctionName %s is not supported. | 400 | The FunctionName %s is not supported (%s represents the specific feature name). |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainConfigs'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'StopDevice', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'BatchStartDevices' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeVsDomainDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '32388487****92996-cn-qingdao', - ], + 'schema' => ['description' => 'Domain name for the Visual Edge Computing Service', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], ], ], 'responses' => [ @@ -10652,95 +10415,105 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '32388487****92996-cn-qingdao', - ], - 'Streams' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Stream not found', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '310101*****187542126', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3238848****092997-cn-qingdao', - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9BEC5E85-C76B-56EF-A922-860EFDB8B64B', 'title' => ''], + 'DomainConfig' => [ + 'description' => 'Domain configuration details.', + 'type' => 'object', + 'properties' => [ + 'GmtCreated' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-07-19T10:27:23Z', 'title' => ''], + 'Description' => ['description' => 'The domain description.', 'type' => 'string', 'example' => '测试使用', 'title' => ''], + 'SSLProtocol' => ['description' => 'Indicates whether HTTPS is enabled. Valid values:'."\n" + ."\n" + .'- **on**: Enabled.'."\n" + ."\n" + .'- **off** (default): Disabled.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'Region' => ['description' => 'The region where the domain is located.', 'type' => 'string', 'example' => 'cn-qingdao', 'title' => ''], + 'Scope' => ['description' => 'The acceleration region. Valid values:'."\n" + ."\n" + .'- **domestic**'."\n" + ."\n" + .'- **overseas**'."\n" + ."\n" + .'- **global**', 'type' => 'string', 'example' => 'domestic', 'title' => ''], + 'Cname' => ['description' => 'The CNAME assigned to the Visual Edge Computing Service domain. You must configure your DNS provider to point your domain to this CNAME.', 'type' => 'string', 'example' => 'example.aliyundoc.com.*****.com', 'title' => ''], + 'DomainStatus' => ['description' => 'The status of the Visual Edge Computing Service accelerated domain. Valid values:'."\n" + ."\n" + .'- **online**: Enabled.'."\n" + ."\n" + .'- **offline**: Disabled.'."\n" + ."\n" + .'- **configuring**: Being configured.', 'type' => 'string', 'example' => 'online', 'title' => ''], + 'GmtModified' => ['description' => 'The most recent modification time.', 'type' => 'string', 'example' => '2021-07-19T10:27:23Z', 'title' => ''], + 'DomainName' => ['description' => 'The Visual Edge Computing Service domain name.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'DomainType' => ['description' => 'The domain type.'."\n" + ."\n" + .'> Static value: vs', 'type' => 'string', 'example' => 'vs', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Id\\": \\"32388487****92996-cn-qingdao\\",\\n \\"Streams\\": [\\n {\\n \\"Error\\": \\"Stream not found\\",\\n \\"Name\\": \\"310101*****187542126\\",\\n \\"Id\\": \\"3238848****092997-cn-qingdao\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchStartDevices', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9BEC5E85-C76B-56EF-A922-860EFDB8B64B\\",\\n \\"DomainConfig\\": {\\n \\"GmtCreated\\": \\"2021-07-19T10:27:23Z\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"SSLProtocol\\": \\"off\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"Scope\\": \\"domestic\\",\\n \\"Cname\\": \\"example.aliyundoc.com.*****.com\\",\\n \\"DomainStatus\\": \\"online\\",\\n \\"GmtModified\\": \\"2021-07-19T10:27:23Z\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DomainType\\": \\"vs\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query domain name information', + 'summary' => 'Obtains the basic configuration information for a specified Visual Edge Computing Service domain name.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BatchStopDevices' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'extraInfo' => '# Special error codes'."\n" + .'|ErrorCode|Message|HTTP status|Semantics|'."\n" + .'|:-----|:-----|:-----|:-----|'."\n" + .'|InvalidDomain.NotFound|The domain provided does not belong to you.|404|The domain name does not exist or does not belong to the current user.|'."\n" + .'|ServiceBusy|The specified Domain is configuring, please retry again later.|403|The domain name is being configured. Please try again later.|', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainDetail'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsDomainPvData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '32388487****92996', - ], + 'schema' => ['description' => 'The domain name for Visual Edge Computing Service.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-14T23:00:00Z', - ], + 'schema' => ['description' => '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 in UTC.
The minimum data granularity is 1 hour.
If you do not set this parameter, the data in the last 24 hours is returned.

', 'type' => 'string', 'required' => false, 'example' => '2021-10-10T17:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '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 \\`YYYY-MM-DDThh:mm:ssZ\\` format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2021-10-15T15:59:59Z', 'title' => ''], ], ], 'responses' => [ @@ -10748,263 +10521,299 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '32388487****92996', - ], - 'Streams' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Stream not found', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '32388*****39092997', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323884****9092997', - ], - ], + 'EndTime' => ['description' => 'The end of the time range.', 'type' => 'string', 'example' => '2021-11-12T15:59:59Z', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time range.', 'type' => 'string', 'example' => '2021-11-22T00:00:00Z', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'DomainName' => ['description' => 'The domain name for Visual Edge Computing Service.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'DataInterval' => ['description' => 'This static field defines the time interval for each record, with a value of either 1 hour or 1 day.', 'type' => 'string', 'example' => '3600', 'title' => ''], + 'PvDataInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UsageData' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The detailed usage data.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'TimeStamp' => ['description' => 'The beginning of the time slice.', 'type' => 'string', 'example' => '2021-11-22T00:00:00Z', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Id\\": \\"32388487****92996\\",\\n \\"Streams\\": [\\n {\\n \\"Error\\": \\"Stream not found\\",\\n \\"Name\\": \\"32388*****39092997\\",\\n \\"Id\\": \\"323884****9092997\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchStopDevices', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateDeviceAlarm' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The format of the specified StartTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The format of the specified EndTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidTime.ValueNotSupported', 'errorMessage' => 'StartTime or EndTime is miss match.', 'description' => ''], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The specified StartTime is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-11-12T15:59:59Z\\",\\n \\"StartTime\\": \\"2021-11-22T00:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"PvDataInterval\\": {\\n \\"UsageData\\": [\\n {\\n \\"Value\\": \\"100\\",\\n \\"TimeStamp\\": \\"2021-11-22T00:00:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Obtain domain name PV data', + 'summary' => 'Queries the page view (PV) data for a domain name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainPvData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainPvData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsDomainPvUvData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], + 'schema' => ['description' => 'Visual Edge Computing Service domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ - 'name' => 'ChannelId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '12', - ], + 'schema' => ['description' => 'Start time in UTC format. For example: 2016-06-29T19:00:00Z', 'type' => 'string', 'required' => false, 'example' => '2021-10-14T23:00:00Z', 'title' => ''], ], [ - 'name' => 'ObjectType', + 'name' => 'EndTime', 'in' => 'query', + 'schema' => ['description' => 'End time in UTC format. For example: 2016-06-30T19:00:00Z', 'type' => 'string', 'required' => false, 'example' => '2021-11-24T00:00:00Z', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'End time.', 'type' => 'string', 'example' => '2021-11-24T00:00:00Z', 'title' => ''], + 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '2021-12-12T10:00:00Z', 'title' => ''], + 'RequestId' => ['description' => 'Request ID for this operation.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'DomainName' => ['description' => 'Visual Edge Computing Service domain name.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'DataInterval' => ['description' => 'Time interval in seconds.', 'type' => 'string', 'example' => '3600', 'title' => ''], + 'PvUvDataInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PvUvDataInfo' => [ + 'description' => 'Data information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data information.', + 'type' => 'object', + 'properties' => [ + 'PV' => ['description' => 'PV data.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'TimeStamp' => ['description' => 'Start time of the time slice.', 'type' => 'string', 'example' => '2021-10-14T23:00:00Z', 'title' => ''], + 'UV' => ['description' => 'UV data.', 'type' => 'string', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Alarm', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The format of the specified StartTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The format of the specified EndTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidTime.ValueNotSupported', 'errorMessage' => 'StartTime or EndTime is miss match.', 'description' => ''], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The specified StartTime is invalid.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-11-24T00:00:00Z\\",\\n \\"StartTime\\": \\"2021-12-12T10:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"PvUvDataInfos\\": {\\n \\"PvUvDataInfo\\": [\\n {\\n \\"PV\\": \\"100\\",\\n \\"TimeStamp\\": \\"2021-10-14T23:00:00Z\\",\\n \\"UV\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Obtain PV and UV data for the VS domain name', + 'summary' => 'Retrieve page view (PV) and unique visitor (UV) data for a Visual Edge Computing Service domain.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainPvUvData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainPvUvData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeVsDomainRecordData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'SubAlarm', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - ], + 'schema' => ['description' => 'Visual Edge Computing Service domain name.', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1632121707000', - ], + 'schema' => ['description' => '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 omit this parameter, the API returns data from the last 24 hours.', 'type' => 'string', 'required' => false, 'example' => '2021-09-29T16:00:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1632314789000', - ], + 'schema' => ['description' => 'End time of the data range. Must be later than StartTime. Use ISO 8601 notation in UTC. Format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-11-19T15:59:59Z', 'title' => ''], ], [ - 'name' => 'Expire', + 'name' => 'Region', 'in' => 'query', + 'schema' => ['description' => 'Region information', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'RecordDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => 'Recording duration data for each time interval.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => ['description' => 'Start time of the time interval.', 'type' => 'string', 'example' => '2021-11-19T15:59:59Z', 'title' => ''], + 'StreamCountValue' => ['description' => 'Number of streams.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RecordValue' => ['description' => 'Number of screenshots.', 'type' => 'string', 'example' => '100', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600', + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtmp://demo.aliyundoc.com/live/310101*****7542007?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e', - ], - 'AlarmId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0hyNgTdgv2D000195842', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '76E11E6A-4441-51C9-AF60-D354362257A7', - ], - 'Expire' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3600', - ], - 'AlarmDelay' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The format of the specified StartTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The format of the specified EndTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The specified StartTime is invalid.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RecordDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2021-11-19T15:59:59Z\\",\\n \\"StreamCountValue\\": \\"1\\",\\n \\"RecordValue\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Obtain record data for a Visual Edge Computing Service (VES) domain name', + 'summary' => 'Retrieve domain name record data.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainRecordData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainRecordData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Url\\": \\"rtmp://demo.aliyundoc.com/live/310101*****7542007?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e\\",\\n \\"AlarmId\\": \\"0hyNgTdgv2D000195842\\",\\n \\"RequestId\\": \\"76E11E6A-4441-51C9-AF60-D354362257A7\\",\\n \\"Expire\\": 3600,\\n \\"AlarmDelay\\": 60\\n}","type":"json"}]', ], - 'ModifyDeviceAlarm' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeVsDomainRegionData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], - ], - [ - 'name' => 'ChannelId', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'Visual Edge Computing Service domain name.', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ - 'name' => 'AlarmId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '0dGo7jLwwf1000296232', - ], + 'schema' => ['description' => 'Start time of the data range. Specify the time in ISO 8601 format in UTC.
Format: YYYY-MM-DDThh:mm:ssZ.
Minimum data granularity is 5 minutes.
If you do not specify this parameter, data from the last 24 hours is returned by default.


', 'type' => 'string', 'required' => false, 'example' => '2021-10-30T16:00:00Z', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'End time of the data range. The end time must be later than the start time. Specify the time in ISO 8601 format in UTC.
Format: YYYY-MM-DDThh:mm:ssZ.
', 'type' => 'string', 'required' => false, 'example' => '2021-10-31T15:59:59Z', 'title' => ''], ], ], 'responses' => [ @@ -11012,143 +10821,252 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'EndTime' => ['description' => 'End time.', 'type' => 'string', 'example' => '2021-10-31T15:59:59Z', 'title' => ''], + 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '2021-10-30T16:00:00Z', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'DomainName' => ['description' => 'The domain name that is accelerated by Visual Edge Computing Service.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'DataInterval' => ['description' => 'Time interval, in seconds.', 'type' => 'string', 'example' => '3600', 'title' => ''], + 'Value' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionProportionData' => [ + 'description' => 'Region proportion data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data.', + 'type' => 'object', + 'properties' => [ + 'TotalQuery' => ['description' => 'Total number of requests.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'TotalBytes' => ['description' => 'Total traffic, in bytes.', 'type' => 'string', 'example' => '2400057', 'title' => ''], + 'AvgResponseRate' => ['description' => 'Average response rate, in bytes per second.', 'type' => 'string', 'example' => '154.3345765545624', 'title' => ''], + 'AvgResponseTime' => ['description' => 'Average response time, in milliseconds.', 'type' => 'string', 'example' => '5183.666666666667', 'title' => ''], + 'ReqErrRate' => ['description' => 'Request error rate. For example, a value of 90 means 90%.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'AvgObjectSize' => ['description' => 'Average response size, in bytes.', 'type' => 'string', 'example' => '2888253.7875', 'title' => ''], + 'Bps' => ['description' => 'Bandwidth, in bits per second.', 'type' => 'string', 'example' => '380.9614285714286', 'title' => ''], + 'Qps' => ['description' => 'Queries per second (QPS).', 'type' => 'string', 'example' => '0.001746031746031746', 'title' => ''], + 'RegionEname' => ['description' => 'English name of the region.', 'type' => 'string', 'example' => 'chongqing', 'title' => ''], + 'Region' => ['description' => 'Region information.', 'type' => 'string', 'example' => '重庆市', 'title' => ''], + 'Proportion' => ['description' => 'Access proportion. For example, a value of 90 means 90%.', 'type' => 'string', 'example' => '0.01155980271270037', 'title' => ''], + 'BytesProportion' => ['description' => 'Traffic proportion. For example, a value of 90 means 90%.', 'type' => 'string', 'example' => '0.003544181046236794', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'ModifyDeviceCapture' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The format of the specified StartTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The format of the specified EndTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The specified StartTime is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-10-31T15:59:59Z\\",\\n \\"StartTime\\": \\"2021-10-30T16:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"Value\\": {\\n \\"RegionProportionData\\": [\\n {\\n \\"TotalQuery\\": \\"3\\",\\n \\"TotalBytes\\": \\"2400057\\",\\n \\"AvgResponseRate\\": \\"154.3345765545624\\",\\n \\"AvgResponseTime\\": \\"5183.666666666667\\",\\n \\"ReqErrRate\\": \\"0\\",\\n \\"AvgObjectSize\\": \\"2888253.7875\\",\\n \\"Bps\\": \\"380.9614285714286\\",\\n \\"Qps\\": \\"0.001746031746031746\\",\\n \\"RegionEname\\": \\"chongqing\\",\\n \\"Region\\": \\"重庆市\\",\\n \\"Proportion\\": \\"0.01155980271270037\\",\\n \\"BytesProportion\\": \\"0.003544181046236794\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve domain name regional data', + 'summary' => 'Retrieves domain region data.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainRegionData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainRegionData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsDomainReqBpsData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], + 'schema' => ['description' => 'Visual Edge Computing Service domain name.', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ - 'name' => 'Image', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '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 you omit this parameter, the system reads data from the last 24 hours by default.


', 'type' => 'string', 'required' => false, 'example' => '2022-01-15T16:00:00Z', 'title' => ''], ], [ - 'name' => 'Video', + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'End time must be later than start time. Use ISO 8601 notation and UTC time.
Format: YYYY-MM-DDThh:mm:ssZ
', 'type' => 'string', 'required' => false, 'example' => '2021-10-16T07:00:46Z', 'title' => ''], + ], + [ + 'name' => 'Interval', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Time granularity for the query, in seconds. Valid values: 300, 3600, and 86400. If you omit this parameter or specify an unsupported value, the default value 300 is used.', + 'enumValueTitles' => [300 => '300', 3600 => '3600', 86400 => '86400'], + 'type' => 'string', 'required' => false, - 'example' => '1', + 'example' => '300', + 'title' => '', ], ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => ['description' => 'ISP name in English. Get this value from the DescribeCdnRegionAndIsp operation. If you omit this parameter, the system queries data for all ISPs.', 'type' => 'string', 'required' => false, 'example' => 'telecom', 'title' => ''], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => ['description' => 'Region name in English. Get this value from the DescribeCdnRegionAndIsp operation. If you omit this parameter, the system queries data for all regions.', 'type' => 'string', 'required' => false, 'example' => 'beijing', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'EndTime' => ['description' => 'End time.', 'type' => 'string', 'example' => '2021-09-24T03:30:46Z', 'title' => ''], + 'StartTime' => ['description' => 'Start time.', 'type' => 'string', 'example' => '2021-12-24T16:00:00Z', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'DomainName' => ['description' => 'The domain name of the Visual Edge Computing Service.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'DataInterval' => ['description' => 'Time interval between records, in seconds.', 'type' => 'string', 'example' => '3600', 'title' => ''], + 'ReqBpsDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => 'Data list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimeStamp' => ['description' => 'Start time of the time slice.', 'type' => 'string', 'example' => '2021-12-24T16:00:00Z', 'title' => ''], + 'ReqBpsValue' => ['description' => 'bps value. Unit: bit/second.', 'type' => 'string', 'example' => '1000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'ModifyDeviceChannels' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The format of the specified StartTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The format of the specified EndTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The specified StartTime is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-09-24T03:30:46Z\\",\\n \\"StartTime\\": \\"2021-12-24T16:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"ReqBpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2021-12-24T16:00:00Z\\",\\n \\"ReqBpsValue\\": \\"1000\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Obtain monitoring data of network requests for a domain name', + 'summary' => 'Query network request monitoring data for a domain name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainReqBpsData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainReqBpsData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsDomainReqTrafficData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], + 'schema' => ['description' => 'Visual Edge Computing Service domain name.', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ - 'name' => 'Dsn', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '210235C3GN32090008286cf17e130d', - ], + 'schema' => ['description' => '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 you omit this parameter, the system returns data for the last 24 hours.


', 'type' => 'string', 'required' => false, 'example' => '2021-09-30T16:00:00Z', 'title' => ''], ], [ - 'name' => 'DeviceStatus', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - ], + 'schema' => ['description' => '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
', 'type' => 'string', 'required' => false, 'example' => '2021-10-13T10:00:41Z', 'title' => ''], ], [ - 'name' => 'Channels', + 'name' => 'Interval', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'Time granularity of the query. Unit: seconds. Valid values:'."\n" + ."\n" + .'- **300** (default).'."\n" + ."\n" + .'- **3600**.'."\n" + ."\n" + .'- **86400**.'."\n" + ."\n" + .'> If you omit this parameter or specify an unsupported value, the default value **300** is used.', 'type' => 'string', 'required' => false, 'example' => '3600', 'title' => ''], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => ['description' => 'ISP name in English. Call DescribeCdnRegionAndIsp to get valid values. If you omit this parameter, the system returns data for all ISPs.', 'type' => 'string', 'required' => false, 'example' => 'unicom', 'title' => ''], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => ['description' => 'Region name in English. Call DescribeCdnRegionAndIsp to get valid values. If you omit this parameter, the system returns data for all regions.', 'type' => 'string', 'required' => false, 'example' => 'shanghai', 'title' => ''], ], ], 'responses' => [ @@ -11156,67 +11074,98 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'EndTime' => ['description' => 'End time of the query.', 'type' => 'string', 'example' => '2021-09-22T03:40:41Z', 'title' => ''], + 'StartTime' => ['description' => 'Start time of the query.', 'type' => 'string', 'example' => '2021-09-21T16:00:00Z', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9BEC5E85-C76B-56EF-A922-860EFDB8B64B', 'title' => ''], + 'DomainName' => ['description' => 'Domain name of the Visual Edge Computing Service', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'DataInterval' => ['description' => 'Time granularity of the query.', 'type' => 'string', 'example' => '3600', 'title' => ''], + 'ReqTrafficDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => 'Request traffic data for each time interval.', + 'type' => 'array', + 'items' => [ + 'description' => 'Request traffic data for a time interval.', + 'type' => 'object', + 'properties' => [ + 'ReqTrafficValue' => ['description' => 'Total traffic.', 'type' => 'string', 'example' => '10000', 'title' => ''], + 'TimeStamp' => ['description' => 'Start time of the time interval.', 'type' => 'string', 'example' => '2021-09-22T03:40:41Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => '8F4D95B6-EB19-5245-AD77-95EDA83E53B7', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F4D95B6-EB19-5245-AD77-95EDA83E53B7\\"\\n}","type":"json"}]', - ], - 'DescribeDeviceChannels' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The format of the specified StartTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The format of the specified EndTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The specified StartTime is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-09-22T03:40:41Z\\",\\n \\"StartTime\\": \\"2021-09-21T16:00:00Z\\",\\n \\"RequestId\\": \\"9BEC5E85-C76B-56EF-A922-860EFDB8B64B\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"ReqTrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"ReqTrafficValue\\": \\"10000\\",\\n \\"TimeStamp\\": \\"2021-09-22T03:40:41Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Obtain request traffic data by domain name', + 'summary' => 'Obtain traffic data for domain name requests.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainReqTrafficData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainReqTrafficData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsDomainSnapshotData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], + 'schema' => ['description' => 'Visual Edge Computing Service domain name.', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', 'title' => ''], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '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 you omit this parameter, the API returns data from the last 24 hours.


', 'type' => 'string', 'required' => false, 'example' => '2021-10-05T16:00:00Z', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'End time of the data range. Must be later than StartTime. Use ISO 8601 notation and UTC time.
Format: YYYY-MM-DDThh:mm:ssZ
', 'type' => 'string', 'required' => false, 'example' => '2021-10-18T16:00:00Z', 'title' => ''], ], ], 'responses' => [ @@ -11224,144 +11173,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4641C72D-462E-4AEA-8485-FC267AF90B0A', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Channels' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StreamStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'off', - ], - 'GbId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3100000****000000002', - ], - 'Params' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{}', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'ChannelId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'DeviceStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'on', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', + 'RequestId' => ['description' => 'ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'SnapshotDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => 'List of snapshot data per interval.', + 'type' => 'array', + 'items' => [ + 'description' => 'Snapshot data per interval.', + 'type' => 'object', + 'properties' => [ + 'SnapshotValue' => ['description' => 'Number of snapshots.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TimeStamp' => ['description' => 'Start time of the time slice.', 'type' => 'string', 'example' => '2015-12-10T20:00:00Z', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'StreamId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****997-cn-qingdao', - ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"4641C72D-462E-4AEA-8485-FC267AF90B0A\\",\\n \\"TotalCount\\": 1,\\n \\"PageCount\\": 1,\\n \\"Channels\\": [\\n {\\n \\"StreamStatus\\": \\"off\\",\\n \\"GbId\\": \\"3100000****000000002\\",\\n \\"Params\\": \\"{}\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\",\\n \\"ChannelId\\": 0,\\n \\"DeviceStatus\\": \\"on\\",\\n \\"Name\\": \\"通道1\\",\\n \\"StreamId\\": \\"323*****997-cn-qingdao\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeDeviceChannels', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDeviceGateway' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The format of the specified StartTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The format of the specified EndTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The specified StartTime is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SnapshotDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"SnapshotValue\\": \\"1\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve domain name snapshot data', + 'summary' => 'Retrieves snapshot data for a domain name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainSnapshotData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainSnapshotData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsDomainTrafficData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '24611****70597051-cn-beijing', - ], + 'schema' => ['description' => 'The domain name of the Visual Edge Computing Service.', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ - 'name' => 'ClientIp', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.0.1', - ], + 'schema' => ['description' => '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 granularity is 5 minutes.
If not specified, the system reads data from the past 24 hours by default.


', 'type' => 'string', 'required' => false, 'example' => '2021-08-18T16:00:00Z', 'title' => ''], ], [ - 'name' => 'Expire', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600', - ], + 'schema' => ['description' => '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
', 'type' => 'string', 'required' => false, 'example' => '2021-09-21T02:50:42Z', 'title' => ''], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The time granularity for querying data. Supported values are 300, 3600, and 86400 seconds. If this parameter is not provided or an unsupported value is passed, the default value of 300 seconds is used.', 'type' => 'string', 'required' => false, 'example' => '3600', 'title' => ''], + ], + [ + 'name' => 'IspNameEn', + 'in' => 'query', + 'schema' => ['description' => 'The English name of the ISP. Obtain this value through the DescribeCdnRegionAndIsp interface. If this parameter is not provided, the system queries all ISPs.', 'type' => 'string', 'required' => false, 'example' => 'telecom', 'title' => ''], + ], + [ + 'name' => 'LocationNameEn', + 'in' => 'query', + 'schema' => ['description' => 'The English name of the region. Obtain this value through the DescribeCdnRegionAndIsp interface. If this parameter is not provided, the system queries all regions.', 'type' => 'string', 'required' => false, 'example' => 'beijing', 'title' => ''], ], ], 'responses' => [ @@ -11369,126 +11283,187 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Host' => [ - 'description' => '', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'Token' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'f5578fbc-694c-461d-a2a2-eb090775cef0', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8080', - ], - 'Protocol' => [ + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2021-09-20T07:10:42Z', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2021-10-25T16:00:00Z', 'title' => ''], + 'RequestId' => ['description' => 'The request ID for this task.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'DomainName' => ['description' => 'The domain name of the Visual Edge Computing Service.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'DataInterval' => ['description' => 'The time interval, in seconds.', 'type' => 'string', 'example' => '3600', 'title' => ''], + 'TrafficDataPerInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataModule' => [ + 'description' => 'Traffic data for each time interval.', + 'type' => 'array', + 'items' => [ + 'description' => 'Traffic data for each time interval.', + 'type' => 'object', + 'properties' => [ + 'TrafficValue' => ['description' => 'The traffic data value. Unit: Byte.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'TimeStamp' => ['description' => 'The start time of the time slice.', 'type' => 'string', 'example' => '2021-09-20T07:10:42Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'gb28181', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Host\\": \\"192.168.0.1\\",\\n \\"Token\\": \\"f5578fbc-694c-461d-a2a2-eb090775cef0\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Port\\": 8080,\\n \\"Protocol\\": \\"gb28181\\"\\n}","type":"json"}]', - ], - 'DescribeDeviceURL' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The format of the specified StartTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The format of the specified EndTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The specified StartTime is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-09-20T07:10:42Z\\",\\n \\"StartTime\\": \\"2021-10-25T16:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"TrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TrafficValue\\": \\"100\\",\\n \\"TimeStamp\\": \\"2021-09-20T07:10:42Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve domain name traffic data', + 'summary' => 'Retrieve traffic data for a domain name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainTrafficData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainTrafficData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsDomainUvData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], + 'schema' => ['description' => 'The domain name of Visual Edge Computing Service.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ - 'name' => 'Stream', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'live001', - ], + 'schema' => ['description' => '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 in UTC.
The minimum data granularity is 1 hour.
If you do not set this parameter, data from the last 24 hours is queried.

', 'type' => 'string', 'required' => false, 'example' => '2021-10-12T10:00:00Z', 'title' => ''], ], [ - 'name' => 'OutProtocol', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rtmp', - ], + 'schema' => ['description' => '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 YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => false, 'example' => '2021-11-24T00:00:00Z', 'title' => ''], ], - [ - 'name' => 'Mode', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end of the time range.', 'type' => 'string', 'example' => '2015-11-30T00:00:00Z', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time range.', 'type' => 'string', 'example' => '2015-11-29T00:00:00Z', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'DomainName' => ['description' => 'The domain name of Visual Edge Computing Service.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'DataInterval' => ['description' => 'The time interval between data records. Unit: seconds. This is a static field with a value of 3600, which indicates 1 hour.', 'type' => 'string', 'example' => '3600', 'title' => ''], + 'UvDataInterval' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UsageData' => [ + 'description' => 'The returned data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The number of unique visitors (UVs).', 'type' => 'string', 'example' => '100', 'title' => ''], + 'TimeStamp' => ['description' => 'The start time of the time slice.', 'type' => 'string', 'example' => '2015-11-29T15:00:00Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'push', - 'default' => 'play', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'default' => 'live', + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The format of the specified StartTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The format of the specified EndTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidTime.ValueNotSupported', 'errorMessage' => 'StartTime or EndTime is miss match.', 'description' => ''], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The specified StartTime is invalid.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2015-11-30T00:00:00Z\\",\\n \\"StartTime\\": \\"2015-11-29T00:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"UvDataInterval\\": {\\n \\"UsageData\\": [\\n {\\n \\"Value\\": \\"100\\",\\n \\"TimeStamp\\": \\"2015-11-29T15:00:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Obtain UV data for a Visual Edge Computing Service domain name', + 'summary' => 'Retrieve UV data by domain name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainUvData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainUvData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DescribeVsPullStreamInfoConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Auth', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'Expire', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600', - ], + 'schema' => ['description' => 'The stream pulling domain.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], ], ], 'responses' => [ @@ -11496,56 +11471,86 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtmp://demo.aliyundoc.com/live/live001?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'ExpireTime' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'LiveAppRecordList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveAppRecord' => [ + 'description' => 'The stream pulling configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2016-05-15T07:30:00Z', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'xxxApp', 'title' => ''], + 'SourceUrl' => ['description' => 'The source URL of the stream.', 'type' => 'string', 'example' => 'http://test', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2016-05-15T01:30:00Z', 'title' => ''], + 'StreamName' => ['description' => 'The stream name.', 'type' => 'string', 'example' => 'xxxStream', 'title' => ''], + 'DomainName' => ['description' => 'The stream pulling domain.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1639130258', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Url\\": \\"rtmp://demo.aliyundoc.com/live/live001?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"ExpireTime\\": 1639130258\\n}","type":"json"}]', - ], - 'DescribePurchasedDevice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"LiveAppRecordList\\": {\\n \\"LiveAppRecord\\": [\\n {\\n \\"EndTime\\": \\"2016-05-15T07:30:00Z\\",\\n \\"AppName\\": \\"xxxApp\\",\\n \\"SourceUrl\\": \\"http://test\\",\\n \\"StartTime\\": \\"2016-05-15T01:30:00Z\\",\\n \\"StreamName\\": \\"xxxStream\\",\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Obtain Stream Pulling Configuration Information', + 'summary' => 'Queries the pull stream configurations for a domain name.', + 'extraInfo' => '## Special error codes'."\n" + .'| Error code | Description | HTTP status code | Semantics |'."\n" + .'|------------|-------------|------------------|-----------|'."\n" + .'| Missing DomainName | DomainName is mandatory for this action. | 400 | The parameter is missing. |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain name was not found under the current account. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVsPullStreamInfoConfig'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsPullStreamInfoConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsStreamsNotifyUrlConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3614*****66212-cn-qingdao', - ], + 'schema' => ['description' => 'Your accelerated domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], ], ], 'responses' => [ @@ -11553,196 +11558,163 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ipc', - ], - 'SubType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dome', - ], - 'Vendor' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8yd*****qem', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RegisterCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345*****67890', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****174-cn-qingdao', - ], - 'GroupName' => [ - 'description' => '', - 'type' => 'string', + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'LiveStreamsNotifyConfig' => [ + 'description' => 'Configuration information.', + 'type' => 'object', + 'properties' => [ + 'AuthType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DomainName' => ['description' => 'Your ingest domain.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'NotifyUrl' => ['description' => 'Webhook address.', 'type' => 'string', 'example' => 'https://example.com/callback', 'title' => ''], + ], + 'title' => '', 'example' => '', ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-12-10T21:00:00Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '33763****77224964-cn-qingdao', - ], - 'OrderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2117*****0447', - ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Type\\": \\"ipc\\",\\n \\"SubType\\": \\"dome\\",\\n \\"Vendor\\": \\"8yd*****qem\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Description\\": \\"xxx路口摄像头\\",\\n \\"RegisterCode\\": \\"12345*****67890\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"GroupName\\": \\"测试空间\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"Name\\": \\"test\\",\\n \\"CreatedTime\\": \\"2018-12-10T21:00:00Z\\",\\n \\"Id\\": \\"33763****77224964-cn-qingdao\\",\\n \\"OrderId\\": \\"2117*****0447\\"\\n}","type":"json"}]', - ], - 'DescribePurchasedDevices' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"LiveStreamsNotifyConfig\\": {\\n \\"AuthType\\": \\"\\",\\n \\"AuthKey\\": \\"\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"NotifyUrl\\": \\"https://example.com/callback\\"\\n }\\n}","type":"json"}]', + 'title' => 'Obtain VS Stream Notification URL Configuration', + 'summary' => 'Queries the stream ingest callback configuration.', + 'extraInfo' => '## Special Error Codes'."\n" + .'| Error Code | Description | HTTP Status Code | Semantics |'."\n" + .'|------------------------|----------------------------------------------------------|------------------|----------------------------------------|'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | An unknown error occurred in the backend. |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain was not found under the current account. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | The current operation is not supported, such as for a non-live streaming domain. |'."\n" + .'| InvalidConfig.NotFound | Config does not exist. | 404 | No callback configuration was found for the current domain. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVsStreamsNotifyUrlConfig'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsStreamsNotifyUrlConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsStreamsOnlineList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4070*****1132-cn-qingdao', - ], + 'schema' => ['description' => 'The accelerated domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'xxxApp', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'StreamName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ipc', - ], + 'schema' => ['description' => 'The stream name.', 'type' => 'string', 'required' => false, 'example' => 'xxxStream', 'title' => ''], ], [ - 'name' => 'SubType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dome', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 3000.'."\n" + ."\n" + .'Valid values: 1 to 3000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '2000', 'example' => '10', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '348*****174-cn-qingdao', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Vendor', + 'name' => 'StreamType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The stream type. Valid values:'."\n" + ."\n" + .'- all (default): all streams'."\n" + ."\n" + .'- raw: raw streams'."\n" + ."\n" + .'- trans: transcoded streams', 'type' => 'string', 'required' => false, - 'example' => '', + 'enum' => ['all', 'raw', 'trans'], + 'example' => 'all', + 'title' => '', ], ], [ - 'name' => 'SortBy', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id', - ], + 'schema' => ['description' => 'The start of the time range to query.'."\n" + ."\n" + .'> Specify the time in the UTC format. Example: 2016-06-29T19:00:00Z.', 'type' => 'string', 'required' => false, 'example' => '2016-06-29T19:00:00Z', 'title' => ''], ], [ - 'name' => 'SortDirection', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - ], + 'schema' => ['description' => 'The end of the time range to query.'."\n" + ."\n" + .'> - Specify the time in the UTC format. Example: 2016-06-30T19:00:00Z.'."\n" + .'>'."\n" + .'> - The time range between EndTime and StartTime cannot exceed 30 days.', 'type' => 'string', 'required' => false, 'example' => '2016-06-30T19:00:00Z', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'QueryType', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Specifies whether to perform a fuzzy match for the stream name. Valid values:'."\n" + ."\n" + .'- fuzzy: fuzzy match'."\n" + ."\n" + .'- strict: exact match', + 'type' => 'string', 'required' => false, - 'example' => '20', + 'enum' => ['fuzzy', 'strict'], + 'example' => 'fuzzy', + 'title' => '', ], ], [ - 'name' => 'PageNum', + 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The sorting method. Valid values:'."\n" + ."\n" + .'- stream\\_name\\_desc: sorts by stream name in descending order.'."\n" + ."\n" + .'- stream\\_name\\_asc: sorts by stream name in ascending order.'."\n" + ."\n" + .'- publish\\_time\\_desc: sorts by ingest time in descending order.'."\n" + ."\n" + .'- publish\\_time\\_asc (default): sorts by ingest time in ascending order.', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => false, - 'example' => '1', + 'enum' => ['stream_name_desc', 'stream_name_asc', 'stream_publish_time_desc', 'stream_publish_asc'], + 'example' => 'publish_time_asc', + 'title' => '', ], ], ], @@ -11751,155 +11723,201 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Devices' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ipc', - ], - 'SubType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dome', - ], - 'Vendor' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RegisterCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1234*****67890', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****174-cn-qingdao', - ], - 'GroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'Name' => [ + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B31FC4AD-3592-573E-8063-878F722B322A', 'title' => ''], + 'TotalNum' => ['description' => 'The total number of entries that meet the criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'OnlineInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveStreamOnlineInfo' => [ + 'description' => 'The information about the active streams.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PublishTime' => ['description' => 'The time when stream ingest started. The time is in UTC.', 'type' => 'string', 'example' => '2015-12-02T06:58:04Z', 'title' => ''], + 'AppName' => ['description' => 'The name of the application to which the stream belongs.', 'type' => 'string', 'example' => 'xxxApp', 'title' => ''], + 'PublishType' => ['description' => 'The ingest type. Valid values:'."\n" + ."\n" + .'- edge: edge ingest'."\n" + ."\n" + .'- center: live center ingest', 'type' => 'string', 'example' => 'edge', 'title' => ''], + 'PublishUrl' => ['description' => 'The complete ingest URL.', 'type' => 'string', 'example' => 'rtmp://example.com/xchen', 'title' => ''], + 'Transcoded' => ['description' => 'Indicates whether the stream is a transcoded stream. Valid values:'."\n" + ."\n" + .'- yes'."\n" + ."\n" + .'- no', 'type' => 'string', 'example' => 'no', 'title' => ''], + 'StreamName' => ['description' => 'The stream name.', 'type' => 'string', 'example' => 'testxchen_small', 'title' => ''], + 'DomainName' => ['description' => 'The accelerated domain name to which the stream belongs.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'TranscodeId' => ['description' => 'The ID of the transcoding template.'."\n" + ."\n" + .'> - If the stream was transcoded, the ID of the transcoding template is returned.'."\n" + .'>'."\n" + .'> - For a raw stream, a comma-separated list of transcoding template IDs configured for the current AppName is returned.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'PublishDomain' => ['description' => 'The ingest domain.', 'type' => 'string', 'example' => 'push.example.com', 'title' => ''], + ], 'description' => '', - 'type' => 'string', + 'title' => '', 'example' => '', ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-02-28T17:00:17Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'OrderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2117*****0447', - ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 1,\\n \\"PageCount\\": 1,\\n \\"Devices\\": [\\n {\\n \\"Type\\": \\"ipc\\",\\n \\"SubType\\": \\"dome\\",\\n \\"Vendor\\": \\"公司A\\",\\n \\"Description\\": \\"xxx路口摄像头\\",\\n \\"RegisterCode\\": \\"1234*****67890\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"GroupName\\": \\"测试空间\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"Name\\": \\"xxx路口摄像头\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"OrderId\\": \\"2117*****0447\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'BindPurchasedDevice' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalPage\\": 1,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"B31FC4AD-3592-573E-8063-878F722B322A\\",\\n \\"TotalNum\\": 10,\\n \\"OnlineInfo\\": {\\n \\"LiveStreamOnlineInfo\\": [\\n {\\n \\"PublishTime\\": \\"2015-12-02T06:58:04Z\\",\\n \\"AppName\\": \\"xxxApp\\",\\n \\"PublishType\\": \\"edge\\",\\n \\"PublishUrl\\": \\"rtmp://example.com/xchen\\",\\n \\"Transcoded\\": \\"no\\",\\n \\"StreamName\\": \\"testxchen_small\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TranscodeId\\": \\"123\\",\\n \\"PublishDomain\\": \\"push.example.com\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query information about all streams that are currently ingesting', + 'summary' => 'Retrieves information about all active streams for a specified domain name or application.', + 'extraInfo' => '## Special error codes'."\n" + .'| Error code | Description | HTTP status code | Semantics |'."\n" + .'|------------------------|--------------------------------------------------------------|------------------|----------------------------------------|'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | An unknown error occurred in the backend. |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain name was not found under the current account. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | The current operation is not supported, such as using a non-live-streaming domain. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVsStreamsOnlineList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsStreamsOnlineList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsStreamsPublishList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'AK' => [], + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'Your domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The application name of the live stream.', 'type' => 'string', 'required' => false, 'example' => 'xxxApp', 'title' => ''], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => ['description' => 'The live stream name.', 'type' => 'string', 'required' => false, 'example' => 'xxxStream', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time.'."\n" + ."\n" + .'> Use UTC format. Example: 2016-06-29T19:00:00Z', 'type' => 'string', 'required' => true, 'example' => '2016-06-29T19:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time.'."\n" + ."\n" + .'> - Use UTC format. Example: 2016-06-30T19:00:00Z'."\n" + .'>'."\n" + .'> - The interval between EndTime and StartTime must not exceed 30 days.', 'type' => 'string', 'required' => true, 'example' => '2016-06-30T19:00:00Z', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 3000.
'."\n" + .'Valid values: 1 to 3000.
', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '2000', 'example' => '3000', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], - ], - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'StreamType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The stream type. Valid values:'."\n" + ."\n" + .'- all (all streams) (default)'."\n" + ."\n" + .'- raw (raw stream)'."\n" + ."\n" + .'- trans (transcoded stream)', 'type' => 'string', - 'required' => true, - 'example' => 'cn-qingdao', + 'required' => false, + 'enum' => ['all', 'raw', 'trans'], + 'example' => 'all', + 'title' => '', ], ], [ - 'name' => 'GroupId', + 'name' => 'QueryType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Specifies whether to use fuzzy matching for the stream name. Valid values:'."\n" + ."\n" + .'- fuzzy (fuzzy match)'."\n" + ."\n" + .'- strict (exact match)', 'type' => 'string', - 'required' => true, - 'example' => '3484*****8732174-cn-qingdao', + 'required' => false, + 'enum' => ['fuzzy', 'strict'], + 'example' => 'fuzzy', + 'title' => '', ], ], [ - 'name' => 'DeviceId', + 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- stream\\_name\\_desc (sort by stream name in descending order)'."\n" + ."\n" + .'- stream\\_name\\_asc (sort by stream name in ascending order)'."\n" + ."\n" + .'- publish\\_time\\_desc (sort by publish time in descending order)'."\n" + ."\n" + .'- publish\\_time\\_asc (sort by publish time in ascending order) (default)', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'example' => '3939*****6580539-cn-qingdao', + 'required' => false, + 'enum' => ['stream_name_desc', 'stream_name_asc', 'publish_time_desc', 'publish_asc'], + 'example' => 'publish_time_asc', + 'title' => '', ], ], ], @@ -11908,44 +11926,127 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageNum' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '119F7639-4646-51A4-B6C1-300D391C0104', 'title' => ''], + 'TotalNum' => ['description' => 'The total number of matching entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'PublishInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LiveStreamPublishInfo' => [ + 'description' => 'The stream ingest records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EdgeNodeAddr' => ['description' => 'The IP address of the Alibaba Cloud CDN upstream node.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], + 'PublishUrl' => ['description' => 'The full URL used to ingest the stream.', 'type' => 'string', 'example' => 'https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8', 'title' => ''], + 'StreamName' => ['description' => 'The live stream name.', 'type' => 'string', 'example' => 'xxxStream', 'title' => ''], + 'DomainName' => ['description' => 'The accelerated domain name of the stream.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'StopTime' => ['description' => 'The time when stream ingest stopped. Use UTC format.', 'type' => 'string', 'example' => '2016-06-29T19:00:00Z', 'title' => ''], + 'TranscodeId' => ['description' => 'The transcoding template ID.'."\n" + ."\n" + .'> This field is returned only if the stream was transcoded.', 'type' => 'string', 'example' => '3888920****8138204-cn-qingdao', 'title' => ''], + 'PublishDomain' => ['description' => 'The ingest domain name.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'AppName' => ['description' => 'The application name of the stream.', 'type' => 'string', 'example' => 'xxxApp', 'title' => ''], + 'PublishTime' => ['description' => 'The time when stream ingest started. Use UTC format.', 'type' => 'string', 'example' => '2016-06-29T19:00:00Z', 'title' => ''], + 'PublishType' => ['description' => 'The stream ingest type. Valid values:'."\n" + ."\n" + .'- edge (edge ingest)'."\n" + ."\n" + .'- center (live center ingest)', 'type' => 'string', 'example' => 'center', 'title' => ''], + 'Transcoded' => ['description' => 'Indicates whether the stream is transcoded. Valid values:'."\n" + ."\n" + .'- yes'."\n" + ."\n" + .'- no', 'type' => 'string', 'example' => 'yes', 'title' => ''], + 'ClientAddr' => ['description' => 'The IP address of the streamer.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''], + 'StreamUrl' => ['description' => 'The URL of the live stream.', 'type' => 'string', 'example' => 'https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"\\n BEA5625F-8FCF-48F4-851B-CA63946DA664\\n","errorExample":""}]', - 'title' => 'BindPurchasedDevice', - ], - 'UnbindPurchasedDevice' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalPage\\": 1,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 3000,\\n \\"RequestId\\": \\"119F7639-4646-51A4-B6C1-300D391C0104\\",\\n \\"TotalNum\\": 200,\\n \\"PublishInfo\\": {\\n \\"LiveStreamPublishInfo\\": [\\n {\\n \\"EdgeNodeAddr\\": \\"192.168.0.1\\",\\n \\"PublishUrl\\": \\"https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8\\",\\n \\"StreamName\\": \\"xxxStream\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"StopTime\\": \\"2016-06-29T19:00:00Z\\",\\n \\"TranscodeId\\": \\"3888920****8138204-cn-qingdao\\",\\n \\"PublishDomain\\": \\"example.aliyundoc.com\\",\\n \\"AppName\\": \\"xxxApp\\",\\n \\"PublishTime\\": \\"2016-06-29T19:00:00Z\\",\\n \\"PublishType\\": \\"center\\",\\n \\"Transcoded\\": \\"yes\\",\\n \\"ClientAddr\\": \\"192.168.0.1\\",\\n \\"StreamUrl\\": \\"https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve VS Stream Ingest Records', + 'summary' => 'Retrieve stream ingest records for a domain, an application under that domain, or a specific stream within a specified time range.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '# Special error codes '."\n" + .'| Error Code | Description | HTTP Status Code | Semantics |'."\n" + .'| :----- | :----- | :----- | :----- |'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | An unknown error occurred in the backend. |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain name was not found under the current account. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | The current operation is not supported, such as for a non-live-streaming domain. |'."\n" + .'| InvalidStartTime.Malformed | Specified parameter StartTime is not valid. | 400 | The start time is invalid. |'."\n" + .'| InvalidEndTime.Malformed | Specified parameter EndTime is not valid. | 400 | The end time is invalid. |'."\n" + .'| InvalidEndTime.Mismatch | Specified end time does not match the specified start time. | 400 | The end time does not match the start time. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVsStreamsPublishList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsStreamsPublishList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsTopDomainsByFlow' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'DeviceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3939*****6580539-cn-qingdao', - ], + 'schema' => ['description' => 'The start of the time range to query. The date format follows the ISO 8601 standard and uses UTC.
Format: YYYY-MM-DDThh:mm:ssZ
The minimum data granularity is 5 minutes.
If you do not specify this parameter, data for the current month is queried.


', 'type' => 'string', 'required' => false, 'example' => '2021-12-12T10:00:00Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. The end time must be later than the start time. The date format follows the ISO 8601 standard and uses UTC.
Format: YYYY-MM-DDThh:mm:ssZ
', 'type' => 'string', 'required' => false, 'example' => '2018-12-10T18:00:00Z', 'title' => ''], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of domain names to return. The default value is 20. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'example' => '3', 'title' => ''], ], ], 'responses' => [ @@ -11953,588 +12054,757 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ + 'DomainOnlineCount' => ['description' => 'The total number of **running** domain names under your account.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the query time range.', 'type' => 'string', 'example' => '2018-12-10T18:00:00Z', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the query.', 'type' => 'string', 'example' => '2021-12-10T10:00:00Z', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'DomainCount' => ['description' => 'The total number of domain names under your account.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TopDomains' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TopDomain' => [ + 'description' => 'A list of the top domain names.', + 'type' => 'array', + 'items' => [ + 'description' => 'A list of the top-ranked domains.', + 'type' => 'object', + 'properties' => [ + 'MaxBps' => ['description' => 'The peak bandwidth.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'Rank' => ['description' => 'The rank.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TotalAccess' => ['description' => 'The number of access requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'TrafficPercent' => ['description' => 'The traffic percentage.', 'type' => 'string', 'example' => '30.64191989360235', 'title' => ''], + 'DomainName' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'example.aliyundoc.com', 'title' => ''], + 'TotalTraffic' => ['description' => 'The total traffic.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'MaxBpsTime' => ['description' => 'The time when the peak bandwidth was reached.', 'type' => 'string', 'example' => '1457111400', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"\\n BEA5625F-8FCF-48F4-851B-CA63946DA664\\n","errorExample":""}]', - ], - 'BatchBindPurchasedDevices' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidStartTime.Malformed', 'errorMessage' => 'The format of the specified StartTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Malformed', 'errorMessage' => 'The format of the specified EndTime is invalid.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ['errorCode' => 'InvalidStartTime.ValueNotSupported', 'errorMessage' => 'The specified StartTime is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DomainOnlineCount\\": 12,\\n \\"EndTime\\": \\"2018-12-10T18:00:00Z\\",\\n \\"StartTime\\": \\"2021-12-10T10:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainCount\\": 20,\\n \\"TopDomains\\": {\\n \\"TopDomain\\": [\\n {\\n \\"MaxBps\\": 100,\\n \\"Rank\\": 1,\\n \\"TotalAccess\\": 100,\\n \\"TrafficPercent\\": \\"30.64191989360235\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"TotalTraffic\\": \\"100\\",\\n \\"MaxBpsTime\\": \\"1457111400\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Obtain top-level domains ', + 'summary' => 'Retrieves a user\'s domain names ranked by traffic.'."\n" + .'If you do not specify StartTime and EndTime, data for the current month is retrieved by default. To query data over a specific time range, you must specify both StartTime and EndTime.'."\n" + .'\\* You can retrieve data for a maximum of 90 days.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsTopDomainsByFlow'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsTopDomainsByFlow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsUpPeakPublishStreamData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Region', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-qingdao', - ], + 'schema' => ['description' => 'Start time of stream ingest, in UTC format. The time range between StartTime and EndTime must be within 30 days.', 'type' => 'string', 'required' => true, 'example' => '2017-12-10T20:00:00Z', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****174-cn-qingdao', - ], + 'schema' => ['description' => 'End time of stream ingest, in UTC format. The time range between StartTime and EndTime must be within 30 days. EndTime must be later than the current time.', 'type' => 'string', 'required' => true, 'example' => '2017-12-10T21:00:00Z', 'title' => ''], ], [ - 'name' => 'DeviceId', + 'name' => 'DomainSwitch', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Enables or disables domain-level statistics. Valid values: on or off. When set to on, the response shows domain-level data. When set to off or omitted, the response shows user-level data. Default is user-level data.', 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', + 'required' => false, + 'enum' => ['on', 'off'], + 'example' => 'on', + 'title' => '', ], ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'Domain name to query. Returns data at the domain granularity.', 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'some error', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '238*****380-cn-qingdao', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'Region' => [ + 'RequestId' => ['description' => 'ID of the request.', 'type' => 'string', 'example' => '27A3C548-A699-48F9-97CD-F35D81075AF3', 'title' => ''], + 'DescribeVsUpPeakPublishStreamDatas' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DescribeVsUpPeakPublishStreamData' => [ + 'description' => 'Daily peak concurrent stream ingest data.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'QueryTime' => ['description' => 'The query timestamp for the day.', 'type' => 'string', 'example' => '1522166400000', 'title' => ''], + 'BandWidth' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StatName' => ['description' => 'Name of the statistical property. When DomainSwitch is on, this field shows the live streaming domain name. When DomainSwitch is off or omitted, this field shows the user ID.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'PeakTime' => ['description' => 'The peak time for daily concurrent stream ingests.', 'type' => 'string', 'example' => '1522252320000', 'title' => ''], + 'PublishStreamNum' => ['description' => 'Daily peak number of concurrent stream ingest operations.', 'type' => 'integer', 'format' => 'int32', 'example' => '31', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => 'cn-qingdao', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"GroupId\\": \\"238*****380-cn-qingdao\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\",\\n \\"Region\\": \\"cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'BatchUnbindDirectories' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27A3C548-A699-48F9-97CD-F35D81075AF3\\",\\n \\"DescribeVsUpPeakPublishStreamDatas\\": {\\n \\"DescribeVsUpPeakPublishStreamData\\": [\\n {\\n \\"QueryTime\\": \\"1522166400000\\",\\n \\"BandWidth\\": \\"\\",\\n \\"StatName\\": \\"example.com\\",\\n \\"PeakTime\\": \\"1522252320000\\",\\n \\"PublishStreamNum\\": 31\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query the daily peak concurrent stream ingest count for a user', + 'summary' => 'Queries the daily peak number of concurrent stream ingest operations.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsUpPeakPublishStreamData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsUpPeakPublishStreamData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeVsUserResourcePackage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'DirectoryId', - 'in' => 'query', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ResourcePackageInfos' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ResourcePackageInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CommodityCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CurrCapacity' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'InitCapacity' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '399*****488-cn-qingdao', + 'title' => '', + 'example' => '', ], ], + ], + 'changeSet' => [ + ['createdAt' => '2024-01-24T16:00:09.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsUserResourcePackage'], + ], + ], + 'ramActions' => [ [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsUserResourcePackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"ResourcePackageInfos\\": {\\n \\"ResourcePackageInfo\\": [\\n {\\n \\"DisplayName\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"CommodityCode\\": \\"\\",\\n \\"CurrCapacity\\": \\"\\",\\n \\"InitCapacity\\": \\"\\",\\n \\"InstanceId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'DescribeVsVerifyContent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'The Visual Edge Computing Service domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '64DB7F34-11A8-45DC-A421-40ACF446282C', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'An error occurred while processing your request.', - ], - 'DirectoryId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****488-cn-qingdao', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - ], - ], - ], + 'Content' => ['description' => '校验内容。', 'type' => 'string', 'example' => 'verify_dffeb6610035dcb77b413a59c3*****', 'title' => ''], + 'RequestId' => ['title' => '', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"64DB7F34-11A8-45DC-A421-40ACF446282C\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"An error occurred while processing your request.\\",\\n \\"DirectoryId\\": \\"399*****488-cn-qingdao\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchUnbindDirectories', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"verify_dffeb6610035dcb77b413a59c3*****\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsVerifyContent'], + ], + ], + 'ramActions' => [], + 'summary' => 'DescribeVsVerifyContent', + 'title' => '', ], - 'BatchUnbindPurchasedDevices' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DisassociateRenderingProjectInstances' => [ + 'summary' => 'Disassociate cloud application service instances from a project.', + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], + ], 'parameters' => [ [ - 'name' => 'DeviceId', + 'name' => 'ProjectId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], + ], + [ + 'name' => 'RenderingInstanceIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'A list of cloud application service instance IDs.', + 'type' => 'array', + 'items' => ['description' => 'A cloud application service instance ID.', 'type' => 'string', 'required' => false, 'example' => 'render-a371588064324c57b7b0133a96cbd17a', 'title' => ''], 'required' => true, - 'example' => '348*****380-cn-qingdao', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'SuccessInstances' => [ + 'description' => 'A list of instances that were successfully dissociated.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID and result message for each successfully dissociated instance.', + 'type' => 'object', + 'properties' => [ + 'RenderingInstanceId' => ['description' => 'A cloud application service instance ID.', 'type' => 'string', 'title' => '', 'example' => 'render-e6cf423c787e4e43b460a788da254fe3'], + 'Message' => ['description' => 'The result message.', 'type' => 'string', 'title' => '', 'example' => 'success'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Results' => [ - 'description' => '', + 'FailedInstances' => [ + 'description' => 'A list of instances that failed to dissociate.', 'type' => 'array', 'items' => [ + 'description' => 'The ID and error message for each instance that failed to dissociate.', 'type' => 'object', 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'some error', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], + 'RenderingInstanceId' => ['description' => 'A cloud application service instance ID.', 'type' => 'string', 'example' => 'render-421cd2a1125947c19fcd5c7dd2c7d31e', 'title' => ''], + 'Message' => ['description' => 'The reason for failure.', 'type' => 'string', 'title' => '', 'example' => '会话中'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'SuccessInstanceCount' => ['description' => 'The number of cloud application service instances that were successfully dissociated.', 'type' => 'string', 'title' => '', 'example' => '5'], + 'FailedInstanceCount' => ['description' => 'The number of cloud application service instances that failed to dissociate.', 'type' => 'string', 'title' => '', 'example' => '0'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'StartStream' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SuccessInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-e6cf423c787e4e43b460a788da254fe3\\",\\n \\"Message\\": \\"success\\"\\n }\\n ],\\n \\"FailedInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-421cd2a1125947c19fcd5c7dd2c7d31e\\",\\n \\"Message\\": \\"会话中\\"\\n }\\n ],\\n \\"SuccessInstanceCount\\": \\"5\\",\\n \\"FailedInstanceCount\\": \\"0\\"\\n}","type":"json"}]', + 'title' => 'Disassociate instances from project ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:DisassociateRenderingProjectInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ForbidVsStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'The accelerated domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'xxxApp', 'title' => ''], + ], + [ + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => ['description' => 'The stream name.', 'type' => 'string', 'required' => true, 'example' => 'xxxStream', 'title' => ''], + ], + [ + 'name' => 'LiveStreamType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Only "publisher" is supported.', 'type' => 'string', 'required' => true, - 'example' => '323*****997-cn-qingdao', + 'enum' => ['publisher'], + 'example' => 'publisher', + 'title' => '', ], ], [ - 'name' => 'StartTime', + 'name' => 'Oneshot', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Specifies whether to only interrupt the stream without adding it to the blacklist. A value of \\`yes\\` indicates that the stream is only interrupted.', + 'type' => 'string', 'required' => false, - 'example' => '1589336385', + 'enum' => ['yes', 'no'], + 'example' => 'yes', + 'title' => '', ], ], [ - 'name' => 'EndTime', + 'name' => 'ControlStreamAction', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'type' => 'string', 'required' => false, - 'example' => '1599336385', + 'default' => 'forbid', + 'enum' => ['forbid'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'ResumeTime', + 'in' => 'query', + 'schema' => ['description' => 'The time to resume the stream. The time is in UTC format.', 'type' => 'string', 'required' => false, 'example' => '2015-12-01T17:37:00Z', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '31000000000000000002', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****997-cn-qingdao', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '119F7639-4646-51A4-B6C1-300D391C0104', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Name\\": \\"31000000000000000002\\",\\n \\"Id\\": \\"323*****997-cn-qingdao\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - ], - 'StopStream' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"119F7639-4646-51A4-B6C1-300D391C0104\\"\\n}","type":"json"}]', + 'title' => 'Prohibit the push of a specific stream', + 'summary' => 'Forbids pushing a specific stream. You can schedule a time to resume the stream.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '# Special error codes '."\n" + .'| Error Code | Description | HTTP Status Code | Semantics |'."\n" + .'| :----- | :----- | :----- | :----- |'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | An unknown error occurred in the backend. |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain was not found under the current account. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | The current operation is not supported, such as using a non-live streaming domain. |'."\n" + .'| InvalidResumeTime.Malformed | Specified parameter ResumeTime is not valid. | 400 | The end time is invalid. |'."\n" + .'| QuotaExceeded.Blacklist | Exceed max blacklist count limit | 400 | The number of blacklist entries exceeds the upper limit (default: 1 000). |'."\n" + .'| ConfigAlreadyExists | Config has already exist. | 400 | The configuration already exists. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ForbidVsStream'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:ForbidVsStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetRenderingInstanceCommandsStatus' => [ + 'summary' => 'Queries the execution status of a control command to determine whether the command was successful and to retrieve the result string.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213860', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '32388487****92997-cn-qingdao', - ], - ], - [ - 'name' => 'Name', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '31000000*****0000002', - ], + 'schema' => ['description' => 'Cloud application service instance ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'StartTime', + 'name' => 'CmdId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-12-12T10:00:00Z', - ], + 'schema' => ['description' => 'Unique ID of the command delivery request', 'type' => 'string', 'deprecated' => false, 'required' => true, 'title' => '', 'example' => 'cmd-81de027b66e442e99c1e0e09a16a0be5'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '32388487****92997-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Result' => ['description' => 'Command execution result string', 'type' => 'string', 'title' => '', 'example' => 'Thu Jun 27 16:06:26 CST 2024'], + 'Status' => ['description' => 'Command execution status. Valid values:'."\n" + ."\n" + .'1. Doing: Executing'."\n" + ."\n" + .'2. Success: Succeeded'."\n" + ."\n" + .'3. Failed: Failed. The system automatically retries within the timeout period. You can either wait or resend the request.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Message' => ['description' => 'Description. When Status=Failed, this field contains the failure reason.', 'type' => 'string', 'title' => '', 'example' => 'conn failed!'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"32388487****92997-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'StopStream', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BatchStartStreams' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Result\\": \\"Thu Jun 27 16:06:26 CST 2024\\",\\n \\"Status\\": \\"Success\\",\\n \\"Message\\": \\"conn failed!\\"\\n}","type":"json"}]', + 'title' => 'View Execution Status of Instance Control Command', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRenderingInstanceCommandsStatus'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:GetRenderingInstanceCommandsStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#accountId}:crs/{#CrsId}'], + ], + ], + ], ], + ], + 'GetRenderingInstanceStreamingInfo' => [ + 'summary' => 'Retrieves the streaming connection information for a cloud application service instance. Call this operation before establishing each streaming connection to obtain the latest connection details.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '199704', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****997-cn-qingdao', - ], + 'schema' => ['description' => 'Cloud application service instance ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'stream not found', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '31000000*****0000002', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****997-cn-qingdao', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'RenderingInstanceId' => ['description' => 'Cloud application service instance ID', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], + 'Gateway' => ['description' => 'Domain name of the cloud application service instance streaming gateway', 'type' => 'string', 'example' => '10.178.208.22', 'title' => ''], + 'Hostname' => ['description' => 'Hostname or IP address of the cloud application service instance stream', 'type' => 'string', 'example' => '10.18.20.2', 'title' => ''], + 'Port' => ['description' => 'Streaming connection port', 'type' => 'string', 'example' => '10003', 'title' => ''], + 'FlowId' => ['description' => 'Token for this connection', 'type' => 'string', 'example' => '792fy125-594c-4dde-ab35-9ff8hrf0a86f', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"stream not found\\",\\n \\"Name\\": \\"31000000*****0000002\\",\\n \\"Id\\": \\"323*****997-cn-qingdao\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchStartStreams', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BatchStopStreams' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"Gateway\\": \\"10.178.208.22\\",\\n \\"Hostname\\": \\"10.18.20.2\\",\\n \\"Port\\": \\"10003\\",\\n \\"FlowId\\": \\"792fy125-594c-4dde-ab35-9ff8hrf0a86f\\"\\n}","type":"json"}]', + 'title' => 'Query stream connection information of a cloud application service instance ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRenderingInstanceStreamingInfo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:GetRenderingInstanceStreamingInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], ], + ], + 'GetRenderingProjectInstanceStateMetrics' => [ + 'summary' => 'Queries the data volume statistics for the states of project instances that meet specified conditions.', + 'path' => '/', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], + ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****997-cn-qingdao', - ], - ], - [ - 'name' => 'StartTime', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-12-10T10:00:00Z', - ], + 'schema' => ['description' => 'Project ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Results' => [ - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'StateMetrics' => [ + 'description' => 'List of project instance state statistics', 'type' => 'array', 'items' => [ + 'description' => 'Project instance state statistics', 'type' => 'object', 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'stream not found', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3100000*****00000002', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****997-cn-qingdao', - ], + 'State' => ['description' => 'Project instance state', 'type' => 'string', 'title' => '', 'example' => 'Idle'], + 'Count' => ['description' => 'Number of instances', 'type' => 'string', 'title' => '', 'example' => '10'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"stream not found\\",\\n \\"Name\\": \\"3100000*****00000002\\",\\n \\"Id\\": \\"323*****997-cn-qingdao\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchStopStreams', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeStream' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"StateMetrics\\": [\\n {\\n \\"State\\": \\"Idle\\",\\n \\"Count\\": \\"10\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query instance status statistics information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:GetRenderingProjectInstanceStateMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GotoPreset' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****997-cn-qingdao', - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'PresetId', + 'in' => 'query', + 'schema' => ['description' => 'Preset ID.', 'type' => 'string', 'required' => true, 'example' => '2', 'title' => ''], ], ], 'responses' => [ @@ -12542,832 +12812,759 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'on', - ], - 'PlayDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'Protocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gb28181', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'Height' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '720', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****174-cn-qingdao', - ], - 'Width' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1280', - ], - 'App' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'live', - ], - 'Enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '31000000*****0000002', - ], - 'PushDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'demo.aliyundoc.com', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2019-02-28T17:00:17Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****997-cn-qingdao', - ], + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '30295DF1-1DC7-48BA-BE5A-D58E61EB2375', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"on\\",\\n \\"PlayDomain\\": \\"example.aliyundoc.com\\",\\n \\"Protocol\\": \\"gb28181\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\",\\n \\"Height\\": 720,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"Width\\": 1280,\\n \\"App\\": \\"live\\",\\n \\"Enabled\\": true,\\n \\"Name\\": \\"31000000*****0000002\\",\\n \\"PushDomain\\": \\"demo.aliyundoc.com\\",\\n \\"CreatedTime\\": \\"2019-02-28T17:00:17Z\\",\\n \\"Id\\": \\"323*****997-cn-qingdao\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeStream', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"30295DF1-1DC7-48BA-BE5A-D58E61EB2375\\"\\n}","type":"json"}]', + 'title' => 'Shift to a preset position', + 'summary' => 'Moves to a specified preset.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeStreams' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GotoPreset'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:GotoPreset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'InstallCloudApp' => [ + 'summary' => 'Installs a cloud application to a specified cloud application instance. This is an asynchronous interface. To monitor the installation progress, use the ListCloudAppInstallations interface.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207914', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '323*****997-cn-qingdao', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '348*****174-cn-qingdao', - ], - ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '348*****380-cn-qingdao', - ], - ], - [ - 'name' => 'ParentId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '399*****774-cn-qingdao', - ], - ], - [ - 'name' => 'Name', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3100000*****00000002', - ], + 'schema' => ['description' => 'Cloud application service instance ID', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'Domain', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example.aliyundoc.com', - ], + 'schema' => ['description' => 'Cloud application ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], ], [ - 'name' => 'App', + 'name' => 'RenderingInstanceIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'maxItems' => 100, + 'description' => 'List of cloud application service instance IDs', + 'title' => 'List of cloud application service instance IDs', + 'type' => 'array', + 'items' => ['title' => 'Cloud application service instance ID', 'description' => 'Cloud application service instance ID', 'type' => 'string', 'required' => false, 'example' => 'render-4523e7b93ca246febd10cd12347d70c0'], 'required' => false, - 'example' => 'live', + 'example' => '', ], ], [ - 'name' => 'SortBy', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Id', - ], + 'schema' => ['title' => 'Project ID', 'description' => 'Project ID', 'type' => 'string', 'required' => false, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], ], [ - 'name' => 'SortDirection', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - ], + 'schema' => ['title' => 'Maximum number of selected instances under the project. This parameter takes effect only when ProjectId is Not Null. It limits the maximum number of instances on which the action is executed within the project to control the impact scope. Default value: 100. Valid values: 1–100. ', 'description' => 'Maximum number of instances selected for the project. This applies only when ProjectId is not empty. It limits the maximum number of instances for actions within the project, controlling the impact scope. Default is 100. The value range is 1-100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '100', 'required' => false, 'example' => '10'], ], [ - 'name' => 'PageSize', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => 'The page number for paged query of instance associations under a project (paged queries are sorted in descending order by instance association time by default). This parameter is valid only when ProjectId is not empty. It limits the maximum number of instances on which an action can be executed within the project to control the impact scope. Default value: 1. '."\n" + .'1. Regarding the valid range of PageNumber: '."\n" + .' a. [Recommended] Method 1: Calculate the upper limit based on the total number of instances associated with the project (obtainable via the ListRenderingProjectInstances API). '."\n" + .' b. Method 2: Determine whether PageName has reached the project\'s upper limit based on the API return value. [Advantage: No need to calculate the valid range.] PageNumber is considered to have reached its upper limit if either of the following conditions is met: '."\n" + .' i. The API returns a 403 error with error code Code 200301. '."\n" + .' ii. The sum of SuccessInstanceCount and FailedInstanceCount in the API response is less than PageSize. '."\n" + .'2. Scenario examples: '."\n" + .' a. Full installation scenario for all instances under a project: When the number of project instances exceeds PageSize (default: 100), you can repeatedly invoke Install with PageNumber incremented by 1 to achieve full installation. You can obtain the installation progress via the ListCloudAppInstallations API. '."\n" + .' b. Installation scenario for newly added instances under a project: Start with PageNumber=1. Since paged queries are sorted in descending order by instance association time by default, the latest newly added instances appear on the PageNumber=1 page.'."\n", 'description' => 'Page number for paged queries of instance associations under the project. Paged queries default to reverse order by instance association time. This applies only when ProjectId is not empty. It limits the maximum number of instances for actions within the project, controlling the impact scope. Default is 1.'."\n" + ."\n" + .'1. PageNumber value range:'."\n" + .' a. Method one (recommended): Calculate the upper limit using the total number of instances associated with the project. The ListRenderingProjectInstances interface provides this count.'."\n" + .' b. Method two: Determine if PageNumber reaches the project\'s upper limit by checking the interface return value. This avoids calculating the range. PageNumber reaches the upper limit if the interface returns any of these conditions:'."\n" + .' ⅰ. A 403 status code and error code 200301.'."\n" + .' ⅱ. The sum of \\`SuccessInstanceCount\\` and \\`FailedInstanceCount\\` is less than \\`PageSize\\`.'."\n" + ."\n" + .'2. Scenario examples:'."\n" + .' a. Full installation for project instances: If the number of project instances exceeds \\`PageSize\\` (default 100), invoke Install multiple times. Increment PageNumber by 1 for each call to complete the full installation. Get project instance installation progress using the ListCloudAppInstallations interface.'."\n" + .' b. New instance installation for a project: Start with \\`PageNumber=1\\`. Paged queries default to reverse order by instance association time. The \\`PageNumber=1\\` page shows the latest new instances.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1'], ], [ - 'name' => 'PageNum', + 'name' => 'PatchId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => 'The ID of the patch package to install. Supported only in Windows scenarios. '."\n" + .'1. By default, StablePatchId is installed. '."\n" + .'2. Specifying the value "origin" indicates installation of the original version.', 'description' => 'Patch package ID to install. This is only for Windows scenarios.'."\n" + ."\n" + .'1. Install \\`StablePatchId\\` by default.'."\n" + ."\n" + .'2. Enter \\`origin\\` to install the original version.', 'type' => 'string', 'example' => 'patch-7bdf679812484df08a956b73e0b3bdf6', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'SuccessInstanceCount' => ['title' => 'Number of successfully processed cloud application service instances ', 'description' => 'Number of successful cloud application service instances', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'SuccessInstances' => [ + 'description' => 'List of successful cloud application service instances', + 'title' => 'List of successful cloud application service instances ', + 'type' => 'array', + 'items' => [ + 'description' => 'Cloud application service instance', + 'title' => 'Cloud application service instance ', + 'type' => 'object', + 'properties' => [ + 'RenderingInstanceId' => ['title' => 'Cloud application service instance ID ', 'description' => 'Cloud application service instance ID', 'type' => 'string', 'example' => 'render-5130e2feb23f442fb9456a3d977f03d4'], + ], + 'example' => '', + ], + 'example' => '', ], - 'Streams' => [ - 'description' => '', + 'FailedInstanceCount' => ['title' => 'Number of failed cloud application service instances ', 'description' => 'Number of failed cloud application service instances', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'FailedInstances' => [ + 'description' => 'List of failed cloud application service instances', + 'title' => 'List of failed cloud application service instances ', 'type' => 'array', 'items' => [ + 'description' => 'Failed cloud application service instance', + 'title' => 'Failed cloud application service instance ', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'on', - ], - 'PlayDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'demo.aliyundoc.com', - ], - 'Protocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gb28181', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'Height' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '720', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****174-cn-qingdao', - ], - 'App' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'live', - ], - 'Width' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1280', - ], - 'Enabled' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '31000000*****0000002', - ], - 'PushDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-12-10T17:00:00Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****997-cn-qingdao', - ], + 'RenderingInstanceId' => ['title' => 'Cloud application service instance ID ', 'description' => 'Cloud application service instance ID', 'type' => 'string', 'example' => 'render-b45f28650ffe4591bf4c5c95996a428c'], + 'ErrMessage' => ['title' => 'Failure reason message ', 'description' => 'Failure reason message', 'type' => 'string', 'example' => 'Rejected due to timeout'], + 'ErrCode' => ['description' => 'Failure error code', 'type' => 'integer', 'format' => 'int32', 'example' => '300000', 'title' => ''], ], + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 5,\\n \\"Streams\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"PlayDomain\\": \\"demo.aliyundoc.com\\",\\n \\"Protocol\\": \\"gb28181\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\",\\n \\"Height\\": 720,\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"App\\": \\"live\\",\\n \\"Width\\": 1280,\\n \\"Enabled\\": true,\\n \\"Name\\": \\"31000000*****0000002\\",\\n \\"PushDomain\\": \\"example.aliyundoc.com\\",\\n \\"CreatedTime\\": \\"2018-12-10T17:00:00Z\\",\\n \\"Id\\": \\"323*****997-cn-qingdao\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeStreamURL' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SuccessInstanceCount\\": 5,\\n \\"SuccessInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-5130e2feb23f442fb9456a3d977f03d4\\"\\n }\\n ],\\n \\"FailedInstanceCount\\": 0,\\n \\"FailedInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-b45f28650ffe4591bf4c5c95996a428c\\",\\n \\"ErrMessage\\": \\"Rejected due to timeout\\",\\n \\"ErrCode\\": 300000\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Install application ', + 'changeSet' => [ + ['createdAt' => '2025-08-21T12:22:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:InstallCloudApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallCloudApp'], + ], ], + ], + 'ListCloudAppInstallations' => [ + 'summary' => 'Lists cloud application installations. The response includes the installation status of cloud application service instances and supports paged queries.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207921', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****997-cn-qingdao', - ], + 'schema' => ['description' => 'Cloud application ID. Each ID maps to a unique application package.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], + ], + [ + 'name' => 'RenderingInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Cloud application service instance ID. Use this to list installations on a specific instance.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'Type', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'live', - 'default' => 'live', - ], + 'schema' => ['description' => 'Application name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'com.aaa.bbb'], ], [ - 'name' => 'OutProtocol', + 'name' => 'AppVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'rtmp', - ], + 'schema' => ['description' => 'Application version.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1.0'], ], [ - 'name' => 'Auth', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['title' => 'Project ID ', 'description' => 'Project ID.', 'type' => 'string', 'required' => false, 'example' => 'project-b93ea81de76f48609eed3cd420f0399f'], ], [ - 'name' => 'AuthKey', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ocs*****ace', - ], + 'schema' => ['description' => 'Page number of the returned list. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Expire', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600', - ], + 'schema' => ['description' => 'Number of entries per page for paged queries. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1571639499', - ], + 'schema' => ['title' => 'Time range filter parameter. Specified in ISO8601 standard format using UTC time, formatted as yyyy-MM-ddTHH:mm:ssZ. ', 'description' => 'Start time of the time range filter. Specify in ISO 8601 format using UTC time. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2025-05-26T16:00:00Z'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1571649499', - ], + 'schema' => ['title' => 'Time range filter parameter. Specified in ISO8601 standard format using UTC time, formatted as yyyy-MM-ddTHH:mm:ssZ. ', 'description' => 'Time range filter. Use ISO 8601 format and UTC time, such as yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2025-06-02T02:18:00Z'], ], [ - 'name' => 'Transcode', + 'name' => 'PatchId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sd', - ], + 'schema' => ['title' => 'Patch package ID. Supported only in Windows scenarios. '."\n" + .'1. Enter the value "origin" to filter only the original version. ', 'description' => 'Patch package ID. Supported only in Windows scenarios.'."\n" + ."\n" + .'1. Set to origin to return only original versions.', 'type' => 'string', 'example' => 'patch-7bdf679812484df08a956b73e0b3bdf6', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtmp://demo.aliyundoc.com/live/310101*****7542007?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'ExpireTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1557977029', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'InstallationInfos' => [ + 'description' => 'List of installation records.', + 'type' => 'array', + 'items' => [ + 'description' => 'Installation record.', + 'type' => 'object', + 'properties' => [ + 'AppVersion' => ['description' => 'Application version.', 'type' => 'string', 'title' => '', 'example' => '1.5.0'], + 'Status' => ['description' => 'Cloud application installation status. Valid values:'."\n" + ."\n" + .'1. Intermediate states: install-init, installing'."\n" + ."\n" + .'2. Final states: installed, install-failed', 'type' => 'string', 'title' => '', 'example' => 'installed'], + 'AppId' => ['description' => 'Application ID.', 'type' => 'string', 'title' => '', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], + 'RenderingInstanceId' => ['description' => 'Cloud application service instance ID.', 'type' => 'string', 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], + 'StatusDescription' => ['description' => 'Status description.', 'type' => 'string', 'title' => '', 'example' => 'install success'], + 'UpdateTime' => ['description' => 'Time when the status was last updated.', 'type' => 'string', 'title' => '', 'example' => '2024-05-28T14:50:04+08:00'], + 'PatchId' => ['title' => 'PatchId package ID ', 'description' => 'Patch package ID.', 'type' => 'string', 'example' => 'patch-7bdf679812484df08a956b73e0b3bdf6'], + 'InstallationTime' => ['description' => 'Installation time.', 'type' => 'string', 'title' => '', 'example' => '2024-05-28T14:48:34+08:00'], + 'AppName' => ['description' => 'Application name.', 'type' => 'string', 'title' => '', 'example' => 'com.aaa.bbb'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'Total number of installation records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'PageNumber' => ['description' => 'Page number of the returned list.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'Number of entries per page for paged queries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Url\\": \\"rtmp://demo.aliyundoc.com/live/310101*****7542007?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"ExpireTime\\": 1557977029\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeStreamURL', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeVodStreamURL' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"InstallationInfos\\": [\\n {\\n \\"AppVersion\\": \\"1.5.0\\",\\n \\"Status\\": \\"installed\\",\\n \\"AppId\\": \\"cap-b06b26edfhytbn b94a75ae1a79efc90eb\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"StatusDescription\\": \\"install success\\",\\n \\"UpdateTime\\": \\"2024-05-28T14:50:04+08:00\\",\\n \\"PatchId\\": \\"patch-7bdf679812484df08a956b73e0b3bdf6\\",\\n \\"InstallationTime\\": \\"2024-05-28T14:48:34+08:00\\",\\n \\"AppName\\": \\"com.aaa.bbb\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'title' => 'Query application installation information list ', + 'changeSet' => [ + ['createdAt' => '2025-08-21T12:22:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCloudAppInstallations'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListCloudAppInstallations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], ], + ], + 'ListCloudAppPatches' => [ + 'summary' => 'Queries the list of patches for a cloud application.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207913', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'Url', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'http://xxx/xxx.mp4', - ], + 'schema' => ['description' => 'The ID of the cloud application. This ID corresponds to a unique application package.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], ], [ - 'name' => 'TxId', + 'name' => 'PatchName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the patch package.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'patch-1'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtsp://domain/live/stream?sign=xxxxxx', - ], - 'OutProtocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtsp', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8080', - ], - 'TxId' => [ - 'type' => 'string', - ], - ], - ], + [ + 'name' => 'PatchId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the patch package.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4'], ], - ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Url\\": \\"rtsp://domain/live/stream?sign=xxxxxx\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"OutProtocol\\": \\"rtsp\\",\\n \\"Port\\": 8080\\n}","type":"json"}]', - ], - 'DescribeStreamVodList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the list to return. The value starts from 1.'."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], ], - ], - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '18526049*****219118918-cn-beijing', - ], + 'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 100.'."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '20'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1639077653', - ], + 'schema' => ['description' => 'The start of the time range to query. The time is in UTC and follows the ISO 8601 standard. The format is yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2015-11-29T00:00:00Z'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1634873413', - ], + 'schema' => ['description' => 'The time range for filtering. The time must be in UTC and in the ISO 8601 standard format yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2017-12-10T21:00:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Records' => [ - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Patches' => [ + 'title' => '', + 'description' => 'The list of cloud application patches.', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'The information about the cloud application patch.', 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1634873413', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1639077653', - ], + 'Status' => ['description' => 'The upload status of the application. Valid values:'."\n" + ."\n" + .'1. Created'."\n" + ."\n" + .'2. Doing'."\n" + ."\n" + .'3. Success: A final state.'."\n" + ."\n" + .'4. Failed: A final state.'."\n" + ."\n" + .'5. Deleting'."\n" + ."\n" + .'6. DeleteFailed: A final state.', 'type' => 'string', 'title' => '', 'example' => 'Doing'], + 'PatchName' => ['description' => 'The name of the patch package.', 'type' => 'string', 'title' => '', 'example' => 'patch-1'], + 'StatusDescription' => ['description' => 'The description of the status.', 'type' => 'string', 'title' => '', 'example' => 'Uploading'], + 'UpdateTime' => ['description' => 'The time when the status was last updated.', 'type' => 'string', 'title' => '', 'example' => '2024-09-23T02:12:28'], + 'PatchId' => ['description' => 'The ID of the patch package.', 'type' => 'string', 'title' => '', 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4'], + 'UploadTime' => ['description' => 'The time when the patch was uploaded.', 'type' => 'string', 'title' => '', 'example' => '2025-07-24T14:45:36+08:00'], ], + 'example' => '', ], + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Records\\": [\\n {\\n \\"EndTime\\": 1634873413,\\n \\"StartTime\\": 1639077653\\n }\\n ]\\n}","type":"json"}]', - ], - 'ForbidVsStream' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Patches\\": [\\n {\\n \\"Status\\": \\"Doing\\",\\n \\"PatchName\\": \\"patch-1\\",\\n \\"StatusDescription\\": \\"Uploading\\",\\n \\"UpdateTime\\": \\"2024-09-23T02:12:28\\",\\n \\"PatchId\\": \\"patch-03fa76e8e13a49b6a966b063d9d309b4\\",\\n \\"UploadTime\\": \\"2025-07-24T14:45:36+08:00\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', + 'title' => 'Query the patch list of a cloud application', + 'description' => '> Specify at least one of the template ID or the template type.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListCloudAppPatches', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListCloudApps' => [ + 'summary' => 'Queries a list of cloud applications. This operation supports paged queries.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207913', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', - ], + 'schema' => ['description' => 'The ID of the cloud application. This ID corresponds to a unique application package.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxxApp', - ], + 'schema' => ['description' => 'Application name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'com.aaa.bbb'], ], [ - 'name' => 'StreamName', + 'name' => 'AppVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxxStream', - ], + 'schema' => ['description' => 'Application version.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1.0'], ], [ - 'name' => 'LiveStreamType', + 'name' => 'PkgType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'title' => 'Package type. Valid values: '."\n" + .'1. android '."\n" + .'2. win', + 'description' => 'The package type. Valid values:'."\n" + ."\n" + .'1. android'."\n" + ."\n" + .'2. win'."\n" + ."\n" + .'3. android\\_appmarket', 'type' => 'string', - 'required' => true, - 'example' => 'publisher', - 'enum' => [ - 'publisher', - ], + 'enum' => ['android', 'win', 'android_appmarket'], + 'required' => false, + 'example' => 'android', ], ], [ - 'name' => 'Oneshot', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'yes', - 'enum' => [ - 'yes', - 'no', - ], - ], + 'schema' => ['description' => 'The page number for the query list. The starting value is 1. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ControlStreamAction', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'default' => 'forbid', - 'enum' => [ - 'forbid', - ], - ], + 'schema' => ['description' => 'The number of rows per page for paged queries. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], ], [ - 'name' => 'ResumeTime', + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => 'Filter parameter for the time range. Specified in ISO8601 standard format using UTC time, with the format yyyy-MM-ddTHH:mm:ssZ.', 'description' => 'The time range filter parameter. Express it in ISO8601 standard format, using UTC time: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-09-29T16:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => 'Filter parameter for the time range. Specified in ISO8601 standard format using UTC time, with the format yyyy-MM-ddTHH:mm:ssZ.', 'description' => 'The time range filter parameter. Express it in ISO8601 standard format, using UTC time: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-09-30T02:23:00Z'], + ], + [ + 'name' => 'LatestVersionOnly', + 'in' => 'query', + 'schema' => ['title' => 'Indicates whether to output only the latest submitted version of the application. Default value is false.', 'description' => 'Return only the latest submitted version of the application. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'PkgLabel', + 'in' => 'query', + 'schema' => ['title' => 'Cloud application label. '."\n" + .'1. Valid values: '."\n" + .' a. hot '."\n" + .' b. game '."\n" + .' c. app '."\n" + .'2. Special case: '."\n" + .' a. To query applications without a label, enter "NULL"', 'description' => 'Valid values:'."\n" + ."\n" + .'1. Valid values:'."\n" + .' a. hot'."\n" + .' b. game'."\n" + .' c. app'."\n" + ."\n" + .'2. Special case:a. To list applications that have no tags, enter NULL.', 'type' => 'string', 'required' => false, 'example' => 'app'], + ], + [ + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2015-12-01T17:37:00Z', - ], + 'schema' => ['title' => 'Application upload status. Valid values: '."\n" + .'1. Success: desired state, Succeeded '."\n" + .'2. Failed: desired state, failed '."\n" + .'3. Created '."\n" + .'4. Doing', 'description' => 'The application upload status. Valid values:'."\n" + ."\n" + .'1. Success: The desired state, indicating success.'."\n" + ."\n" + .'2. Failed: The desired state, indicating failure.'."\n" + ."\n" + .'3. Created'."\n" + ."\n" + .'4. Doing', 'type' => 'string', 'required' => false, 'example' => 'Success'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '119F7639-4646-51A4-B6C1-300D391C0104', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'CloudApps' => [ + 'title' => '', + 'description' => 'List of cloud application information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Cloud application information.', + 'type' => 'object', + 'properties' => [ + 'AppVersion' => ['description' => 'Application version.', 'type' => 'string', 'title' => '', 'example' => '1.5.0'], + 'Status' => ['description' => 'The application upload status. Valid values:'."\n" + ."\n" + .'1. Created'."\n" + ."\n" + .'2. Doing'."\n" + ."\n" + .'3. Success: The desired state.'."\n" + ."\n" + .'4. Failed: The desired state.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Description' => ['description' => 'Application description.', 'type' => 'string', 'title' => '', 'example' => 'demo'], + 'AppId' => ['description' => 'Application ID.', 'type' => 'string', 'title' => '', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], + 'PkgFormat' => ['title' => 'Package format', 'description' => 'Package format.', 'type' => 'string', 'example' => 'apk'], + 'StatusDescription' => ['description' => 'Status description.', 'type' => 'string', 'title' => '', 'example' => 'upload success'], + 'UpdateTime' => ['description' => 'Latest status update time.', 'type' => 'string', 'title' => '', 'example' => '2024-05-28T14:48:34+08:00'], + 'UploadTime' => ['description' => 'Application upload time.', 'type' => 'string', 'title' => '', 'example' => '2024-05-28T14:28:14+08:00'], + 'PkgType' => ['title' => 'Package type, such as android or win', 'description' => 'Package type: android/win.', 'type' => 'string', 'example' => 'android'], + 'AppName' => ['description' => 'Application name.', 'type' => 'string', 'title' => '', 'example' => 'com.aaa.bbb'], + 'StablePatchId' => ['title' => 'Stable patch package ID', 'description' => 'Stable patch package ID.', 'type' => 'string', 'example' => 'patch-7bdf679812484df08a956b73e0b3bdf6'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'TotalCount' => ['description' => 'Total number of matching cloud application entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'PageNumber' => ['description' => 'Page number of the query list.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'Number of rows per page for paged queries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"119F7639-4646-51A4-B6C1-300D391C0104\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'ResumeVsStream' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"CloudApps\\": [\\n {\\n \\"AppVersion\\": \\"1.5.0\\",\\n \\"Status\\": \\"Success\\",\\n \\"Description\\": \\"demo\\",\\n \\"AppId\\": \\"cap-b06b26edfhytbn b94a75ae1a79efc90eb\\",\\n \\"PkgFormat\\": \\"apk\\",\\n \\"StatusDescription\\": \\"upload success\\",\\n \\"UpdateTime\\": \\"2024-05-28T14:48:34+08:00\\",\\n \\"UploadTime\\": \\"2024-05-28T14:28:14+08:00\\",\\n \\"PkgType\\": \\"android\\",\\n \\"AppName\\": \\"com.aaa.bbb\\",\\n \\"StablePatchId\\": \\"patch-7bdf679812484df08a956b73e0b3bdf6\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'title' => 'Query application list', + 'changeSet' => [ + ['createdAt' => '2025-08-21T12:22:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCloudApps'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListCloudApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListEdgeWorkers' => [ + 'summary' => 'Queries payload information for cloud application services. This operation supports paged queries.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'Spec', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', - ], + 'schema' => ['description' => 'Specification', 'type' => 'string', 'required' => false, 'example' => 'ew.gn8t6xlarge-rb.x1p', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'Statuses', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxxxApp', + 'type' => 'array', + 'items' => ['description' => 'The status.', 'type' => 'string', 'required' => false, 'example' => 'Idle', 'title' => ''], + 'description' => 'The list of statuses.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'StreamName', + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The page number of the query. The value starts from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The number of entries to return on each page for a paged query. The maximum value is 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The parameter for filtering by time range. The time must be in ISO 8601 format and use UTC. The format is yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2026-05-25T06:35:26+08:00'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is required for renewal scenarios.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2025-05-14T15:20:37+08:00'], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxxxStream', + 'type' => 'array', + 'items' => ['description' => 'The payload ID.', 'type' => 'string', 'required' => false, 'example' => 'ew-xxxxxx', 'title' => ''], + 'description' => 'The list of payload IDs.', + 'required' => false, + 'example' => 'ew-xxxxxx', + 'title' => '', ], ], [ - 'name' => 'LiveStreamType', + 'name' => 'HiveIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'publisher', - 'enum' => [ - 'publisher', - ], + 'type' => 'array', + 'items' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'hive-4fbf3928d40e43948b98acdb4fb5aaed', 'title' => ''], + 'description' => 'The list of cluster IDs.', + 'required' => false, + 'example' => '["hive-4fbf3928d40e43948b98acdb4fb5aaed"]', + 'title' => '', ], ], [ - 'name' => 'ControlStreamAction', + 'name' => 'PlanIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'The package ID.', 'type' => 'string', 'required' => false, 'example' => 'pk-4fbf3928d40e43948b98acdb4fb5aaed', 'title' => ''], + 'description' => 'The list of package IDs.', 'required' => false, - 'default' => 'resume', - 'enum' => [ - 'resume', - ], + 'example' => '["pk-4fbf3928d40e43948b98acdb4fb5aaed"]', + 'title' => '', ], ], ], @@ -13376,229 +13573,352 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664 ', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'xxxx-xxx-xxx'], + 'Instances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'title' => '', 'example' => 'as-d135ca4425c24b99b79cd0b6c552cac9'], + 'Spec' => ['description' => 'The specification.', 'type' => 'string', 'title' => '', 'example' => 'crs.xic.s1'], + 'CreationTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2025-05-14T15:20:37+08:00'], + 'PlanId' => ['description' => 'The package ID.', 'type' => 'string', 'example' => 'pk-db3394401cc8403f85e4d72d99b52449', 'title' => ''], + 'HiveId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'hive-58mq6jynvgxxmlid3pt39x6gk-0', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time.', 'type' => 'string', 'example' => '2025-05-14T15:20:37+08:00', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Idle', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of payloads.', + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'PageNumber' => ['description' => 'The page number of the query. The value starts from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries to return on each page for a paged query. The maximum value is 100. Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\\\t\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListEdgeWorkers', + 'description' => '## Request description'."\n" + ."\n" + .'- This API queries payload information for cloud application services and supports filtering and paged queries using various parameters.'."\n" + ."\n" + .'- Optional parameters include `Spec`, `Statuses`, `InstanceIds`, `PlanIds`, and `HiveIds`.'."\n" + ."\n" + .'- For paged queries, you can use the `PageNumber` and `PageSize` parameters to control the amount of data returned. The default page size is 10 records, and the maximum is 100 records.'."\n" + ."\n" + .'- You can specify a time range for the query using the `StartTime` and `EndTime` parameters.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxx-xxx\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"as-d135ca4425c24b99b79cd0b6c552cac9\\",\\n \\"Spec\\": \\"crs.xic.s1\\",\\n \\"CreationTime\\": \\"2025-05-14T15:20:37+08:00\\",\\n \\"PlanId\\": \\"pk-db3394401cc8403f85e4d72d99b52449\\",\\n \\"HiveId\\": \\"hive-58mq6jynvgxxmlid3pt39x6gk-0\\",\\n \\"ExpireTime\\": \\"2025-05-14T15:20:37+08:00\\",\\n \\"Status\\": \\"Idle\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', ], - 'BatchForbidVsStream' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListFilePushStatuses' => [ + 'summary' => 'Lists the push status records for a file pushed to cloud application service instances. It supports paged query.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215940', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'The file ID, which uniquely identifies a file.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'f-1671accd4dafdag3er256cvgewt13f7141db2f7'], ], [ - 'name' => 'Channel', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'live/stream1,live/stream2', - ], + 'schema' => ['description' => 'The cloud application service instance ID. Use this parameter to query files installed on a specific instance.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'LiveStreamType', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'publisher', - 'enum' => [ - 'publisher', - ], - ], + 'schema' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'myfile'], ], [ - 'name' => 'Oneshot', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'yes', - 'enum' => [ - 'yes', - 'no', - ], - ], + 'schema' => ['description' => 'The page number of the results to return. Pages start from 1.Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ControlStreamAction', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'default' => 'forbid', - 'enum' => [ - 'forbid', - ], - ], + 'schema' => ['description' => 'The number of entries per page in a paged query. Valid values: 1 to 100.Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], ], [ - 'name' => 'ResumeTime', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2015-12-01T17:37:00Z', - ], + 'schema' => ['title' => 'Filter parameter for time range. It must follow the ISO8601 standard and use UTC, with the format yyyy-MM-ddTHH:mm:ssZ.', 'description' => 'A time range filter parameter. Specify the value in ISO8601 format using UTC time: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2025-06-17T12:16:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => 'Time range filter parameter. It must follow the ISO8601 standard and use UTC time in the format yyyy-MM-ddTHH:mm:ssZ. ', 'description' => 'A time range filter parameter. Specify the value in ISO8601 format using UTC time: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2025-06-23T02:13:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'B058D71B-76EA-5DF6-ACAF-A617C1E7937F', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'PushStatuses' => [ + 'title' => '', + 'description' => 'The list of file push status records.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The file push status. Valid values:'."\n" + ."\n" + .'1. Created'."\n" + ."\n" + .'2. Doing'."\n" + ."\n" + .'3. Success: desired state'."\n" + ."\n" + .'4. Failed: desired state', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'PushTime' => ['description' => 'The scheduled push start time.', 'type' => 'string', 'title' => '', 'example' => '2024-03-26T16:32:20+08:00'], + 'RenderingInstanceId' => ['description' => 'The cloud application service instance ID.', 'type' => 'string', 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'."\n"], + 'StatusDescription' => ['description' => 'The status description.', 'type' => 'string', 'title' => '', 'example' => 'push success'], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'example' => 'myfile'], + 'UpdateTime' => ['description' => 'The latest update time of the status.', 'type' => 'string', 'title' => '', 'example' => '2024-03-26T17:02:10+08:00'], + 'FileId' => ['description' => 'The file ID.', 'type' => 'string', 'title' => '', 'example' => 'f-1671accd4dafdag3er256cvgewt13f7141db2f7'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'ForbidResult' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ForbidResultInfo' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Detail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ok', - ], - 'Channels' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Channel' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'live/stream1,live/stream2', - ], - ], - ], - ], - ], - ], + 'TotalCount' => ['description' => 'The total number of matching file push records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'PageNumber' => ['description' => 'The page number of the returned results.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page in a paged query.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"PushStatuses\\": [\\n {\\n \\"Status\\": \\"Success\\",\\n \\"PushTime\\": \\"2024-03-26T16:32:20+08:00\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\\\n\\",\\n \\"StatusDescription\\": \\"push success\\",\\n \\"FileName\\": \\"myfile\\",\\n \\"UpdateTime\\": \\"2024-03-26T17:02:10+08:00\\",\\n \\"FileId\\": \\"f-1671accd4dafdag3er256cvgewt13f7141db2f7\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'title' => 'Query List of File Push Status Information ', + 'changeSet' => [ + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFilePushStatuses'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListFilePushStatuses', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], + ], + ], + 'ListFiles' => [ + 'summary' => 'Lists uploaded files. The response includes the upload status for each file and supports paged queries.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215929', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], + 'parameters' => [ + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['description' => 'File ID. Each ID corresponds to a unique active file.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'f-1671accd4dafdag3er256cvgewt13f7141db2f7'], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => 'File name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'myfile'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number to retrieve. Page numbering starts at 1.Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of rows per page for a paged query. The value must be in the range of 1 to 100. The default is 10.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => 'Filter parameter for the time range. It must follow the ISO8601 standard, use UTC, and be in the format yyyy-MM-ddTHH:mm:ssZ.', 'description' => 'Start time of the time range filter. Specify in ISO 8601 format using UTC time. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-10-30T16:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => 'Time range filter parameter. It must follow the ISO8601 standard and use UTC time in the format yyyy-MM-ddTHH:mm:ssZ.', 'description' => 'This parameter filters data by time range. It must conform to the ISO 8601 standard and use UTC time in the format yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-10-31T06:00:00Z'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Files' => [ + 'title' => '', + 'description' => 'List of file information.', + 'type' => 'array', + 'items' => [ + 'description' => 'File information.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Upload status. Valid values:'."\n" + ."\n" + .'1. Created'."\n" + ."\n" + .'2. Doing'."\n" + ."\n" + .'3. Success (desired state)'."\n" + ."\n" + .'4. Failed (desired state)', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'Description' => ['description' => 'File description.', 'type' => 'string', 'title' => '', 'example' => '我的文件'], + 'TargetPath' => ['description' => 'Destination path for pushing the file to the service instance.', 'type' => 'string', 'title' => '', 'example' => '/data/tmp/test/xxx.tar'], + 'StatusDescription' => ['description' => 'Status description.', 'type' => 'string', 'title' => '', 'example' => 'upload success'], + 'FileName' => ['description' => 'File name.', 'type' => 'string', 'title' => '', 'example' => 'myfile'], + 'UpdateTime' => ['description' => 'Most recent status update time.', 'type' => 'string', 'title' => '', 'example' => '2024-03-28T14:15:08+08:00'], + 'FileId' => ['description' => 'File ID.', 'type' => 'string', 'title' => '', 'example' => 'f-1671accd4dafdag3er256cvgewt13f7141db2f7'], + 'UploadTime' => ['description' => 'Upload start time.', 'type' => 'string', 'title' => '', 'example' => '2024-03-28T14:10:12+08:00'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'TotalCount' => ['description' => 'Total number of matching file records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '200'], + 'PageNumber' => ['description' => 'Page number of the list.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'Number of entries per page for paged queries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B058D71B-76EA-5DF6-ACAF-A617C1E7937F\\",\\n \\"ForbidResult\\": {\\n \\"ForbidResultInfo\\": [\\n {\\n \\"Result\\": \\"success\\",\\n \\"Count\\": 2,\\n \\"Detail\\": \\"ok\\",\\n \\"Channels\\": {\\n \\"Channel\\": [\\n \\"live/stream1,live/stream2\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'BatchResumeVsStream' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Files\\": [\\n {\\n \\"Status\\": \\"Success\\",\\n \\"Description\\": \\"我的文件\\",\\n \\"TargetPath\\": \\"/data/tmp/test/xxx.tar\\",\\n \\"StatusDescription\\": \\"upload success\\",\\n \\"FileName\\": \\"myfile\\",\\n \\"UpdateTime\\": \\"2024-03-28T14:15:08+08:00\\",\\n \\"FileId\\": \\"f-1671accd4dafdag3er256cvgewt13f7141db2f7\\",\\n \\"UploadTime\\": \\"2024-03-28T14:10:12+08:00\\"\\n }\\n ],\\n \\"TotalCount\\": 200,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'title' => 'Query file list', + 'changeSet' => [ + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFiles'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListHives' => [ + 'summary' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'HiveId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'g-xxxx', 'title' => ''], ], [ - 'name' => 'Channel', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'live/stream1', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'test001', 'title' => ''], ], [ - 'name' => 'LiveStreamType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'publisher', - 'enum' => [ - 'publisher', - ], - ], + 'allowEmptyValue' => true, + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', 'description' => '', 'title' => ''], ], [ - 'name' => 'ControlStreamAction', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'default' => 'resume', - 'enum' => [ - 'resume', - ], - ], + 'allowEmptyValue' => true, + 'schema' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'description' => '', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'title' => '', 'description' => '', 'example' => '2025-05-14T15:20:37+08:00'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'title' => '', 'description' => '', 'example' => '2025-05-14T15:20:37+08:00'], ], ], 'responses' => [ @@ -13606,882 +13926,1195 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'ResumeResult' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'ResumeResultInfo' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'Count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Detail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ok', - ], - 'Channels' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Channel' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'live/stream1', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'xxxx-xxx-xxx'], + 'Hives' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HiveId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'hive-3b506f0868a7451ba15e0e890706033a'], + 'Name' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'yy-test2'], + 'Description' => ['type' => 'string', 'description' => '', 'example' => '基础型S1', 'title' => ''], + 'CreationTime' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '2025-05-14T15:20:37+08:00'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['type' => 'integer', 'format' => 'int64', 'title' => '', 'description' => '', 'example' => '100'], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"ResumeResult\\": {\\n \\"ResumeResultInfo\\": [\\n {\\n \\"Result\\": \\"success\\",\\n \\"Count\\": 1,\\n \\"Detail\\": \\"ok\\",\\n \\"Channels\\": {\\n \\"Channel\\": [\\n \\"live/stream1\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '## 请求说明'."\n" + .'- 该 API 用于查询用户创建的所有集群信息。'."\n" + .'- 支持通过 `HiveId` 和 `Name` 参数进行过滤查询。'."\n" + .'- 分页参数 `PageNumber` 和 `PageSize` 可以控制返回结果的数量和页码，默认每页显示10条记录，最大支持100条。'."\n" + .'- `StartTime` 和 `EndTime` 参数可用于指定时间范围内的集群信息查询，但非必填项。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxx-xxx\\",\\n \\"Hives\\": [\\n {\\n \\"HiveId\\": \\"hive-3b506f0868a7451ba15e0e890706033a\\",\\n \\"Name\\": \\"yy-test2\\",\\n \\"Description\\": \\"基础型S1\\",\\n \\"CreationTime\\": \\"2025-05-14T15:20:37+08:00\\"\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]', ], - 'CreateStreamSnapshot' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListPublicKeys' => [ + 'summary' => 'Retrieves a list of public keys that match the specified criteria. This operation supports pagination.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207885', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'KeyName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****997-cn-qingdao', - ], + 'schema' => ['description' => 'The name of the public key.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'mykey'], ], [ - 'name' => 'Location', + 'name' => 'KeyGroup', + 'in' => 'query', + 'schema' => ['description' => 'The name of the public key group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'g-test'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the list to query. The value starts from 1.'."\n" + .'Default value: 1', 'type' => 'integer', 'format' => 'int64', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page for a paged query. Valid values: 1 to 100.'."\n" + .'Default value: 10', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'KeyType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The type of the public key. Valid values:'."\n" + ."\n" + .'- **adb**: ADB key'."\n" + ."\n" + .'- **ssh**: SSH key', 'type' => 'string', + 'enum' => ['ssh', 'adb'], 'required' => false, - 'enumValueTitles' => [ - 'center' => '', - 'device' => '', - ], - 'example' => 'device', - 'default' => 'center', + 'example' => 'ssh', + 'title' => '', ], ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => 'Filter parameter for the time range. It must be expressed in ISO 8601 standard and use UTC, with the format yyyy-MM-ddTHH:mm:ssZ. ', 'description' => 'A parameter for filtering by time range. The time must be in UTC and follow the ISO 8601 standard. The format is yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-09-21T16:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => 'Time range filter parameter. Specified in ISO8601 standard using UTC time, in the format yyyy-MM-ddTHH:mm:ssZ. ', 'description' => 'A parameter for filtering by time range. The time must be in UTC and follow the ISO 8601 standard. The format is yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-09-22T02:23:00Z'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'OssObject' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'photos/live/340200*****100049/ondemand-1639126601767.jpg', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Width' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1280', - ], - 'Height' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '720', - ], - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://examplebucket.oss-*****.aliyuncs.com/photos/live/340200*****100049/ondemand-1639126601767.jpg', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1639126601767', - ], - 'OssBucket' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'examplebucket', - ], - 'Format' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'jpg', - ], - 'OssEndpoint' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss-cn-qingdao.aliyuncs.com', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****997-cn-qingdao', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'PublicKeys' => [ + 'title' => '', + 'description' => 'A list of public keys.', + 'type' => 'array', + 'items' => [ + 'description' => 'The public key information.', + 'type' => 'object', + 'properties' => [ + 'KeyName' => ['description' => 'The name of the public key.', 'type' => 'string', 'title' => '', 'example' => 'mykey'], + 'Description' => ['description' => 'The description of the public key.', 'type' => 'string', 'title' => '', 'example' => '测试使用'], + 'KeyType' => ['description' => 'The type of the public key. Valid values:'."\n" + ."\n" + .'- **adb**: ADB key'."\n" + ."\n" + .'- **ssh**: SSH key', 'type' => 'string', 'example' => 'ssh', 'title' => ''], + 'KeyGroup' => ['description' => 'The public key group.', 'type' => 'string', 'title' => '', 'example' => 'mygroup'], + 'Content' => ['description' => 'The content of the public key. The content is encoded in Base64 format by default.', 'type' => 'string', 'title' => '', 'example' => 'verify_30d89ccb0905c8c7882c1d14a991954b'], + 'UploadTime' => ['description' => 'The time when the public key was uploaded.', 'type' => 'string', 'title' => '', 'example' => '2024-06-11T14:26:48+08:00'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'PageNumber' => ['description' => 'The page number of the returned list.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"OssObject\\": \\"photos/live/340200*****100049/ondemand-1639126601767.jpg\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Width\\": 1280,\\n \\"Height\\": 720,\\n \\"Url\\": \\"http://examplebucket.oss-*****.aliyuncs.com/photos/live/340200*****100049/ondemand-1639126601767.jpg\\",\\n \\"Timestamp\\": 1639126601767,\\n \\"OssBucket\\": \\"examplebucket\\",\\n \\"Format\\": \\"jpg\\",\\n \\"OssEndpoint\\": \\"oss-cn-qingdao.aliyuncs.com\\",\\n \\"Id\\": \\"323*****997-cn-qingdao\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SetVsStreamsNotifyUrlConfig' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"PublicKeys\\": [\\n {\\n \\"KeyName\\": \\"mykey\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"KeyType\\": \\"ssh\\",\\n \\"KeyGroup\\": \\"mygroup\\",\\n \\"Content\\": \\"verify_30d89ccb0905c8c7882c1d14a991954b\\",\\n \\"UploadTime\\": \\"2024-06-11T14:26:48+08:00\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'title' => 'Query Public Key Information List ', + 'changeSet' => [ + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-12T08:34:15.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPublicKeys'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListPublicKeys', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListRenderingDataPackages' => [ + 'summary' => 'Queries information about the data packets of cloud applications. Paged queries are supported.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'Size', + 'in' => 'query', + 'schema' => ['description' => 'The size of the data pack.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'DataPackageId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the data pack.', 'type' => 'string', 'required' => false, 'example' => 'dp-449ea3d16c0841b8bf33ec5bbc86a152', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the data pack. Valid values:'."\n" + ."\n" + .'- available'."\n" + ."\n" + .'- packing'."\n" + ."\n" + .'- failed'."\n" + ."\n" + .'- bonded', 'type' => 'string', 'required' => false, 'example' => 'available', 'title' => ''], + ], + [ + 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'The category. Valid values:'."\n" + ."\n" + .'- Package'."\n" + ."\n" + .'- Baseline', 'type' => 'string', 'required' => false, 'example' => 'Baseline', 'title' => ''], ], [ - 'name' => 'NotifyUrl', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'http://xxx.com/xx', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The page number for the query list.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ - 'name' => 'AuthType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'type_a', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The number of entries displayed per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'AuthKey', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ocs*****ace', - ], + 'schema' => ['title' => 'Time range filter parameter. Specified in ISO8601 standard format using UTC time, in the format yyyy-MM-ddTHH:mm:ssZ. ', 'description' => 'The parameter for filtering by time range. Use UTC time in ISO8601 format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-10-30T16:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => 'Time range filter parameter. Specified in ISO8601 standard format using UTC time, in the format yyyy-MM-ddTHH:mm:ssZ. ', 'description' => 'The parameter for filtering by time range. Use UTC time in ISO8601 format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-09-24T03:30:46Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'DataPackages' => [ + 'description' => 'A list of data packages for the cloud application service.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the data pack. Valid values:'."\n" + .'available'."\n" + .'packing'."\n" + .'failed'."\n" + .'bonded', 'type' => 'string', 'example' => 'available', 'title' => ''], + 'Description' => ['description' => 'Remarks.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Category' => ['description' => 'The category. Valid values:'."\n" + ."\n" + .'- Package'."\n" + ."\n" + .'- Baseline', 'type' => 'string', 'example' => 'Package', 'title' => ''], + 'Size' => ['description' => 'The size of the data pack.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'RenderingInstanceId' => ['description' => 'The ID of the Graphic Computing Service instance.', 'type' => 'string', 'example' => 'render-342012a227dc4ddf91f024639e43051a', 'title' => ''], + 'CreationTime' => ['description' => 'The creation time of the Graphic Computing Service instance.', 'type' => 'string', 'title' => '', 'example' => '2024-10-15T10:23:06+08:00'], + 'UpdateTime' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2024-12-06T02:03:59Z', 'title' => ''], + 'DataPackageId' => ['description' => 'The ID of the data pack.', 'type' => 'string', 'title' => '', 'example' => 'dp-449ea3d16c0841b8bf33ec5bbc86a152'."\n"], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of Graphic Computing Service instances.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'DeleteVsStreamsNotifyUrlConfig' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DataPackages\\": [\\n {\\n \\"Status\\": \\"available\\",\\n \\"Description\\": \\"test\\",\\n \\"Category\\": \\"Package\\",\\n \\"Size\\": 10,\\n \\"RenderingInstanceId\\": \\"render-342012a227dc4ddf91f024639e43051a\\",\\n \\"CreationTime\\": \\"2024-10-15T10:23:06+08:00\\",\\n \\"UpdateTime\\": \\"2024-12-06T02:03:59Z\\",\\n \\"DataPackageId\\": \\"dp-449ea3d16c0841b8bf33ec5bbc86a152\\\\n\\"\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]', + 'title' => 'Query data package list ', + 'changeSet' => [ + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-27T09:02:56.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRenderingDataPackages'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ListRenderingDataPackages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListRenderingInstanceGateway' => [ + 'summary' => 'Queries custom gateways.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247655', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'The ID of the cloud application service instance.', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], + ], + [ + 'name' => 'GatewayInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the gateway instance.', 'type' => 'string', 'required' => false, 'example' => 'render-xxx', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the list to query.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'default' => '1', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page for a paged query.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'default' => '10', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => 'Filter parameter for time range. It must follow the ISO8601 standard and use UTC, in the format yyyy-MM-ddTHH:mm:ssZ.', 'description' => 'This parameter specifies the time range filter. The time must be in ISO 8601 format and UTC time, such as yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2025-05-18T02:20:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => 'Filter parameter for time range. It must follow the ISO8601 standard and use UTC, in the format yyyy-MM-ddTHH:mm:ssZ.', 'description' => 'The time range for filtering. The time must be in ISO 8601 format and in UTC, such as \\`yyyy-MM-ddTHH:mm:ssZ\\`.', 'type' => 'string', 'required' => false, 'example' => '2025-05-20T12:23:02Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4C747C97-7ECD-4C61-8A92-67AD806331FF', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'GatewayConfigurationInfos' => [ + 'description' => 'A list of custom gateway information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GatewayInstanceId' => ['description' => 'The ID of the custom gateway instance.', 'type' => 'string', 'example' => 'render-xxx', 'title' => ''], + 'Status' => ['description' => 'The status of the custom gateway. Valid values:'."\n" + ."\n" + .'1. Transitional states: creating, deleting'."\n" + ."\n" + .'2. Desired states: available, failed', 'type' => 'string', 'example' => 'available', 'title' => ''], + 'RenderingInstanceId' => ['description' => 'The ID of the cloud application service instance.', 'type' => 'string', 'example' => 'render-342012a227dc4ddf91f024639e43051a', 'title' => ''], + 'CreationTime' => ['description' => 'The time when the cloud application service instance was created.', 'type' => 'string', 'example' => '2024-10-15 10:19:13', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the information was last updated.', 'type' => 'string', 'example' => '2024-11-02 12:08:26', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the query results list', 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries on the current page.', 'type' => 'string', 'example' => '10', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4C747C97-7ECD-4C61-8A92-67AD806331FF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4C747C97-7ECD-4C61-8A92-67AD806331FF\\n","errorExample":""}]', - ], - 'DescribeVsStreamsNotifyUrlConfig' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"GatewayConfigurationInfos\\": [\\n {\\n \\"GatewayInstanceId\\": \\"render-xxx\\",\\n \\"Status\\": \\"available\\",\\n \\"RenderingInstanceId\\": \\"render-342012a227dc4ddf91f024639e43051a\\",\\n \\"CreationTime\\": \\"2024-10-15 10:19:13\\",\\n \\"UpdateTime\\": \\"2024-11-02 12:08:26\\"\\n }\\n ],\\n \\"TotalCount\\": \\"100\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\"\\n}","type":"json"}]', + 'title' => 'Query Custom Gateway', + 'description' => '> Specify at least the template ID or the template type.', + 'changeSet' => [ + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRenderingInstanceGateway'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ListRenderingInstanceGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListRenderingInstances' => [ + 'summary' => 'Lists basic information about cloud application service instances and supports paged queries.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'RenderingSpec', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', - ], + 'schema' => ['description' => 'Instance type of the cloud application service', 'type' => 'string', 'required' => false, 'example' => 'crs.cp.l1', 'title' => ''], + ], + [ + 'name' => 'RenderingInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'ID of the cloud application service instance', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Page number for the paged query. Minimum value: 1. Default value: 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Number of entries per page for the paged query. Valid values: 1 to 100. Default value: 10', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'StorageSize', + 'in' => 'query', + 'schema' => ['description' => 'Storage capacity of the cloud application service instance', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => 'A time range filter parameter. It must follow the ISO8601 standard and use UTC, in the format yyyy-MM-ddTHH:mm:ssZ. ', 'description' => 'Start time of the time range filter. Specify the time in ISO 8601 format in UTC. Format: yyyy-MM-ddTHH:mm:ssZ', 'type' => 'string', 'required' => false, 'example' => '2021-10-31T07:59:59Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => 'A time range filter parameter. It must follow the ISO8601 standard and use UTC, in the format yyyy-MM-ddTHH:mm:ssZ. ', 'description' => 'The time range for filtering. The time must be in UTC and specified in the ISO 8601 format yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2021-10-31T15:59:59Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'LiveStreamsNotifyConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AuthType' => [ - 'type' => 'string', - ], - 'AuthKey' => [ - 'type' => 'string', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'NotifyUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'RenderingInstances' => [ + 'description' => 'List of cloud application service instances', + 'type' => 'array', + 'items' => [ + 'description' => 'Basic information about a cloud application service instance', + 'type' => 'object', + 'properties' => [ + 'RenderingInstanceId' => ['description' => 'ID of the cloud application service instance', 'type' => 'string', 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], + 'RenderingSpec' => ['description' => 'Instance type of the cloud application service', 'type' => 'string', 'title' => '', 'example' => 'crs.cp.l1'], + 'CreationTime' => ['description' => 'Creation time of the cloud application service instance', 'type' => 'string', 'title' => '', 'example' => '2023-11-17T02:18:04Z'], + 'StorageSize' => ['description' => 'Storage capacity, in GB', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'Total number of cloud application service instances', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"LiveStreamsNotifyConfig\\": {\\n \\"AuthType\\": \\"\\",\\n \\"AuthKey\\": \\"\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"NotifyUrl\\": \\"https://example.com/callback\\"\\n }\\n}","type":"json"}]', - ], - 'AddVsPullStreamInfoConfig' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"RenderingSpec\\": \\"crs.cp.l1\\",\\n \\"CreationTime\\": \\"2023-11-17T02:18:04Z\\",\\n \\"StorageSize\\": 100\\n }\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]', + 'title' => 'Query the basic information list of cloud application service instances', + 'changeSet' => [ + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-24T07:31:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRenderingInstances'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ListRenderingInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], ], + ], + 'ListRenderingProjectInstances' => [ + 'summary' => 'Retrieve a paginated list of cloud application service instances associated with a project.', + 'description' => '## Request description'."\n" + ."\n" + .'- This operation enables you to query cloud application service instances in a project using multiple filter conditions, such as status and instance ID.', + 'path' => '/', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'Project ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], ], [ - 'name' => 'AppName', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxxApp', - ], + 'schema' => ['description' => 'Cloud application service instance ID', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'StreamName', + 'name' => 'State', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Instance status. Valid values:'."\n" + ."\n" + .'1. Idle'."\n" + ."\n" + .'2. Locked'."\n" + ."\n" + .'3. InUse', 'type' => 'string', - 'required' => true, - 'example' => 'xxxStream', + 'enum' => ['Idle', 'Locked', 'InUse'], + 'title' => '', + 'required' => false, + 'example' => 'Idle', ], ], [ - 'name' => 'SourceUrl', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'up.******.com.cn', - ], + 'schema' => ['description' => 'Page number. Start from 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], ], [ - 'name' => 'StartTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2017-08-28T07:30:30Z', - ], + 'schema' => ['description' => 'Number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], ], [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2017-08-28T09:30:30Z', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => 'Filter parameter for the time range. It must be specified in ISO8601 standard format and use UTC, with the format yyyy-MM-ddTHH:mm:ssZ.', 'description' => 'A parameter for filtering by a time range. The time must be in UTC and formatted according to the ISO 8601 standard as \\`yyyy-MM-ddTHH:mm:ssZ\\`.', 'type' => 'string', 'required' => false, 'example' => '2024-11-27T16:00:00Z'], ], [ - 'name' => 'Always', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'yes', - 'no', - ], - ], + 'schema' => ['title' => 'Time range filter parameter. It must follow the ISO8601 standard and use UTC, in the format yyyy-MM-ddTHH:mm:ssZ.', 'description' => 'End time of the time range. Use ISO 8601 format in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2024-11-30T02:18:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3CB843A9-DD34-4881-B8D6-B0D539D111E4', + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'RenderingInstances' => [ + 'title' => '', + 'description' => 'List of cloud application service instances', + 'type' => 'array', + 'items' => [ + 'description' => 'Basic information about a cloud application service instance', + 'type' => 'object', + 'properties' => [ + 'AssociationTime' => ['description' => 'Time when the instance was associated with the project', 'type' => 'string', 'title' => '', 'example' => '2024-09-11T18:19:04+08:00'], + 'RenderingInstanceId' => ['description' => 'Cloud application service instance', 'type' => 'string', 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], + 'StateInfo' => [ + 'title' => '', + 'description' => 'Status information for the project instance', + 'type' => 'object', + 'properties' => [ + 'Comment' => ['description' => 'Description of the current status', 'type' => 'string', 'title' => '', 'example' => '正在会话中'], + 'State' => ['description' => 'Instance status', 'type' => 'string', 'title' => '', 'example' => 'InUse'], + 'UpdateTime' => ['description' => 'Time when the status was last updated', 'type' => 'string', 'title' => '', 'example' => '2024-11-11T18:19:04+08:00'], + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'TotalCount' => ['description' => 'Total number of cloud application service instances', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '8'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Param.Missing.StartTime', - 'errorMessage' => 'You must specify StartTime.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - ], - [ - 'errorCode' => 'Duration.Exceed', - 'errorMessage' => 'The duration between StartTime and EndTime is too long.', - ], - [ - 'errorCode' => 'ConfigAlreadyExists', - 'errorMessage' => 'The specified configuration already exists.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Deny.TooMany.Stream', - 'errorMessage' => 'The operation is denied because the maximum number of streams is exceeded.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstances\\": [\\n {\\n \\"AssociationTime\\": \\"2024-09-11T18:19:04+08:00\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"StateInfo\\": {\\n \\"Comment\\": \\"正在会话中\\",\\n \\"State\\": \\"InUse\\",\\n \\"UpdateTime\\": \\"2024-11-11T18:19:04+08:00\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 8\\n}","type":"json"}]', + 'title' => 'Query instance association information of a project', + 'changeSet' => [ + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListRenderingProjectInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3CB843A9-DD34-4881-B8D6-B0D539D111E4\\"\\n}","type":"json"}]', ], - 'DeleteVsPullStreamInfoConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRenderingProjects' => [ + 'summary' => 'Obtain a paged list of basic information about cloud application projects for the current user.', + 'description' => '## Request details'."\n" + ."\n" + .'- This operation returns a paged list of basic information about rendering projects for a specified user.'."\n" + ."\n" + .'- Filter results by `ProjectId` or `ProjectName`.', + 'path' => '/', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'Project ID', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], ], [ - 'name' => 'AppName', + 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxxApp', - ], + 'schema' => ['description' => 'Project name', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'idata_content'], ], [ - 'name' => 'StreamName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxxStream', - ], + 'schema' => ['description' => 'Page number. The first page is 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => 'Time range filter parameter. It must follow the ISO8601 standard and use UTC, in the format yyyy-MM-ddTHH:mm:ssZ. ', 'description' => 'Start time of the time range filter. Use ISO 8601 format in UTC, such as yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2024-09-29T16:00:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => 'Time range filter parameter. It must follow the ISO8601 standard and use UTC, in the format yyyy-MM-ddTHH:mm:ssZ. ', 'description' => 'A parameter that specifies the time range to filter by. The time must be in UTC and follow the ISO 8601 format: yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2024-10-03T02:18:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Projects' => [ + 'title' => '', + 'description' => 'Project list', + 'type' => 'array', + 'items' => [ + 'description' => 'Project information', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'Project description', 'type' => 'string', 'title' => '', 'example' => 'description'], + 'ProjectName' => ['description' => 'Project name', 'type' => 'string', 'title' => '', 'example' => 'prod-project'], + 'ProjectId' => ['description' => 'Project ID', 'type' => 'string', 'title' => '', 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], + 'CreationTime' => ['description' => 'Project creation time', 'type' => 'string', 'example' => '2024-09-09T18:44:49+08:00', 'title' => ''], + 'UpdateTime' => ['description' => 'Last update time', 'type' => 'string', 'example' => '2024-10-09T18:44:49+08:00', 'title' => ''], + 'SessionAttribs' => [ + 'title' => '', + 'description' => 'Project session attributes', + 'type' => 'object', + 'properties' => [ + 'StartMode' => ['description' => 'Startup mode', 'type' => 'string', 'example' => 'Sync', 'title' => ''], + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'TotalCount' => ['description' => 'Total number of matching projects', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'UpdateVsPullStreamInfoConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Projects\\": [\\n {\\n \\"Description\\": \\"description\\",\\n \\"ProjectName\\": \\"prod-project\\",\\n \\"ProjectId\\": \\"project-422bc38dfgh5eb44149f135ef76304f63b\\",\\n \\"CreationTime\\": \\"2024-09-09T18:44:49+08:00\\",\\n \\"UpdateTime\\": \\"2024-10-09T18:44:49+08:00\\",\\n \\"SessionAttribs\\": {\\n \\"StartMode\\": \\"Sync\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 2\\n}","type":"json"}]', + 'title' => 'Query project list ', + 'changeSet' => [ + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListRenderingProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListRenderingSessions' => [ + 'summary' => 'Performs a paged query for the list of cloud application service sessions based on specified conditions.', + 'description' => '## Request Description'."\n" + ."\n" + .'- This API supports filtering and paged query of user rendering session lists with various parameter combinations.'."\n" + ."\n" + .'- You must provide at least one of the `SessionId` or `ClientId` parameters. Neither parameter is mandatory independently. If both parameters are provided, a more precise match is performed based on these two parameters.', + 'path' => '/', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', - ], + 'schema' => ['description' => 'Project ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], ], [ - 'name' => 'AppName', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxxApp', - ], + 'schema' => ['description' => 'Session ID', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'session-i205217481741918129226'], ], [ - 'name' => 'StreamName', + 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'xxxStream', - ], + 'schema' => ['description' => 'Unique ID of the client.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ae7990f4-203d-494b-a5ea-e0babe9fa13d'], ], [ - 'name' => 'SourceUrl', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'up.xxx.com.cn', - ], + 'schema' => ['description' => 'Cloud application ID', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], ], [ - 'name' => 'StartTime', + 'name' => 'State', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Session state. Valid values:'."\n" + ."\n" + .'1. SessionStarting: The session is starting.'."\n" + ."\n" + .'2. SessionStartSuspended: Session startup is paused. Retry by initiating start again.'."\n" + ."\n" + .'3. SessionStarted: The session has started/is in use.'."\n" + ."\n" + .'4. SessionStartFailed: Session startup failed.'."\n" + ."\n" + .'5. SessionAbnormal: The session is abnormal after successful startup.'."\n" + ."\n" + .'6. SessionStopping: The session is stopping.'."\n" + ."\n" + .'7. SessionStopFailed: Session stop failed.', + 'type' => 'string', + 'enum' => ['SessionStarting', 'SessionStartSuspended', 'SessionStarted', 'SessionAbnormal', 'SessionStartFailed', 'SessionStopping', 'SessionStopFailed'], + 'title' => '', 'required' => false, - 'example' => '2021-12-10T10:00:00Z', + 'example' => 'SessionStarting', ], ], + [ + 'name' => 'RenderingInstanceId', + 'in' => 'query', + 'schema' => ['title' => 'Cloud application service instance ID', 'description' => 'Cloud application service instance ID', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'Page number, starting from 1', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of rows per page set for paged queries.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => 'Filter parameter for the time range. It must be expressed in ISO8601 standard and use UTC, with the format yyyy-MM-ddTHH:mm:ssZ. ', 'description' => 'Time range filter parameter. Represented in ISO8601 standard and must use UTC time, in the format yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2025-03-25T02:00:00Z'], + ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2018-12-10T18:00:00Z', - ], + 'schema' => ['title' => 'Time range filter parameter, represented in ISO8601 standard using UTC time, with the format yyyy-MM-ddTHH:mm:ssZ.', 'description' => 'Time range filter parameter. Represented in ISO8601 standard and must use UTC time, in the format yyyy-MM-ddTHH:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2025-03-31T22:20:00Z'], ], [ - 'name' => 'Always', + 'name' => 'PatchId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'yes', - 'no', - ], - ], + 'schema' => ['title' => 'Cloud application patch package ID. '."\n" + .'1. When "origin" is specified, only sessions that started the original version of the application are filtered. ', 'description' => 'Cloud application patch ID.'."\n" + ."\n" + .'1. When you enter origin, only sessions that started the original version of the app are filtered.', 'type' => 'string', 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Sessions' => [ + 'title' => '', + 'description' => 'Session list', + 'type' => 'array', + 'items' => [ + 'description' => 'Session information', + 'type' => 'object', + 'properties' => [ + 'AppId' => ['description' => 'Cloud application ID', 'type' => 'string', 'title' => '', 'example' => 'cap-4e1a6a425495458ba78693b8ac6600ea'], + 'RenderingInstanceId' => ['title' => 'Cloud application service instance ID', 'description' => 'Cloud application service instance ID', 'type' => 'string', 'example' => 'render-a10722fb84b243f6ba02a89a2e5c838d'], + 'StartTime' => ['description' => 'Start time', 'type' => 'string', 'title' => '', 'example' => '2024-07-04T01:23:00Z'], + 'ClientId' => ['description' => 'Client ID', 'type' => 'string', 'title' => '', 'example' => 'fd6b2134-7954-4754-8915-5fb8b0469622'], + 'PatchId' => ['title' => 'Cloud application patch package ID. An empty value indicates the original version.', 'description' => 'Cloud application patch ID. An empty value indicates the original version.', 'type' => 'string', 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4'], + 'SessionId' => ['description' => 'Session ID', 'type' => 'string', 'title' => '', 'example' => 'session-i205217481741918129226'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'TotalCount' => ['description' => 'Total number of matching sessions', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '8'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Param.Missing.StartTime', - 'errorMessage' => 'You must specify StartTime.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - ], - [ - 'errorCode' => 'Duration.Exceed', - 'errorMessage' => 'The duration between StartTime and EndTime is too long.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Sessions\\": [\\n {\\n \\"AppId\\": \\"cap-4e1a6a425495458ba78693b8ac6600ea\\",\\n \\"RenderingInstanceId\\": \\"render-a10722fb84b243f6ba02a89a2e5c838d\\",\\n \\"StartTime\\": \\"2024-07-04T01:23:00Z\\",\\n \\"ClientId\\": \\"fd6b2134-7954-4754-8915-5fb8b0469622\\",\\n \\"PatchId\\": \\"patch-03fa76e8e13a49b6a966b063d9d309b4\\",\\n \\"SessionId\\": \\"session-i205217481741918129226\\"\\n }\\n ],\\n \\"TotalCount\\": 8\\n}","type":"json"}]', + 'title' => 'Query session list', + 'changeSet' => [ + ['createdAt' => '2025-08-21T12:22:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-19T08:44:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListRenderingSessions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', ], - 'DescribeVsPullStreamInfoConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSpecifications' => [ + 'summary' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'Specification', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'ew.gn8t6xlarge-rb.x1p', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'LiveAppRecordList' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'LiveAppRecord' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2016-05-15T07:30:00Z', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxApp', - ], - 'SourceUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://test', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2016-05-15T01:30:00Z', - ], - 'StreamName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxStream', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.com', - ], - ], - ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', 'description' => '', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'description' => '', 'required' => false, 'example' => '20', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'xxxx-xxx-xxx'], + 'Items' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Specification' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => 'crs.xic.s1'], + 'Class' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '4090CU'], + 'Shard' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '1', 'title' => ''], + 'Cores' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '2', 'title' => ''], + 'Memory' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '8', 'title' => ''], + 'Storage' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '90', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['type' => 'integer', 'format' => 'int64', 'title' => '', 'description' => '', 'example' => '200'], + 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '1', 'title' => ''], + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '20', 'title' => ''], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"LiveAppRecordList\\": {\\n \\"LiveAppRecord\\": [\\n {\\n \\"EndTime\\": \\"2016-05-15T07:30:00Z\\",\\n \\"AppName\\": \\"xxxApp\\",\\n \\"SourceUrl\\": \\"http://test\\",\\n \\"StartTime\\": \\"2016-05-15T01:30:00Z\\",\\n \\"StreamName\\": \\"xxxStream\\",\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '## 请求说明'."\n" + ."\n" + .'- 该 API 用于查询所有可用的云应用服务规格信息。'."\n" + .'- 支持通过 `Specification` 参数过滤特定规格。'."\n" + .'- 分页查询时，可以通过 `PageNumber` 和 `PageSize` 参数控制返回的数据量。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxx-xxx\\",\\n \\"Items\\": [\\n {\\n \\"Specification\\": \\"crs.xic.s1\\",\\n \\"Class\\": \\"4090CU\\",\\n \\"Shard\\": 1,\\n \\"Cores\\": 2,\\n \\"Memory\\": 8,\\n \\"Storage\\": 90\\n }\\n ],\\n \\"TotalCount\\": 200,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', ], - 'StartTransferStream' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ManageLogin' => [ + 'summary' => 'Manages secure logons.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', + 'abilityTreeCode' => '207906', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****998-cn-qingdao', - ], + 'schema' => ['description' => 'ID of the Cloud Application Service instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'Url', + 'name' => 'KeyName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'Name of the public key. You must specify either KeyName or KeyGroup.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'mykey'], ], [ - 'name' => 'Transcode', + 'name' => 'KeyGroup', + 'in' => 'query', + 'schema' => ['description' => 'Name of the public key group. If you do not specify KeyName, all public keys in this group are applied.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'mygroup'], + ], + [ + 'name' => 'ActionName', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Name of the management action. Valid values:'."\n" + ."\n" + .'1. open — Activate the public key. This is the default value.'."\n" + ."\n" + .'2. close — Deactivate the public key.', 'type' => 'string', + 'default' => 'open', + 'enum' => ['open', 'close'], + 'title' => '', 'required' => false, - 'example' => 'sd', + 'example' => 'open', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'LoginInfo' => [ + 'title' => '', + 'description' => 'Connection information.', + 'type' => 'object', + 'properties' => [ + 'LoginHostname' => ['description' => 'Host for SSH connections.', 'type' => 'string', 'title' => '', 'example' => '12.10.4.10'], + 'LoginPort' => ['description' => 'Port for SSH connections.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10004'], + 'AdbLoginPort' => ['description' => 'Port for ADB connections.', 'type' => 'integer', 'format' => 'int32', 'example' => '10005', 'title' => ''], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'StopTransferStream' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"LoginInfo\\": {\\n \\"LoginHostname\\": \\"12.10.4.10\\",\\n \\"LoginPort\\": 10004,\\n \\"AdbLoginPort\\": 10005\\n }\\n}","type":"json"}]', + 'title' => 'Secure Logon Management for Graphic Computing Service Instances', + 'changeSet' => [ + ['createdAt' => '2024-09-12T08:34:15.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ManageLogin'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ManageLogin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], ], + ], + 'ModifyComfyWorkflow' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '199255', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'WorkflowId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323434****83423432', - ], + 'schema' => ['description' => 'The ID of the workflow to modify.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'wf_3de1eb6e-1dfe-45aa-8f88-2269d0a30f53'], ], [ - 'name' => 'Transcode', + 'name' => 'WorkflowName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sd', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The new workflow name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '图生视频工作流示例'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The new workflow description.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '这是一个图生视频的工作流'], ], ], 'responses' => [ @@ -14489,402 +15122,314 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Code' => ['description' => 'The error code. This parameter is returned only if the request fails.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message. This parameter provides error details if the request fails.', 'type' => 'string', 'example' => 'conn failed!', 'title' => ''], + 'WorkflowId' => ['description' => 'The workflow ID.', 'type' => 'string', 'title' => '', 'example' => 'wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5f'], + 'Name' => ['description' => 'The workflow name.', 'type' => 'string', 'title' => '', 'example' => '图生视频工作流示例'], + 'Description' => ['description' => 'The workflow description.', 'type' => 'string', 'title' => '', 'example' => '这是一个图生视频的工作流'], + 'CreationTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2024-05-07T02:27:06Z'], + 'UpdatedTime' => ['description' => 'The update time.', 'type' => 'string', 'title' => '', 'example' => '2024-05-07T02:27:06Z'], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ModifyComfyWorkflow', + 'summary' => 'Modifies the metadata of a specified workflow.', + 'description' => '\\> 截图查询目前不支持分页，仅支持按迭代方式。使用返回结果里的extStartTime参数值，作为新请求的StartTime可请求下一页。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"conn failed!\\",\\n \\"WorkflowId\\": \\"wf_adb32aed-ccdc-42ae-b4d4-a21181ac8a5f\\",\\n \\"Name\\": \\"图生视频工作流示例\\",\\n \\"Description\\": \\"这是一个图生视频的工作流\\",\\n \\"CreationTime\\": \\"2024-05-07T02:27:06Z\\",\\n \\"UpdatedTime\\": \\"2024-05-07T02:27:06Z\\"\\n}","type":"json"}]', ], - 'DescribeVsStreamsOnlineList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxApp', - ], + 'schema' => ['description' => 'Device name.', 'type' => 'string', 'required' => false, 'example' => 'xxx路口摄像头', 'title' => ''], ], [ - 'name' => 'StreamName', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxStream', - ], + 'schema' => ['description' => 'Device description.', 'type' => 'string', 'required' => false, 'example' => 'xxx路口摄像头', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '2000', - ], + 'schema' => ['description' => 'Space ID.', 'type' => 'string', 'required' => false, 'example' => '348*****174-cn-qingdao', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'ParentId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'Parent device ID.', 'type' => 'string', 'required' => false, 'example' => '399*****774-cn-qingdao', 'title' => ''], ], [ - 'name' => 'StreamType', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'all', - 'enum' => [ - 'all', - 'raw', - 'trans', - ], - ], + 'schema' => ['description' => 'Directory ID for the device.', 'type' => 'string', 'required' => false, 'example' => '399*****488-cn-qingdao', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2016-06-29T19:00:00Z', - ], + 'schema' => ['description' => 'Device type. Valid values:'."\n" + ."\n" + .'- ipc (camera)'."\n" + ."\n" + .'- platform (platform)'."\n" + ."\n" + .'- ied (intelligent device)', 'type' => 'string', 'required' => false, 'example' => 'ipc', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'AutoStart', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2016-06-30T19:00:00Z', - ], + 'schema' => ['description' => 'Whether to automatically start the stream. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'QueryType', + 'name' => 'GbId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'fuzzy', - 'enum' => [ - 'fuzzy', - 'strict', - ], - ], + 'schema' => ['description' => 'GB-compliant device ID.'."\n" + ."\n" + .'> This parameter applies only to GB-compliant protocols.', 'type' => 'string', 'required' => false, 'example' => '3100000****000000002', 'title' => ''], ], [ - 'name' => 'OrderBy', + 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'publish_time_asc', - 'enum' => [ - 'stream_name_desc', - 'stream_name_asc', - 'stream_publish_time_desc', - 'stream_publish_asc', - ], - ], + 'schema' => ['description' => 'IP address of the device.', 'type' => 'string', 'required' => false, 'example' => '10.10.10.10', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'B31FC4AD-3592-573E-8063-878F722B322A', - ], - 'TotalNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'OnlineInfo' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'LiveStreamOnlineInfo' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PublishTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2015-12-02T06:58:04Z', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxApp', - ], - 'PublishType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'edge', - ], - 'PublishUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rtmp://example.com/xchen', - ], - 'Transcoded' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'no', - ], - 'StreamName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testxchen_small', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.com', - ], - 'TranscodeId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - 'PublishDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'push.example.com', - ], - ], - ], - ], - ], - ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => ['description' => 'Port number of the device.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8080', 'title' => ''], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => ['description' => 'Stream URL on the device.', 'type' => 'string', 'required' => false, 'example' => 'rtmp://xxx/xxx', 'title' => ''], + ], + [ + 'name' => 'Username', + 'in' => 'query', + 'schema' => ['description' => 'Username for the device.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => ['description' => 'Password for the device.', 'type' => 'string', 'required' => false, 'example' => 'admin', 'title' => ''], + ], + [ + 'name' => 'Vendor', + 'in' => 'query', + 'schema' => ['description' => 'Device vendor.', 'type' => 'string', 'required' => false, 'example' => '公司A', 'title' => ''], + ], + [ + 'name' => 'Longitude', + 'in' => 'query', + 'schema' => ['description' => 'Longitude of the device.', 'type' => 'string', 'required' => false, 'example' => '45.00', 'title' => ''], + ], + [ + 'name' => 'Latitude', + 'in' => 'query', + 'schema' => ['description' => 'The device dimension.', 'type' => 'string', 'required' => false, 'example' => '119.20', 'title' => ''], + ], + [ + 'name' => 'AutoPos', + 'in' => 'query', + 'schema' => ['description' => 'Whether to enable location subscription for the device. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'PosInterval', + 'in' => 'query', + 'schema' => ['description' => 'Location subscription interval, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', 'title' => ''], + ], + [ + 'name' => 'AlarmMethod', + 'in' => 'query', + 'schema' => ['description' => 'GB-compliant alarm method to subscribe to. Valid values:'."\n" + ."\n" + .'- 0 (all)'."\n" + ."\n" + .'- 5 (video alarm)'."\n" + ."\n" + .'- 7 (other alarms)'."\n" + ."\n" + .'> * An empty value means no subscription.'."\n" + .'>'."\n" + .'> * Multiple values are supported. Separate them with commas.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => ['description' => 'Additional device parameters, formatted as a JSON-serialized string.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Modify Device', + 'summary' => 'Update device information.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalPage\\": 1,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"B31FC4AD-3592-573E-8063-878F722B322A\\",\\n \\"TotalNum\\": 10,\\n \\"OnlineInfo\\": {\\n \\"LiveStreamOnlineInfo\\": [\\n {\\n \\"PublishTime\\": \\"2015-12-02T06:58:04Z\\",\\n \\"AppName\\": \\"xxxApp\\",\\n \\"PublishType\\": \\"edge\\",\\n \\"PublishUrl\\": \\"rtmp://example.com/xchen\\",\\n \\"Transcoded\\": \\"no\\",\\n \\"StreamName\\": \\"testxchen_small\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TranscodeId\\": \\"123\\",\\n \\"PublishDomain\\": \\"push.example.com\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DescribeVsStreamsPublishList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyDeviceAlarm' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'ChannelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxApp', - ], + 'schema' => ['description' => 'The channel ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'StreamName', + 'name' => 'AlarmId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxStream', - ], + 'schema' => ['description' => 'The alarm ID.', 'type' => 'string', 'required' => true, 'example' => '0dGo7jLwwf1000296232', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2016-06-29T19:00:00Z', - ], + 'schema' => ['description' => 'The alarm status. Valid values:'."\n" + ."\n" + .'- 1 (upload completed)'."\n" + .'- 2 (upload failed)'."\n" + .'- 3 (general error)', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], - [ - 'name' => 'EndTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2016-06-30T19:00:00Z', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3000', - 'default' => '2000', + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Modify Device Alarm', + 'summary' => 'Updates the alarm status of a device.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDeviceAlarm'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyDeviceAlarm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ModifyDeviceCapture' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'StreamType', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'all', - 'enum' => [ - 'all', - 'raw', - 'trans', - ], - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], [ - 'name' => 'QueryType', + 'name' => 'Image', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'fuzzy', - 'enum' => [ - 'fuzzy', - 'strict', - ], - ], + 'schema' => ['description' => 'Image capture control. Valid values:'."\n" + ."\n" + .'- 0 (shutdown)'."\n" + ."\n" + .'- 1 (enable)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'OrderBy', + 'name' => 'Video', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'publish_time_asc', - 'enum' => [ - 'stream_name_desc', - 'stream_name_asc', - 'publish_time_desc', - 'publish_asc', - ], - ], + 'schema' => ['description' => 'Video recording control. Valid values:'."\n" + ."\n" + .'- 0 (shutdown)'."\n" + ."\n" + .'- 1 (enable short recording)'."\n" + ."\n" + .'- 2 (enable long recording)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -14892,350 +15437,260 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3000', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '119F7639-4646-51A4-B6C1-300D391C0104', - ], - 'TotalNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'PublishInfo' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'LiveStreamPublishInfo' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EdgeNodeAddr' => [ - 'description' => '', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'PublishUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8', - ], - 'StreamName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxStream', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'StopTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2016-06-29T19:00:00Z', - ], - 'TranscodeId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3888920****8138204-cn-qingdao', - ], - 'PublishDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'AppName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxApp', - ], - 'PublishTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2016-06-29T19:00:00Z', - ], - 'PublishType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'center', - ], - 'Transcoded' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'yes', - ], - 'ClientAddr' => [ - 'description' => '', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'StreamUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Modify Device Capture', + 'summary' => 'Modify the device image capture configuration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDeviceCapture'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyDeviceCapture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalPage\\": 1,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 3000,\\n \\"RequestId\\": \\"119F7639-4646-51A4-B6C1-300D391C0104\\",\\n \\"TotalNum\\": 200,\\n \\"PublishInfo\\": {\\n \\"LiveStreamPublishInfo\\": [\\n {\\n \\"EdgeNodeAddr\\": \\"192.168.0.1\\",\\n \\"PublishUrl\\": \\"https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8\\",\\n \\"StreamName\\": \\"xxxStream\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"StopTime\\": \\"2016-06-29T19:00:00Z\\",\\n \\"TranscodeId\\": \\"3888920****8138204-cn-qingdao\\",\\n \\"PublishDomain\\": \\"example.aliyundoc.com\\",\\n \\"AppName\\": \\"xxxApp\\",\\n \\"PublishTime\\": \\"2016-06-29T19:00:00Z\\",\\n \\"PublishType\\": \\"center\\",\\n \\"Transcoded\\": \\"yes\\",\\n \\"ClientAddr\\": \\"192.168.0.1\\",\\n \\"StreamUrl\\": \\"https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', ], - 'CreateTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyDeviceChannels' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'Dsn', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The device serial number.', 'type' => 'string', 'required' => false, 'example' => '210235C3GN32090008286cf17e130d', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'DeviceStatus', + 'in' => 'query', + 'schema' => ['description' => 'The status of the device. Valid values:'."\n" + ."\n" + .'- on: online'."\n" + ."\n" + .'- off: offline', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], + ], + [ + 'name' => 'Channels', 'in' => 'query', + 'schema' => ['description' => 'An array of channels in a JSON-formatted string.', 'type' => 'string', 'required' => true, 'example' => '[{"ChannelId":12333,"Name":"测试","DeviceStatus":"on"}]', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8F4D95B6-EB19-5245-AD77-95EDA83E53B7', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'record', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F4D95B6-EB19-5245-AD77-95EDA83E53B7\\"\\n}","type":"json"}]', + 'title' => 'Modify device channel', + 'summary' => 'Updates the list of channels for a device.', + 'requestParamsDescription' => '### Channel type'."\n" + ."\n" + .'| Parameter | Type | Required | Description |'."\n" + .'| ------------ | ------ | -------- | --------------------------------------------------------------------- |'."\n" + .'| ChannelId | Long | Yes | The channel ID. |'."\n" + .'| Name | String | No | The channel name. |'."\n" + .'| DeviceStatus | String | No | The status of the device. Valid values:* on: online
* off: offline |'."\n" + .'| Params | String | No | Other parameters of the device, in a JSON-formatted string. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDeviceChannels'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyDeviceChannels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ModifyDirectory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-qingdao', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'OssBucket', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'bucketname', - ], + 'schema' => ['description' => 'The ID of the directory.', 'type' => 'string', 'required' => true, 'example' => '399*****488-cn-qingdao', 'title' => ''], ], [ - 'name' => 'OssEndpoint', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'oss-cn-qingdao.aliyuncs.com', - ], + 'schema' => ['description' => 'The name of the directory.', 'type' => 'string', 'required' => false, 'example' => '目录2', 'title' => ''], ], [ - 'name' => 'OssFilePrefix', + 'name' => 'Description', 'in' => 'query', + 'schema' => ['description' => 'The description of the directory.', 'type' => 'string', 'required' => false, 'example' => '目录2', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the directory.', 'type' => 'string', 'example' => '399*****488-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'oss-prefix', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Trigger', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'auto', + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"399*****488-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Modify Folder', + 'summary' => 'Modifies the information of a directory.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDirectory'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ModifyGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Interval', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'Retention', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The ID of the space.', 'type' => 'string', 'required' => true, 'example' => '32388487739092994-cn-qingdao', 'title' => ''], ], [ - 'name' => 'FileFormat', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hls', - ], + 'schema' => ['description' => 'Space name.', 'type' => 'string', 'required' => false, 'example' => 'myGroup', 'title' => ''], ], [ - 'name' => 'JpgOverwrite', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'osspath/snapshot/{AppName}/{StreamName}.jpg', - ], + 'schema' => ['description' => 'Description of the space.', 'type' => 'string', 'required' => false, 'example' => '用于测试使用', 'title' => ''], ], [ - 'name' => 'JpgSequence', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', - ], + 'schema' => ['description' => 'The region where the space is located. This region serves as the service center.', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao', 'title' => ''], ], [ - 'name' => 'JpgOnDemand', + 'name' => 'InProtocol', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg', - ], + 'schema' => ['description' => 'Ingest protocol used by the group. Valid values:'."\n" + ."\n" + .'- gb28181'."\n" + ."\n" + .'- rtmp', 'type' => 'string', 'required' => false, 'example' => 'gb28181', 'title' => ''], ], [ - 'name' => 'Mp4', + 'name' => 'OutProtocol', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', - ], + 'schema' => ['description' => 'Playback protocols used by the group. Separate multiple values with commas. Valid values:'."\n" + ."\n" + .'- flv'."\n" + ."\n" + .'- hls'."\n" + ."\n" + .'- rtmp', 'type' => 'string', 'required' => false, 'example' => 'flv,rtmp,hls', 'title' => ''], ], [ - 'name' => 'Flv', + 'name' => 'Enabled', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', - ], + 'schema' => ['description' => 'Indicates whether the space is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'HlsM3u8', + 'name' => 'PushDomain', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', - ], + 'schema' => ['description' => 'Ingest domain used by the group. Applies only to groups that use the RTMP ingest protocol.', 'type' => 'string', 'required' => false, 'example' => 'mypush.com', 'title' => ''], ], [ - 'name' => 'HlsTs', + 'name' => 'PlayDomain', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}', - ], + 'schema' => ['description' => 'Streaming domain used by the group.', 'type' => 'string', 'required' => false, 'example' => 'myplay.com', 'title' => ''], ], [ - 'name' => 'Callback', + 'name' => 'LazyPull', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://example.com/callback', - ], + 'schema' => ['description' => 'Whether on-demand stream pulling is enabled. Valid values:'."\n" + ."\n" + .'- false (default)'."\n" + ."\n" + .'- true', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'TransConfigsJSON', + 'name' => 'Callback', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '[{"Fps":25,"Gop":50,"Height":720,"VideoCodec":"h264","Width":1280,"Name":"sd","VideoBitrate":800}]', - ], + 'schema' => ['description' => 'Callback URL for device or stream status updates in the group.', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback', 'title' => ''], ], ], 'responses' => [ @@ -15243,914 +15698,694 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****735-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'Id' => ['description' => 'The ID of the space.', 'type' => 'string', 'example' => '32388487739092994-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"399*****735-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreateTemplate', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"32388487739092994-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Modify workspace', + 'summary' => 'You can modify the details of a space.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyGroup'], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****998-cn-qingdao', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteTemplate', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ModifyTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyHiveAttribute' => [ + 'summary' => 'Updates the name or description of a specified cluster.', + 'description' => '## Request'."\n" + ."\n" + .'- This API modifies the name and/or description of an existing cluster.'."\n" + ."\n" + .'- `HiveId` is a required parameter that identifies the cluster to modify.'."\n" + ."\n" + .'- The `Name` and `Description` parameters are optional. You can specify either or both to update the corresponding attributes of the cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'HiveId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****998-cn-qingdao', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'example' => 'hive-3b506f0868a7451ba15e0e890706033a', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The new name of the cluster.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'yy-test2'], ], [ 'name' => 'Description', 'in' => 'query', + 'schema' => ['description' => 'The new description of the cluster.', 'type' => 'string', 'required' => false, 'example' => 'gb-test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + ], + 'title' => '', + 'description' => 'The response object.', 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ModifyHiveAttribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + ], + 'ModifyParentPlatform' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-qingdao', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'OssBucket', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'bucketname', - ], + 'schema' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'required' => true, 'example' => '359*****374-cn-qingdao', 'title' => ''], ], [ - 'name' => 'OssEndpoint', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'oss-cn-qingdao.aliyuncs.com', - ], + 'schema' => ['description' => 'The name of the parent platform.', 'type' => 'string', 'required' => false, 'example' => '国标级联修改测试', 'title' => ''], ], [ - 'name' => 'OssFilePrefix', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'oss-prefix', - ], + 'schema' => ['description' => 'The description of the parent platform.', 'type' => 'string', 'required' => false, 'example' => '国标级联修改测试', 'title' => ''], ], [ - 'name' => 'Trigger', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'auto', - ], + 'name' => 'GbId', + 'in' => 'query', + 'schema' => ['description' => 'The GB ID of the parent platform.', 'type' => 'string', 'required' => false, 'example' => '31000*****2170123451', 'title' => ''], ], [ - 'name' => 'Interval', + 'name' => 'Ip', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600', - ], + 'schema' => ['description' => 'The SIP service IP of the parent platform.', 'type' => 'string', 'required' => false, 'example' => '10.10.10.10', 'title' => ''], ], [ - 'name' => 'Retention', + 'name' => 'Port', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The SIP service port of the parent platform.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5060', 'title' => ''], ], [ - 'name' => 'FileFormat', + 'name' => 'ClientAuth', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'hls', - ], + 'schema' => ['description' => 'Specifies whether to enable local authentication. Valid values:'."\n" + .'- true (default)'."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'JpgOverwrite', + 'name' => 'ClientUsername', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'osspath/snapshot/{AppName}/{StreamName}.jpg', - ], + 'schema' => ['description' => 'The local username.', 'type' => 'string', 'required' => false, 'example' => 'user01', 'title' => ''], ], [ - 'name' => 'JpgSequence', + 'name' => 'ClientPassword', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', - ], + 'schema' => ['description' => 'The local password.', 'type' => 'string', 'required' => false, 'example' => 'admin123', 'title' => ''], ], [ - 'name' => 'JpgOnDemand', + 'name' => 'AutoStart', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to automatically enable the platform. Valid values:'."\n" + .'- true'."\n" + .'- false (default)', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'example' => '359*****374-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Mp4', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"359*****374-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Modify a parent platform', + 'summary' => 'Modifies the information of a parent platform.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParentPlatform'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyParentPlatform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ModifyRenderingChargeType' => [ + 'summary' => 'Change the billing method for a Graphic Computing Service instance.', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Flv', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREvsJ3UH6I'], + ], + 'parameters' => [ + [ + 'name' => 'AutoRenew', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', - ], + 'schema' => ['description' => '> This value is valid only when `InstanceChargeType` is `PrePaid` (subscription).'."\n" + ."\n" + .'Enable or disable auto-renewal. Valid values:'."\n" + ."\n" + .'- **true**: Enable.'."\n" + ."\n" + .'- **false**: Disable.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'HlsM3u8', + 'name' => 'Period', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => '> This value is valid only when `InstanceChargeType` is `PrePaid` (subscription).'."\n" + ."\n" + .'The duration for subscription. Valid values (Note: If you select 12, it converts to one year; other values are in months):'."\n" + ."\n" + .'- 1 (default)'."\n" + ."\n" + .'- 2'."\n" + ."\n" + .'- 3'."\n" + ."\n" + .'- 4'."\n" + ."\n" + .'- 5'."\n" + ."\n" + .'- 6'."\n" + ."\n" + .'- 7'."\n" + ."\n" + .'- 8'."\n" + ."\n" + .'- 9'."\n" + ."\n" + .'- 12', 'type' => 'string', + 'default' => '1', + 'enum' => ['1', '2', '3', '4', '5', '6', '7', '8', '9', '12'], 'required' => false, - 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'HlsTs', + 'name' => 'InstanceBillingCycle', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => '> This value is valid only when `InstanceChargeType` is `PostPaid` (pay-as-you-go).'."\n" + ."\n" + .'Billing type. Valid values:'."\n" + ."\n" + .'- Hour: Hourly.', 'type' => 'string', + 'default' => 'Hour', + 'enum' => ['Hour'], 'required' => false, - 'example' => 'osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}', + 'example' => 'Hour', + 'title' => '', ], ], [ - 'name' => 'Callback', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://example.com/callback', - ], + 'schema' => ['description' => 'The ID of the Graphic Computing Service instance.', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], ], [ - 'name' => 'TransConfigsJSON', + 'name' => 'InstanceChargeType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The target billing method for the instance. Valid values:'."\n" + ."\n" + .'- PrePaid (default): Subscription.'."\n" + ."\n" + .'- PostPaid: Pay-as-you-go.', 'type' => 'string', - 'required' => false, - 'example' => '[{"Fps":25,"Gop":50,"Height":720,"VideoCodec":"h264","Width":1280,"Name":"sd","VideoBitrate":800}]', + 'required' => true, + 'enum' => ['PrePaid', 'PostPaid'], + 'example' => 'PostPaid', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of Response', + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****998-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['title' => 'ID of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'RenderingInstanceId' => ['title' => 'Graphic Computing Service instance ID', 'description' => 'The ID of the Graphic Computing Service instance', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"323*****998-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Change the billing method of a cloud application service instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\"\\n}","type":"json"}]', + ], + 'ModifyRenderingInstance' => [ + 'summary' => 'Upgrades or downgrades a cloud application service instance.', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREvsJ3UH6I'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'RenderingSpec', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****998-cn-qingdao', - ], + 'schema' => ['description' => 'Instance type of the cloud application service instance.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'crs.cp.l1'], + ], + [ + 'name' => 'StorageSize', + 'in' => 'query', + 'schema' => ['description' => 'Cloud storage capacity used by the cloud application service instance. This is not local storage.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'RenderingInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'ID of the cloud application service instance. You can only upgrade or downgrade to another instance type in the same series.', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'record', - ], - 'Trigger' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'auto', - ], - 'HlsTs' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}', - ], - 'Mp4' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', - ], - 'JpgOverwrite' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/snapshot/{AppName}/{StreamName}.jpg', - ], - 'Callback' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://example.com/callback', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'Retention' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'HlsM3u8' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Flv' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-12-10T10:00:00Z', - ], - 'OssEndpoint' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss-cn-qingdao.aliyuncs.com', - ], - 'OssFilePrefix' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss-prefix', - ], - 'JpgOnDemand' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg', - ], - 'OssBucket' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my_oss_bucket', - ], - 'FileFormat' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hls', - ], - 'JpgSequence' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', - ], - 'Interval' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3600', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****998-cn-qingdao', - ], - 'TransConfigs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Gop' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'Width' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1280', - ], - 'VideoBitrate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '800', - ], - 'Height' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '720', - ], - 'VideoCodec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'h264', - ], - 'Fps' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '25', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sd', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****430-cn-qingdao', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request', 'type' => 'string', 'example' => '6DFE7B89-8532-566F-B5CE-924B10FCE7AC'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"record\\",\\n \\"Trigger\\": \\"auto\\",\\n \\"HlsTs\\": \\"osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}\\",\\n \\"Mp4\\": \\"osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"JpgOverwrite\\": \\"osspath/snapshot/{AppName}/{StreamName}.jpg\\",\\n \\"Callback\\": \\"http://example.com/callback\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Description\\": \\"录制模板\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"Retention\\": 3,\\n \\"HlsM3u8\\": \\"osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"Name\\": \\"录制模板\\",\\n \\"Flv\\": \\"osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"CreatedTime\\": \\"2020-12-10T10:00:00Z\\",\\n \\"OssEndpoint\\": \\"oss-cn-qingdao.aliyuncs.com\\",\\n \\"OssFilePrefix\\": \\"oss-prefix\\",\\n \\"JpgOnDemand\\": \\"osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg\\",\\n \\"OssBucket\\": \\"my_oss_bucket\\",\\n \\"FileFormat\\": \\"hls\\",\\n \\"JpgSequence\\": \\"osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg\\",\\n \\"Interval\\": 3600,\\n \\"Id\\": \\"323*****998-cn-qingdao\\",\\n \\"TransConfigs\\": [\\n {\\n \\"Gop\\": 50,\\n \\"Width\\": 1280,\\n \\"VideoBitrate\\": 800,\\n \\"Height\\": 720,\\n \\"VideoCodec\\": \\"h264\\",\\n \\"Fps\\": 25,\\n \\"Name\\": \\"sd\\",\\n \\"Id\\": \\"399*****430-cn-qingdao\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeTemplate', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeTemplates' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Upgrade/Downgrade a Graphic Computing Service instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyRenderingInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ModifyRenderingInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6DFE7B89-8532-566F-B5CE-924B10FCE7AC\\"\\n}","type":"json"}]', + ], + 'ModifyRenderingInstanceAttribute' => [ + 'summary' => 'Modifies the attributes of a cloud application service instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '323434****83423432', - ], + 'schema' => ['description' => 'ID of the cloud application service instance.', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'Password', 'in' => 'query', + 'schema' => ['description' => 'Password for the device.', 'type' => 'string', 'required' => true, 'example' => 'Toehold2020', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'record', + 'title' => 'Schema of Response', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '323*****998-cn-qingdao', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Modify the properties of a cloud application service instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyRenderingInstanceAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ModifyRenderingInstanceBandwidth' => [ + 'summary' => 'Updates the rate limiting bandwidth for a cloud application service instance. You can call the DescribeRenderingInstance operation to retrieve the current rate limiting value and check the status of the rate limiting update.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '213857', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], + 'parameters' => [ [ - 'name' => 'SortDirection', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - ], + 'schema' => ['description' => 'The ID of the cloud application service instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'PageSize', + 'name' => 'MaxIngressBandwidth', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The maximum inbound bandwidth for rate limiting. Unit: Mbit/s. You must specify at least one of MaxIngressBandwidth and MaxEgressBandwidth.'."\n" + ."\n" + .'- By default, no rate limit is configured for the instance.'."\n" + ."\n" + .'- If you do not specify this parameter or set it to 0, the last configuration is retained.'."\n" + ."\n" + .'- If you set this parameter to a value less than 0, the rate limit is reset to unlimited.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '100'], ], [ - 'name' => 'PageNum', + 'name' => 'MaxEgressBandwidth', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The maximum outbound bandwidth for rate limiting. Unit: Mbit/s. You must specify at least one of MaxIngressBandwidth and MaxEgressBandwidth.'."\n" + ."\n" + .'- By default, no rate limit is configured for the instance.'."\n" + ."\n" + .'- If you do not specify this parameter or set it to 0, the last configuration is retained.'."\n" + ."\n" + .'- If you set this parameter to a value less than 0, the rate limit is reset to unlimited.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '100'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F3F88C96-CA6E-573E-B8F7-5BE83A1A0BCF', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Templates' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'record', - ], - 'Trigger' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'auto', - ], - 'OssFilePrefix' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my_prefix', - ], - 'HlsTs' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}', - ], - 'Mp4' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', - ], - 'JpgOnDemand' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg', - ], - 'OssBucket' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my_oss_bucket', - ], - 'JpgSequence' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', - ], - 'JpgOverwrite' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/snapshot/{AppName}/{StreamName}.jpg', - ], - 'FileFormat' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hls', - ], - 'Callback' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://example.com/callback', - ], - 'Interval' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3600', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'Retention' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'HlsM3u8' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', - ], - 'Flv' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-12-10T10:00:00Z', - ], - 'OssEndpoint' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss-cn-qingdao.aliyuncs.com', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****998-cn-qingdao', - ], - 'TransConfigs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Gop' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'Width' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1280', - ], - 'VideoBitrate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '800', - ], - 'Height' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '720', - ], - 'VideoCodec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'h264', - ], - 'Fps' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '25', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sd', - ], - 'id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399788187729597430-cn-qingdao', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"F3F88C96-CA6E-573E-B8F7-5BE83A1A0BCF\\",\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 5,\\n \\"Templates\\": [\\n {\\n \\"Type\\": \\"record\\",\\n \\"Trigger\\": \\"auto\\",\\n \\"OssFilePrefix\\": \\"my_prefix\\",\\n \\"HlsTs\\": \\"osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}\\",\\n \\"Mp4\\": \\"osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"JpgOnDemand\\": \\"osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg\\",\\n \\"OssBucket\\": \\"my_oss_bucket\\",\\n \\"JpgSequence\\": \\"osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg\\",\\n \\"JpgOverwrite\\": \\"osspath/snapshot/{AppName}/{StreamName}.jpg\\",\\n \\"FileFormat\\": \\"hls\\",\\n \\"Callback\\": \\"http://example.com/callback\\",\\n \\"Interval\\": 3600,\\n \\"Description\\": \\"录制模板\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"Retention\\": 3,\\n \\"HlsM3u8\\": \\"osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"Flv\\": \\"osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}\\",\\n \\"Name\\": \\"录制模板\\",\\n \\"CreatedTime\\": \\"2018-12-10T10:00:00Z\\",\\n \\"OssEndpoint\\": \\"oss-cn-qingdao.aliyuncs.com\\",\\n \\"Id\\": \\"323*****998-cn-qingdao\\",\\n \\"TransConfigs\\": [\\n {\\n \\"Gop\\": 50,\\n \\"Width\\": 1280,\\n \\"VideoBitrate\\": 800,\\n \\"Height\\": 720,\\n \\"VideoCodec\\": \\"h264\\",\\n \\"Fps\\": 25,\\n \\"Name\\": \\"sd\\",\\n \\"id\\": \\"399788187729597430-cn-qingdao\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeTemplates', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BindTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Update Throttling Bandwidth for a Graphic Computing Service Instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyRenderingInstanceBandwidth'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ModifyRenderingInstanceBandwidth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], ], + ], + 'ModifyTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****998-cn-qingdao', - ], + 'schema' => ['description' => 'The ID of the template.', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', 'title' => ''], ], [ - 'name' => 'TemplateType', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'record', - ], + 'schema' => ['description' => 'The name of the template.', 'type' => 'string', 'required' => false, 'example' => '录制模板', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****994-cn-qingdao', - ], + 'schema' => ['description' => 'The description of the template.', 'type' => 'string', 'required' => false, 'example' => '录制模板', 'title' => ''], ], [ - 'name' => 'InstanceType', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'group', - ], + 'schema' => ['description' => 'The region where the Object Storage Service (OSS) bucket is located.', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'OssBucket', + 'in' => 'query', + 'schema' => ['description' => 'The OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'bucketname', 'title' => ''], + ], + [ + 'name' => 'OssEndpoint', + 'in' => 'query', + 'schema' => ['description' => 'The domain name of the OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-qingdao.aliyuncs.com', 'title' => ''], + ], + [ + 'name' => 'OssFilePrefix', + 'in' => 'query', + 'schema' => ['description' => 'The prefix of the OSS file.', 'type' => 'string', 'required' => false, 'example' => 'oss-prefix', 'title' => ''], + ], + [ + 'name' => 'Trigger', + 'in' => 'query', + 'schema' => ['description' => 'The trigger type of the template. The default value is auto. Valid values:'."\n" + ."\n" + .'- auto (automatic)'."\n" + ."\n" + .'- ondemand (on-demand)', 'type' => 'string', 'required' => false, 'example' => 'auto', 'title' => ''], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => ['description' => 'The operation interval, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', 'title' => ''], + ], + [ + 'name' => 'Retention', + 'in' => 'query', + 'schema' => ['description' => 'The retention period for time shifting, in days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'FileFormat', + 'in' => 'query', + 'schema' => ['description' => 'The file format for storage. Separate multiple values with commas. Valid values:'."\n" + ."\n" + .'- mp4'."\n" + ."\n" + .'- flv'."\n" + ."\n" + .'- hls'."\n" + ."\n" + .'> Recording in FLV and MP4 formats is not supported in the China (Qingdao) region.', 'type' => 'string', 'required' => false, 'example' => 'hls', 'title' => ''], + ], + [ + 'name' => 'JpgOverwrite', + 'in' => 'query', + 'schema' => ['description' => 'The storage path for JPG files. This path is used to overwrite snapshots.'."\n" + ."\n" + .'- Only JPG images are supported.'."\n" + ."\n" + .'- The path supports variables such as {AppName} and {StreamName}.', 'type' => 'string', 'required' => false, 'example' => 'osspath/snapshot/{AppName}/{StreamName}.jpg', 'title' => ''], + ], + [ + 'name' => 'JpgSequence', + 'in' => 'query', + 'schema' => ['description' => 'The storage path for JPG files. This path is used for sequence snapshots.'."\n" + ."\n" + .'- Only JPG images are supported.'."\n" + ."\n" + .'- The path supports variables such as {AppName}, {StreamName}, {UnixTimestamp}, and {Sequence}.'."\n" + ."\n" + .'- You must include either {UnixTimestamp} or {Sequence}.', 'type' => 'string', 'required' => false, 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', 'title' => ''], + ], + [ + 'name' => 'JpgOnDemand', + 'in' => 'query', + 'schema' => ['description' => 'The storage path for JPG files. This path is used for on-demand snapshots.'."\n" + ."\n" + .'- Only JPG images are supported.'."\n" + ."\n" + .'- The path supports variables such as {AppName}, {StreamName}, {UnixTimestamp}, and {Sequence}.'."\n" + ."\n" + .'- You must include either {UnixTimestamp} or {Sequence}.', 'type' => 'string', 'required' => false, 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg', 'title' => ''], + ], + [ + 'name' => 'Mp4', + 'in' => 'query', + 'schema' => ['description' => 'The storage path for MP4 files.'."\n" + ."\n" + .'- The path supports variables such as {AppName}, {StreamName}, {Sequence}, {EscapedStartTime}, and {EscapedEndTime}.'."\n" + ."\n" + .'- You must include {EscapedStartTime} and {EscapedEndTime}.', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', 'title' => ''], + ], + [ + 'name' => 'Flv', + 'in' => 'query', + 'schema' => ['description' => 'The storage path for FLV files. For information about the format, see the description of the Mp4 parameter.', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', 'title' => ''], + ], + [ + 'name' => 'HlsM3u8', + 'in' => 'query', + 'schema' => ['description' => 'The storage path for HLS M3U8 files. For information about the format, see the description of the Mp4 parameter.', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', 'title' => ''], + ], + [ + 'name' => 'HlsTs', + 'in' => 'query', + 'schema' => ['description' => 'The storage path for HLS TS files.'."\n" + ."\n" + .'- The path supports variables such as {AppName}, {StreamName}, {UnixTimestamp}, and {Sequence}.'."\n" + ."\n" + .'- You must include the {UnixTimestamp} and {Sequence} variables.', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}', 'title' => ''], ], [ - 'name' => 'ApplyAll', + 'name' => 'Callback', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The callback URL that is used after the template is executed.', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback', 'title' => ''], ], [ - 'name' => 'Replace', + 'name' => 'TransConfigsJSON', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'An array of transcoding configurations of the TransConfig type, in a JSON-formatted string.', 'type' => 'string', 'required' => false, 'example' => '[{"Fps":25,"Gop":50,"Height":720,"VideoCodec":"h264","Width":1280,"Name":"sd","VideoBitrate":800}]', 'title' => ''], ], ], 'responses' => [ @@ -16158,730 +16393,882 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****994-cn-qingdao', - ], - 'InstanceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'group', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****998-cn-qingdao', - ], + 'Id' => ['description' => 'The ID of the template.', 'type' => 'string', 'example' => '323*****998-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"InstanceId\\": \\"323*****994-cn-qingdao\\",\\n \\"InstanceType\\": \\"group\\",\\n \\"TemplateId\\": \\"323*****998-cn-qingdao\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BindTemplate', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"323*****998-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Modify Template', + 'summary' => 'Modifies template information.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UnbindTemplate' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTemplate'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'MoveHiveEdgeWorkers' => [ + 'summary' => 'Moves the specified cloud application service instances from their current cluster to the target Hive.', + 'description' => '## Request'."\n" + ."\n" + .'- Ensure the target Hive has sufficient resources to accommodate the instances.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], + ], 'parameters' => [ [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '323*****998-cn-qingdao', - ], - ], - [ - 'name' => 'TemplateType', + 'name' => 'HiveId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'record' => 'record', - 'snapshot' => 'snapshot', - ], - 'example' => 'record', - ], + 'schema' => ['description' => 'The ID of the target Hive.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hive-xxxx-xxx-xxx'], ], [ - 'name' => 'InstanceId', + 'name' => 'InstanceIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'An instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ew-1226d588c69449209ee963161c067b04', 'title' => ''], 'required' => true, - 'example' => '323*****994-cn-qingdao', + 'description' => 'The IDs of the cloud application service instances to move.', + 'example' => '["ew-xxxx"]', + 'title' => '', ], ], - [ - 'name' => 'InstanceType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'stream' => 'stream', - 'group' => 'group', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'xxxx-xxx-xxx'], + 'SuccessInstanceCount' => ['description' => 'The number of successfully moved instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'FailedInstanceCount' => ['description' => 'The number of instances that failed to move.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'SuccessInstances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'ew-1226d588c69449209ee963161c067b04'], + 'Message' => ['description' => 'The result message. For a successful operation, the value is typically `SUCCESS`.', 'type' => 'string', 'title' => '', 'example' => 'SUCCESS'], + ], + 'description' => 'Information about a successfully moved instance.', + 'title' => '', + 'example' => '', + ], + 'description' => 'Details of the successfully moved instances.', + 'title' => '', + 'example' => '', + ], + 'FailedInstances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'example' => 'ew-1226d588c69449209ee963161c067b04'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'Error 1062 (23000): Duplicate entry \'hive-4fbf3928d40e43948b98acdb4fb5aaed-ew-1226d588c69449209ee9631\' for key \'PRIMARY\''], + ], + 'description' => 'Information about a failed instance.', + 'title' => '', + 'example' => '', + ], + 'description' => 'Details of the instances that failed to move.', + 'title' => '', + 'example' => '', + ], ], - 'example' => 'group', + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'MoveHiveEdgeWorkers', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxx-xxx-xxx\\",\\n \\"SuccessInstanceCount\\": 5,\\n \\"FailedInstanceCount\\": 0,\\n \\"SuccessInstances\\": [\\n {\\n \\"InstanceId\\": \\"ew-1226d588c69449209ee963161c067b04\\",\\n \\"Message\\": \\"SUCCESS\\"\\n }\\n ],\\n \\"FailedInstances\\": [\\n {\\n \\"InstanceId\\": \\"ew-1226d588c69449209ee963161c067b04\\",\\n \\"Message\\": \\"Error 1062 (23000): Duplicate entry \'hive-4fbf3928d40e43948b98acdb4fb5aaed-ew-1226d588c69449209ee9631\' for key \'PRIMARY\'\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'OpenVsService' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'TemplateType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'record', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****994-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'InstanceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'group', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****998-cn-qingdao', - ], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '150275784', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TemplateType\\": \\"record\\",\\n \\"InstanceId\\": \\"323*****994-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"InstanceType\\": \\"group\\",\\n \\"TemplateId\\": \\"323*****998-cn-qingdao\\"\\n}","type":"json"}]', - ], - 'BatchBindTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"150275784\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Activate the service', + 'summary' => 'Activates the service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:OpenVsService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'PushFile' => [ + 'summary' => 'Push a file to a specified cloud application service instance. This is an asynchronous operation. You can query the push progress using the ListFilePushStatuses operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '215938', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****998-cn-qingdao', - ], + 'schema' => ['description' => 'Cloud application service instance ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'InstanceId', + 'name' => 'FileId', 'in' => 'query', + 'schema' => ['description' => 'File ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'f-1671accd4dafdag3er256cvgewt13f7141db2f7'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****994-cn-qingdao', + 'title' => 'Schema of Response', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + ], + 'example' => '', ], ], - [ - 'name' => 'InstanceType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'group', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Push File', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PushFile'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:PushFile', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], ], ], + ], + ], + 'RebootRenderingInstance' => [ + 'summary' => 'Restarts a cloud application service instance. You can call the DescribeRenderingInstance API to monitor the restart progress.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ApplyAll', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '212048', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], + 'parameters' => [ + [ + 'name' => 'RenderingInstanceId', 'in' => 'query', + 'schema' => ['description' => 'ID of the cloud application service instance', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'title' => 'Schema of Response', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Restart a Graphic Computing Service instance ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebootRenderingInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:RebootRenderingInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], ], ], + ], + ], + 'RebootRenderingServer' => [ + 'summary' => 'Restarts the host of a cloud application service instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Replace', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], + ], + 'parameters' => [ + [ + 'name' => 'RenderingInstanceIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'description' => 'List of cloud application service instance IDs', + 'type' => 'array', + 'items' => ['description' => 'List of cloud application service instance IDs', 'type' => 'string', 'required' => false, 'example' => '[\\"render-6cdd65c6964c4ef2a635341f8c024191\\"]', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Bindings' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'SuccessInstanceCount' => ['description' => 'Number of successful cloud application service instances', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'SuccessInstances' => [ + 'description' => 'The instance ID of the cloud application service and the description of the result.', 'type' => 'array', 'items' => [ + 'description' => 'The ID of the Cloud App Service instance and the description of its association result.', 'type' => 'object', 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'some error', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****994-cn-qingdao', - ], - 'InstanceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'group', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****998-cn-qingdao', - ], + 'RenderingInstanceId' => ['description' => 'Cloud application service instance ID', 'type' => 'string', 'example' => 'render-e6cf423c787e4e43b460a788da254fe3', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'FailedInstanceCount' => ['description' => 'Number of cloud application service instances that failed to restart', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'FailedInstances' => [ + 'description' => 'Cloud application service instance IDs and their failure details', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RenderingInstanceId' => ['description' => 'Cloud application service instance ID', 'type' => 'string', 'example' => 'render-421cd2a1125947c19fcd5c7dd2c7d31e', 'title' => ''], + 'ErrMessage' => ['description' => 'Reason for failure', 'type' => 'string', 'example' => 'Rejected due to timeout', 'title' => ''], + 'ErrCode' => ['description' => 'Error code', 'type' => 'integer', 'format' => 'int32', 'example' => '300000', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Bindings\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"InstanceId\\": \\"323*****994-cn-qingdao\\",\\n \\"InstanceType\\": \\"group\\",\\n \\"TemplateId\\": \\"323*****998-cn-qingdao\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchBindTemplate', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BatchUnbindTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SuccessInstanceCount\\": 5,\\n \\"SuccessInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-e6cf423c787e4e43b460a788da254fe3\\"\\n }\\n ],\\n \\"FailedInstanceCount\\": 0,\\n \\"FailedInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-421cd2a1125947c19fcd5c7dd2c7d31e\\",\\n \\"ErrMessage\\": \\"Rejected due to timeout\\",\\n \\"ErrCode\\": 300000\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Restart the host of cloud application service instances ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:RebootRenderingServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RecoverRenderingDataPackage' => [ + 'summary' => 'Recover data to a Graphic Computing Service instance ', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212048', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], 'parameters' => [ [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '323*****998-cn-qingdao', - ], - ], - [ - 'name' => 'TemplateType', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'record', - ], + 'schema' => ['title' => '', 'description' => 'Cloud application service instance ID ', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'InstanceId', + 'name' => 'DataPackageId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****994-cn-qingdao', - ], + 'schema' => ['description' => 'Cloud application service data pack ID ', 'type' => 'string', 'required' => true, 'example' => 'dp-449ea3d16c0841b8bf33ec5bbc86a152'."\n", 'title' => ''], ], [ - 'name' => 'InstanceType', + 'name' => 'LoadMode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'group', - ], + 'schema' => ['description' => 'Data loading mode. Valid values: System or Process. Default value: System. System indicates system-level loading, which offers high stability but takes longer. Process indicates process-level loading, which provides high timeliness but relatively lower stability. ', 'type' => 'string', 'required' => false, 'example' => 'Process', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Bindings' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'some error', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****994-cn-qingdao', - ], - 'InstanceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'group', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****998-cn-qingdao', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Bindings\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"InstanceId\\": \\"323*****994-cn-qingdao\\",\\n \\"InstanceType\\": \\"group\\",\\n \\"TemplateId\\": \\"323*****998-cn-qingdao\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BatchBindTemplates' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Recover data to a cloud application service ', + 'changeSet' => [ + ['createdAt' => '2025-03-20T07:03:49.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecoverRenderingDataPackage'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:RecoverRenderingDataPackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RefreshRenderingInstanceStreaming' => [ + 'summary' => 'Call RefreshRenderingInstanceStreaming to refresh the stream connection for a cloud application service instance.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvs4YZ3LQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****998-cn-qingdao', - ], + 'schema' => ['description' => 'Cloud application service instance ID.', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], ], [ - 'name' => 'TemplateType', + 'name' => 'ClientInfo', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Client information.', + 'type' => 'object', + 'properties' => [ + 'ClientIp' => ['description' => 'Client IP address.', 'type' => 'string', 'required' => false, 'example' => '172.21.128.110', 'title' => ''], + 'NewClient' => ['description' => 'Indicates if the client is new.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], 'required' => false, - 'example' => 'timeshift', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'InstanceId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****994-cn-qingdao', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'RenderingInstanceId' => ['description' => 'Cloud application service instance ID.', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], + 'Gateway' => ['description' => 'Domain name of the streaming gateway for the cloud application service instance.', 'type' => 'string', 'example' => '10.178.208.22', 'title' => ''], + 'Hostname' => ['description' => 'Streaming domain name/IP for the cloud application service instance.', 'type' => 'string', 'example' => 'cn-xxx.ecr.aliyuncs.com', 'title' => ''], + 'Port' => ['description' => 'The port for the stream connection.', 'type' => 'string', 'example' => '8080', 'title' => ''], + 'FlowId' => ['description' => 'Token for this connection.', 'type' => 'string', 'example' => '792fy125-594c-4dde-ab35-9ff8hrf0a86f', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'InstanceType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'stream', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\",\\n \\"Gateway\\": \\"10.178.208.22\\",\\n \\"Hostname\\": \\"cn-xxx.ecr.aliyuncs.com\\",\\n \\"Port\\": \\"8080\\",\\n \\"FlowId\\": \\"792fy125-594c-4dde-ab35-9ff8hrf0a86f\\"\\n}","type":"json"}]', + 'title' => 'Purge the stream connection of a cloud application service instance', + 'description' => '> Specify at least one of the template ID or template type.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshRenderingInstanceStreaming'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:RefreshRenderingInstanceStreaming', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ReleaseRenderingDataPackage' => [ + 'summary' => 'Release a cloud application service data pack', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ApplyAll', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREvsJ3UH6I'], + ], + 'parameters' => [ [ - 'name' => 'Replace', + 'name' => 'DataPackageId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Cloud application service data pack ID', 'type' => 'string', 'required' => true, 'example' => 'dp-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20D0DFCE-5DB7-5D83-BD82-8482F2327636', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => 'Bindings', - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'some error', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****994-cn-qingdao ', - ], - 'InstanceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'group', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****998-cn-qingdao ', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '5BEF36E7-3838-5B92-BA32-87DBF1425ABC'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20D0DFCE-5DB7-5D83-BD82-8482F2327636\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"InstanceId\\": \\"323*****994-cn-qingdao\\\\t\\",\\n \\"InstanceType\\": \\"group\\",\\n \\"TemplateId\\": \\"323*****998-cn-qingdao\\\\t\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'BatchBindTemplates', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BatchUnbindTemplates' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Release cloud application service data pack', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseRenderingDataPackage'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ReleaseRenderingDataPackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BEF36E7-3838-5B92-BA32-87DBF1425ABC\\"\\n}","type":"json"}]', + ], + 'ReleaseRenderingInstance' => [ + 'summary' => 'Invoke ReleaseRenderingInstance to release a Graphic Computing Service application instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'RenderingInstanceId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Graphic Computing Service application instance ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '323*****998-cn-qingdao', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Release Graphic Computing Service Application Instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseRenderingInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ReleaseRenderingInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + ], + 'RenewRenderingInstance' => [ + 'summary' => 'Invoke RenewRenderingInstance to renew a cloud application service instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'TemplateType', + 'name' => 'AutoRenew', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'record', - ], + 'schema' => ['description' => 'Enable or disable auto-renewal. Valid values:'."\n" + ."\n" + .'- **true**: Enable.'."\n" + ."\n" + .'- **false**: Disable.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'Period', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The duration of the subscription. Valid values are 1 (default), 2, 3, 4, 5, 6, 7, 8, 9, 12. A value of 12 is converted to one year; other values are in months.', 'type' => 'string', - 'required' => true, - 'example' => '400941290881239938-cn-beijing', + 'enum' => ['1', '2', '3', '4', '5', '6', '7', '8', '9', '12'], + 'required' => false, + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'InstanceType', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'stream', - ], + 'schema' => ['description' => 'Cloud application service instance ID.', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '90B377DF-C874-5BBD-B957-42C4C06AFECE', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'some error', - ], - 'TemplateType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'snapshot', - ], - 'InstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****994-cn-qingdao', - ], - 'InstanceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'group', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****998-cn-qingdao', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90B377DF-C874-5BBD-B957-42C4C06AFECE\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"TemplateType\\": \\"snapshot\\",\\n \\"InstanceId\\": \\"323*****994-cn-qingdao\\",\\n \\"InstanceType\\": \\"group\\",\\n \\"TemplateId\\": \\"323*****998-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'StartRecordStream' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Renew Cloud Application Service Instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewRenderingInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:RenewRenderingInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], ], + ], + 'ResetRenderingInstance' => [ + 'summary' => 'Resets a cloud application service instance. You can query the DescribeRenderingInstance interface to obtain the reset progress.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234195', + 'abilityTreeNodes' => ['FEATUREvsUGIQL3'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '323*****997-cn-qingdao', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'PlayDomain', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'example.com', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Service instance ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], ], [ - 'name' => 'App', + 'name' => 'DataPackageId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'live', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Data baseline ID', 'type' => 'string', 'required' => false, 'example' => 'dp-449ea3d16c0841b8bf33ec5bbc86a152', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'ActionName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '310000*****000002', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'example' => 'Reset', 'default' => 'Reset', 'description' => '', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - 'type' => 'string', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], - 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - ], - 'StopRecordStream' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Reset Cloud Application Service Instance ', + 'changeSet' => [ + ['createdAt' => '2025-02-27T09:02:56.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetRenderingInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ResetRenderingInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ResumeVsStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '323*****997-cn-qingdao', - ], + 'schema' => ['description' => 'Your accelerated domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ - 'name' => 'PlayDomain', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'xxxxApp', 'title' => ''], ], [ - 'name' => 'App', + 'name' => 'StreamName', + 'in' => 'query', + 'schema' => ['description' => 'The stream name.', 'type' => 'string', 'required' => true, 'example' => 'xxxxStream', 'title' => ''], + ], + [ + 'name' => 'LiveStreamType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The stream type.'."\n" + ."\n" + .'> Only publisher is supported.', 'type' => 'string', - 'required' => false, - 'example' => 'live', + 'required' => true, + 'enum' => ['publisher'], + 'example' => 'publisher', + 'title' => '', ], ], [ - 'name' => 'Name', + 'name' => 'ControlStreamAction', 'in' => 'query', 'schema' => [ - 'description' => '', 'type' => 'string', 'required' => false, - 'example' => 'test', + 'default' => 'resume', + 'enum' => ['resume'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], @@ -16890,136 +17277,167 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664 ', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - ], - 'DescribeRecords' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\\\t\\"\\n}","type":"json"}]', + 'title' => 'Recover push for a stream', + 'summary' => 'Resumes pushing for a stream.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => '# Special error codes '."\n" + .'| Error Code | Description | HTTP Status Code | Semantics |'."\n" + .'| :----- | :----- | :----- | :----- |'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | An unknown error occurred in the backend. |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain was not found under the current account. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | The current operation is not supported, such as using a non-live streaming domain. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResumeVsStream'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:ResumeVsStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'SendRenderingInstanceCommands' => [ + 'summary' => 'Sends shell control instructions to a cloud application service instance. This operation supports both sync and asynchronous command responses. The sync scenario is not suitable for time-consuming commands. The maximum execution time cannot exceed 30 s. In an asynchronous scenario, you can call the GetRenderingInstanceCommandsStatus operation to query the execution status and result of a command.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213860', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'Type', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'record' => 'record', - 'snapshot' => 'snapshot', - ], - 'example' => 'record', - ], + 'schema' => ['description' => 'The ID of the cloud application service instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'StreamId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '323*****997-cn-qingdao', - ], + 'name' => 'Commands', + 'in' => 'formData', + 'schema' => ['description' => 'A shell command string. Enter multiple commands separated by semicolons (;) or line feeds.'."\n" + ."\n" + .'- Dangerous commands such as rm and reboot are disabled.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'title' => '', 'example' => 'date;ls -l /tmp'], ], [ - 'name' => 'StartTime', + 'name' => 'Mode', 'in' => 'query', 'schema' => [ - 'description' => '', + 'title' => 'Command response mode. Valid values: '."\n" + .'1. Sync: Synchronous response. Default value. '."\n" + .'2. Async: Asynchronous response ', + 'description' => 'The response pattern for the command. Valid values:'."\n" + ."\n" + .'1. Sync: The response is returned synchronously. This is the default value.'."\n" + ."\n" + .'2. Async: The response is returned asynchronously.', 'type' => 'string', - 'required' => true, - 'example' => '2021-11-22T00:00:00Z', + 'required' => false, + 'enum' => ['Async', 'Sync'], + 'example' => 'Async', ], ], [ - 'name' => 'EndTime', + 'name' => 'Timeout', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2021-11-24T00:00:00Z', - ], + 'schema' => ['title' => 'Timeout for command execution, in seconds. The valid range depends on the Mode parameter: '."\n" + .'1. Mode=Sync: 0–30, default value is 30 '."\n" + .'2. Mode=Async: 0–3600, default value is 300 ', 'description' => 'The timeout period for command execution, in seconds. The value range depends on the Mode parameter:'."\n" + ."\n" + .'1. If Mode is set to Sync, the value range is 0 to 30. The default value is 30.'."\n" + ."\n" + .'2. If Mode is set to Async, the value range is 0 to 3600. The default value is 300.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '3600', 'minimum' => '0', 'required' => false, 'example' => '60'], ], - [ - 'name' => 'PrivateBucket', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'Result' => ['description' => 'The result of the command response.', 'type' => 'string', 'title' => '', 'example' => 'Thu Jun 27 16:06:26 CST 2024'], + 'CmdId' => ['title' => 'Unique ID of the command request. By default, it is valid for 1 day. For asynchronous scenarios where you need to follow up on the result, we recommend querying the result as soon as possible within the validity period (preferably before the command execution timeout). ', 'description' => 'The unique ID of the command request. The ID is valid for one day by default. In asynchronous scenarios, if you need the result, query it promptly within the validity period, preferably before the command times out.', 'type' => 'string', 'example' => 'cmd-81de027b66e442e99c1e0e09a16a0be5'], + ], + 'example' => '', ], ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Id', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Result\\": \\"Thu Jun 27 16:06:26 CST 2024\\",\\n \\"CmdId\\": \\"cmd-81de027b66e442e99c1e0e09a16a0be5\\"\\n}","type":"json"}]', + 'title' => 'Send Control Command to Cloud Application Service Instance '."\n", + 'changeSet' => [ + ['createdAt' => '2025-06-19T08:44:41.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendRenderingInstanceCommands'], ], + ], + 'ramActions' => [ [ - 'name' => 'SortDirection', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => 'asc', - 'desc' => 'desc', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:SendRenderingInstanceCommands', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], ], - 'example' => 'asc', ], ], + ], + ], + 'SetPreset' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'PageNum', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'PresetId', + 'in' => 'query', + 'schema' => ['description' => 'Preset ID.
'."\n" + .'Valid values: 1 to 7.
', 'type' => 'string', 'required' => true, 'example' => '2', 'title' => ''], ], ], 'responses' => [ @@ -17027,560 +17445,655 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'NextStartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-12-10T11:00:00Z', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Records' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'record', - ], - 'Height' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1080', - ], - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://my_oss_bucket.oss-cn-qingdao.aliyuncs.com/record/live/310*****007/2021-11-23-18-19-38_2021-11-23-18-33-48.m3u8', - ], - 'OssBucket' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my_oss_bucket', - ], - 'FileFormat' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hls', - ], - 'StreamId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '323*****997-cn-qingdao', - ], - 'OssObject' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'record/live/310*****007/2021-11-23-18-19-38_2021-11-23-18-33-48.m3u8', - ], - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-11-23T18:33:48', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-11-23T18:19:32', - ], - 'Width' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1920', - ], - 'TemplateId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '388*****204-cn-qingdao', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2be2a673-6033-4874-b6f2-f2bc0a1*****', - ], - 'OssEndpoint' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss-cn-qingdao.aliyuncs.com', - ], - ], - ], - ], + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '30295DF1-1DC7-48BA-BE5A-D58E61EB2375', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"NextStartTime\\": \\"2018-12-10T11:00:00Z\\",\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"PageCount\\": 5,\\n \\"Records\\": [\\n {\\n \\"Type\\": \\"record\\",\\n \\"Height\\": 1080,\\n \\"Url\\": \\"http://my_oss_bucket.oss-cn-qingdao.aliyuncs.com/record/live/310*****007/2021-11-23-18-19-38_2021-11-23-18-33-48.m3u8\\",\\n \\"OssBucket\\": \\"my_oss_bucket\\",\\n \\"FileFormat\\": \\"hls\\",\\n \\"StreamId\\": \\"323*****997-cn-qingdao\\",\\n \\"OssObject\\": \\"record/live/310*****007/2021-11-23-18-19-38_2021-11-23-18-33-48.m3u8\\",\\n \\"EndTime\\": \\"2021-11-23T18:33:48\\",\\n \\"StartTime\\": \\"2021-11-23T18:19:32\\",\\n \\"Width\\": 1920,\\n \\"TemplateId\\": \\"388*****204-cn-qingdao\\",\\n \\"Id\\": \\"2be2a673-6033-4874-b6f2-f2bc0a1*****\\",\\n \\"OssEndpoint\\": \\"oss-cn-qingdao.aliyuncs.com\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"30295DF1-1DC7-48BA-BE5A-D58E61EB2375\\"\\n}","type":"json"}]', + 'title' => 'Set a preset', + 'summary' => 'Set a preset position.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SetVsDomainCertificate' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetPreset'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:SetPreset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'SetVsDomainCertificate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'example.aliyundoc.com', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The accelerated domain name to which the certificate belongs.'."\n" + ."\n" + .'> The domain must use HTTPS acceleration.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ 'name' => 'SSLProtocol', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'on', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Whether to enable the HTTPS certificate. Valid values:'."\n" + ."\n" + .'- **on**: Enable.'."\n" + ."\n" + .'- **off** (default): Disable.', 'type' => 'string', 'required' => true, 'example' => 'on', 'title' => ''], ], [ 'name' => 'CertName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'Cert-77****7', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The certificate name.', 'type' => 'string', 'required' => false, 'example' => 'Cert-77****7', 'title' => ''], ], [ 'name' => 'CertType', 'in' => 'query', 'schema' => [ - 'description' => '', - 'example' => 'free', - 'required' => false, + 'description' => 'The certificate type.'."\n" + ."\n" + .'- upload: Upload certificate'."\n" + ."\n" + .'- cas: Alibaba Cloud Security certificate'."\n" + ."\n" + .'- free: Personal test certificate (Free Edition)', 'type' => 'string', - 'enum' => [ - 'free', - 'cas', - 'upload', - ], + 'required' => false, + 'enum' => ['free', 'cas', 'upload'], + 'example' => 'free', + 'title' => '', ], ], [ 'name' => 'SSLPub', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '328uiuii28****82dsada81', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The public certificate content. Omit this parameter if you disable the certificate. Provide the certificate content if you configure a certificate.', 'type' => 'string', 'required' => false, 'example' => '328uiuii28****82dsada81', 'title' => ''], ], [ 'name' => 'SSLPri', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'xxxxxxx', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The private key content. Omit this parameter if you disable the certificate. Provide the private key content if you configure a certificate.', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxx', 'title' => ''], ], [ 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'cn-qingdao', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The region.', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao', 'title' => ''], ], [ 'name' => 'ForceSet', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Set to 1 to skip the certificate name duplication check and overwrite an existing certificate with the same name.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '119F7639-4646-51A4-B6C1-300D391C0104', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '119F7639-4646-51A4-B6C1-300D391C0104', 'title' => ''], ], 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"119F7639-4646-51A4-B6C1-300D391C0104\\"\\n}","type":"json"}]', + 'title' => 'Configure Domain Name Certificate Information', + 'summary' => 'Enable or disable the certificate feature for a domain name.', + 'extraInfo' => '# Special Error Codes'."\n" + .'| ErrorCode | Message | HTTP Status | Semantics |'."\n" + .'|:-----|:-----|:-----|:-----|'."\n" + .'| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | The domain name does not exist or does not belong to the current User. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | You do not have permission to execute the current operation. |'."\n" + .'| ServiceBusy | The specified domain is configuring, please retry later. | 403 | The domain name is being configured. Please try again later. |'."\n" + .'| InvalidDomain.Offline | The domain provided is offline. | 400 | The domain name has been unpublished. |'."\n" + .'| OperationDenied | Your CDN service is suspended. | 403 | The Account has an overdue payment. Please Recharge. |'."\n" + .'| InvalidSSLProtocol.ValueNotSupported | The specified value of parameter Enable is not supported. | 400 | The value of SSLProtocol is invalid. |'."\n" + .'| SSLPub.MissingParameter | An input parameter SSLPub that is mandatory for processing the request is not supplied. | 400 | The SSLPub parameter is missing. |'."\n" + .'| SSLPri.MissingParameter | An input parameter SSLPri that is mandatory for processing the request is not supplied. | 400 | The SSLPri parameter is missing. |'."\n" + .'| InvalidCertificate | The Certificate you provided is malformed! | 400 | The certificate Content is invalid. |'."\n" + .'| InvalidSSLPri | The SSLPri you provided is malformed! | 400 | The private key Content is invalid. |'."\n" + .'| Certificate.MissMatch | The SSLPri does not match the specified Certificate! | 400 | The certificate and private key do not match. |'."\n" + .'| InvalidCertificate.TooLong | The Certificate you provided is over the max length! | 400 | The certificate Content exceeds the maximum length limit. |'."\n" + .'| InvalidCertName.TooLong | The Certificate name you provided is over the max length 128! | 400 | The certificate Name cannot exceed 128 characters. |'."\n" + .'| SetDomainSSLPub.ParameterError | Parameters have error. | 400 | Parameter Error. |'."\n" + .'| Certificate.StatusError | Certificate does not exist or its status is error. | 400 | The certificate does not exist or its status is invalid. |'."\n" + .'| DeleteFailed | Delete certificate failed. | 400 | Failed to delete the certificate. |'."\n" + .'| Certificate.NotFind | Not find the certificate info. | 400 | The corresponding certificate was not found. |'."\n" + .'| Certificate.Duplicated | The certificate name is duplicated. | 400 | Name Duplication for the certificate. |'."\n" + .'| Certificate.FormatError | The certificate format is error. | 400 | The certificate format is invalid. |'."\n" + .'| Certificate.StatusError | The certificate status is error. | 400 | The certificate status is invalid. |'."\n" + .'| Certificate.KeyNull | The SSLPri is not null. | 400 | The private key Cannot Be Empty. |'."\n" + .'| SSLPri.Malformed | The SSLPri format is error. | 400 | The private key format is invalid. |'."\n" + .'| Certificate.NotPermittedOff | Turn off certificate will change domain scheduling, please contact customer service. | 400 | Disabling the certificate affects domain schedule. Please contact Customer support for adjustment. |'."\n" + .'| Certificate.SettedNotEffect | Certificate was successfully set but does not take effect for protecting current service, please contact customer service. | 400 | The certificate was set successfully, but it has not taken effect to protect the current service. Please contact customer service for assistance. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetVsDomainCertificate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:SetVsDomainCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], - 'DescribeVsCertificateDetail' => [ - 'methods' => [ - 'post', - 'get', + 'SetVsStreamsNotifyUrlConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'Your accelerated domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], + ], + [ + 'name' => 'NotifyUrl', + 'in' => 'query', + 'schema' => ['description' => 'The URL to which live stream information is pushed.'."\n" + ."\n" + .'> This URL must start with http\\:// or https\\://.', 'type' => 'string', 'required' => true, 'example' => 'http://xxx.com/xx', 'title' => ''], + ], + [ + 'name' => 'AuthType', + 'in' => 'query', + 'schema' => ['description' => 'The authentication type. Valid values:'."\n" + ."\n" + .'- **no\\_auth** (disabled)'."\n" + ."\n" + .'- **type\\_a** (method A)'."\n" + ."\n" + .'- **type\\_b** (method B)'."\n" + ."\n" + .'- **type\\_c** (method C)', 'type' => 'string', 'required' => false, 'example' => 'type_a', 'title' => ''], + ], + [ + 'name' => 'AuthKey', + 'in' => 'query', + 'schema' => ['description' => 'The primary key associated with the playback domain name. This key generates authenticated URLs.'."\n" + ."\n" + .'> Call the [DescribeVsDomainConfigs](https://help.aliyun.com/document_detail/464513.html) operation to query the AuthKey value.', 'type' => 'string', 'required' => false, 'example' => 'ocs*****ace', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Configure VS Stream Notifications URL', + 'summary' => 'Configure stream ingest callbacks.', + 'extraInfo' => '## Special Error Codes '."\n" + .'| Error Code | Description | HTTP Status Code | Semantics |'."\n" + .'|------------|-------------|------------------|-----------|'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | An unknown error occurred in the backend. |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain name was not found under the current account. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | The current operation is not supported, such as when the domain is not of the live streaming type. |'."\n" + .'| InvalidNotifyUrl.Malformed | Specified parameter NotifyUrl is not valid. | 400 | The NotifyUrl is not a valid HTTP address. |'."\n" + .'| InvalidNotifyUrl.Unsafe | Specified NotifyUrl is not safe. | 400 | The NotifyUrl value is unsafe. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetVsStreamsNotifyUrlConfig'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:SetVsStreamsNotifyUrlConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StartDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'CertName', + 'name' => 'Id', 'in' => 'query', + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '323884****9092996', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '323884****9092996', 'title' => ''], + 'RequestId' => ['description' => 'Request ID for this task.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cert-539xxxx', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"323884****9092996\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Start Device', + 'summary' => 'Start stream pulling from a device. This action starts all streams on the device.', + 'description' => 'Each device currently supports only one ingest endpoint. The effect is the same as StartStream.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StartDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + ], + 'StartParentPlatform' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'required' => true, 'example' => '359*****374-cn-qingdao', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'CertName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cert-539xxxxx', - ], - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'Cert' => [ - 'description' => '', - 'type' => 'string', - 'example' => '-----BEGIN CERTIFICATE-----xxxxx-----END CERTIFICATE-----', - ], - 'CertId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '63000000', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D94D0E1E-E71B-562D-8C18-969BB3653FBD', - ], + 'Id' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'example' => '359*****374-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"CertName\\": \\"cert-539xxxxx\\",\\n \\"Key\\": \\"xxxxx\\",\\n \\"Cert\\": \\"-----BEGIN CERTIFICATE-----xxxxx-----END CERTIFICATE-----\\",\\n \\"CertId\\": 63000000,\\n \\"RequestId\\": \\"D94D0E1E-E71B-562D-8C18-969BB3653FBD\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeVsCertificateDetail', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"359*****374-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Start parent platform interaction', + 'summary' => 'Starts interactions with the parent platform, such as registration and keep-alive.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartParentPlatform'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StartParentPlatform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], - 'DescribeVsDomainCertificateInfo' => [ - 'methods' => [ - 'post', - 'get', + 'StartPublishStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PublishUrl', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPublishStream'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": 0,\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'StartRecordStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'AK' => [], + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'Stream ID.', 'type' => 'string', 'required' => false, 'example' => '323*****997-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'PlayDomain', + 'in' => 'query', + 'schema' => ['description' => 'The stream\'s playback domain name.', 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => ['description' => 'The stream\'s App name.', 'type' => 'string', 'required' => false, 'example' => 'live', 'title' => ''], ], - ], - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', - ], + 'schema' => ['description' => 'Stream name.', 'type' => 'string', 'required' => false, 'example' => '310000*****000002', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'CertInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'CertInfo' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'CertLife' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'months', - ], - 'CertExpireTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-06-03T22:03:39Z', - ], - 'SSLPub' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'asdadaxxxx', - ], - 'CertType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'free', - ], - 'ServerCertificateStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'on', - ], - 'CertDomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.com', - ], - 'CertName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'myname', - ], - 'CertOrg' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Let\'s Encrypt', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.com', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"CertInfos\\": {\\n \\"CertInfo\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"CertLife\\": \\"months\\",\\n \\"CertExpireTime\\": \\"2018-06-03T22:03:39Z\\",\\n \\"SSLPub\\": \\"asdadaxxxx\\",\\n \\"CertType\\": \\"free\\",\\n \\"ServerCertificateStatus\\": \\"on\\",\\n \\"CertDomainName\\": \\"example.com\\",\\n \\"CertName\\": \\"myname\\",\\n \\"CertOrg\\": \\"Let\'s Encrypt\\",\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeVsCertificateList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Start on-demand recording', + 'summary' => 'Starts on-demand recording for the specified stream.', + 'description' => '> - An on-demand record template is required. You must first attach one to the space or stream.'."\n" + .'>'."\n" + .'> - You can specify a stream in two ways: using its ID or its PlayDomain/App/Name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartRecordStream'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StartRecordStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StartRenderingSession' => [ + 'summary' => 'Schedules an idle cloud application service instance for the requesting client (ClientId) and starts the service. If the requesting client (ClientId) sends another start request after a successful start and the associated session is in the SessionStartSuspended state, the session is restarted. If the session is in any other state, the session information is returned directly.', + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'ProjectId', 'in' => 'query', + 'schema' => ['description' => 'Project ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => 'Unique ID of the client', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '04c30850-1d91-4da1-b811-66d0ee94af7d'], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => ['description' => 'Cloud application ID', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], + ], + [ + 'name' => 'ClientParams', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'Client parameter information', + 'type' => 'object', + 'properties' => [ + 'ClientIp' => ['description' => 'Client IP address. This IP address is used by default for scheduling instances based on proximity.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '106.11.43.1'], + ], 'required' => false, - 'example' => 'example.aliyundoc.com', + 'example' => '', ], ], + [ + 'name' => 'PatchId', + 'in' => 'query', + 'schema' => ['title' => 'The ID of the cloud application patch package. '."\n" + .'1. By default, the stable version of the AppId is started (if no stable patch version is set, the original version is used by default). '."\n" + .'2. Enter "origin" to start the original version. ', 'description' => 'Cloud application patch ID.'."\n" + ."\n" + .'1. By default, start the stable version of the AppId (if no stable patch version is set, the original version is used).'."\n" + ."\n" + .'2. If you enter "origin", start the original version.', 'type' => 'string', 'example' => 'patch-03fa76e8e13a49b63456b063dgh309b4', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6E310519-E035-51AB-80D4-C1CBECD39EB5', + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'SessionId' => ['description' => 'Session ID', 'type' => 'string', 'title' => '', 'example' => 'session-i205217481741918129226'], + 'Hostname' => ['description' => 'Instance hostname. By default, this is the EIP used for access.', 'type' => 'string', 'title' => '', 'example' => 'cn-xxx.ecr.aliyuncs.com'], + 'PortMappings' => [ + 'title' => '', + 'description' => 'Port mapping information', + 'type' => 'array', + 'items' => [ + 'description' => 'Port mapping information', + 'type' => 'object', + 'properties' => [ + 'ExternalPort' => ['description' => 'External port or port range, such as 22. For a port range, separate the start and end ports with a forward slash (/), for example, 10/20.', 'type' => 'string', 'title' => '', 'example' => '10013/10020'], + 'InternalPort' => ['description' => 'Internal port or port range. Ports correspond one-to-one with external ports. For a port range, separate the start and end ports with a forward slash (/), for example, 10/20.', 'type' => 'string', 'title' => '', 'example' => '49008/49015'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'CertificateListModel' => [ - 'description' => '', + 'StateInfo' => [ + 'title' => '', + 'description' => 'Session state information', 'type' => 'object', 'properties' => [ - 'Count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CertList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LastTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1632462708', - ], - 'Fingerprint' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3EB2585309AE5C8F369****7CDA6A8F5CEC8B2D4', - ], - 'CertName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cert-5391062', - ], - 'Issuer' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxxCert Inc', - ], - 'CertId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6338888', - ], - 'Common' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - ], - ], - ], + 'State' => ['description' => 'Session state', 'type' => 'string', 'title' => '', 'example' => 'SessionStarting'], + 'Comment' => ['description' => 'State description', 'type' => 'string', 'title' => '', 'example' => '会话启动中'], + 'UpdateTime' => ['description' => 'Last update time of the state', 'type' => 'string', 'title' => '', 'example' => '2021-05-06T06:37Z'], ], + 'example' => '', + ], + 'Location' => [ + 'title' => '', + 'description' => 'Cloud application service instance location information', + 'type' => 'object', + 'properties' => [ + 'ProvinceCode' => ['description' => 'Province code of the cloud application service instance', 'type' => 'string', 'title' => '', 'example' => '610000'], + ], + 'example' => '', ], + 'IsRepeatedRequest' => ['description' => 'Is this a repeated request', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'RenderingInstanceId' => ['title' => 'Cloud application service instance ID', 'description' => 'Cloud application service instance ID', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6E310519-E035-51AB-80D4-C1CBECD39EB5\\",\\n \\"CertificateListModel\\": {\\n \\"Count\\": 2,\\n \\"CertList\\": [\\n {\\n \\"LastTime\\": 1632462708,\\n \\"Fingerprint\\": \\"3EB2585309AE5C8F369****7CDA6A8F5CEC8B2D4\\",\\n \\"CertName\\": \\"cert-5391062\\",\\n \\"Issuer\\": \\"xxxxCert Inc\\",\\n \\"CertId\\": 6338888,\\n \\"Common\\": \\"example.aliyundoc.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeVsCertificateList', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeVsDomainDetail' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SessionId\\": \\"session-i205217481741918129226\\",\\n \\"Hostname\\": \\"cn-xxx.ecr.aliyuncs.com\\",\\n \\"PortMappings\\": [\\n {\\n \\"ExternalPort\\": \\"10013/10020\\",\\n \\"InternalPort\\": \\"49008/49015\\"\\n }\\n ],\\n \\"StateInfo\\": {\\n \\"State\\": \\"SessionStarting\\",\\n \\"Comment\\": \\"会话启动中\\",\\n \\"UpdateTime\\": \\"2021-05-06T06:37Z\\"\\n },\\n \\"Location\\": {\\n \\"ProvinceCode\\": \\"610000\\"\\n },\\n \\"IsRepeatedRequest\\": false,\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\"\\n}","type":"json"}]', + 'title' => 'Start Session', + 'changeSet' => [ + ['createdAt' => '2025-08-21T12:22:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-19T08:44:42.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartRenderingSession'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StartRenderingSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StartStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', - ], + 'schema' => ['description' => 'Stream ID.', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'For an NVR historical stream, the Start Time (UNIX timestamp, in seconds).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1589336385', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'For an NVR historical stream, the End Time (UNIX timestamp, in seconds).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1599336385', 'title' => ''], ], ], 'responses' => [ @@ -17588,113 +18101,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9BEC5E85-C76B-56EF-A922-860EFDB8B64B', - ], - 'DomainConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GmtCreated' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-07-19T10:27:23Z', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'SSLProtocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'off', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-qingdao', - ], - 'Scope' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'domestic', - ], - 'Cname' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com.*****.com', - ], - 'DomainStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'online', - ], - 'GmtModified' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-07-19T10:27:23Z', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'DomainType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vs', - ], - ], - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'Name' => ['description' => 'Stream name.', 'type' => 'string', 'example' => '31000000000000000002', 'title' => ''], + 'Id' => ['description' => 'Stream ID.', 'type' => 'string', 'example' => '323*****997-cn-qingdao', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9BEC5E85-C76B-56EF-A922-860EFDB8B64B\\",\\n \\"DomainConfig\\": {\\n \\"GmtCreated\\": \\"2021-07-19T10:27:23Z\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"SSLProtocol\\": \\"off\\",\\n \\"Region\\": \\"cn-qingdao\\",\\n \\"Scope\\": \\"domestic\\",\\n \\"Cname\\": \\"example.aliyundoc.com.*****.com\\",\\n \\"DomainStatus\\": \\"online\\",\\n \\"GmtModified\\": \\"2021-07-19T10:27:23Z\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DomainType\\": \\"vs\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'DescribeVsDomainConfigs' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Name\\": \\"31000000000000000002\\",\\n \\"Id\\": \\"323*****997-cn-qingdao\\"\\n}","type":"json"}]', + 'title' => 'Start Stream', + 'summary' => 'Start a stream.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartStream'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StartStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StartTransferStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'DomainName', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', - ], + 'schema' => ['description' => 'Stream ID.', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', 'title' => ''], ], [ - 'name' => 'FunctionNames', + 'name' => 'Url', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'path_based_ttl_set,oss_auth', - ], + 'schema' => ['description' => 'The destination address for stream forwarding.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], + ], + [ + 'name' => 'Transcode', + 'in' => 'query', + 'schema' => ['description' => 'The name of the transcoding rule (a transcoding template must be bound first).', 'type' => 'string', 'required' => false, 'example' => 'sd', 'title' => ''], ], ], 'responses' => [ @@ -17702,96 +18166,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D94D0E1E-E71B-562D-8C18-969BB3653FBD', - ], - 'DomainConfigs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'ConfigId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6295', - ], - 'FunctionName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aliauth', - ], - 'FunctionArgs' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ArgName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'auth_type', - ], - 'ArgValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'req_auth', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID of this task.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D94D0E1E-E71B-562D-8C18-969BB3653FBD\\",\\n \\"DomainConfigs\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"ConfigId\\": \\"6295\\",\\n \\"FunctionName\\": \\"aliauth\\",\\n \\"FunctionArgs\\": [\\n {\\n \\"ArgName\\": \\"auth_type\\",\\n \\"ArgValue\\": \\"req_auth\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - ], - 'BatchSetVsDomainConfigs' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Start Transfer Stream', + 'summary' => 'Starts forwarding a stream to an external address.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartTransferStream'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StartTransferStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopAdjust' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'DomainNames', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], [ - 'name' => 'Functions', + 'name' => 'Iris', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '[{“functionArgs”:[{“argName”:”domain_name”,”argValue”:”api.hellodtworld.com”}],”functionName”:”set_req_host_header”}]', - ], + 'schema' => ['description' => 'Stop adjusting the aperture. Default is false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Focus', + 'in' => 'query', + 'schema' => ['description' => 'Stop adjusting the zoom. Default is false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -17799,53 +18229,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9BEC5E85-C76B-56EF-A922-860EFDB8B64B', - ], + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9BEC5E85-C76B-56EF-A922-860EFDB8B64B\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - ], - 'BatchDeleteVsDomainConfigs' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Stop adjusting the lens', + 'summary' => 'Stops lens adjustments, such as aperture or zoom changes.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopAdjust'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopAdjust', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'DomainNames', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], [ - 'name' => 'FunctionNames', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'https_force', - ], + 'schema' => ['description' => 'Time to restart the stream.', 'type' => 'string', 'required' => false, 'example' => '2021-12-10T10:00:00Z', 'title' => ''], ], ], 'responses' => [ @@ -17853,70 +18291,72 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'Request ID for this operation.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchDeleteVsDomainConfigs', - ], - 'DescribeVsTopDomainsByFlow' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Stop Device', + 'summary' => 'Stops stream pulling for a device. This operation terminates all streams on that device.', + 'description' => 'Stops stream pulling for a device. This operation terminates all streams on that device.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDevice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopMove' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-12-12T10:00:00Z', - ], + 'schema' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Pan', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2018-12-10T18:00:00Z', - ], + 'schema' => ['description' => 'Specifies whether to stop panning. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Limit', + 'name' => 'Tilt', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '3', - 'default' => '20', - ], + 'schema' => ['description' => 'Specifies whether to stop tilting. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Zoom', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to stop zooming. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -17924,150 +18364,55 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DomainOnlineCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-12-10T18:00:00Z', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-10T10:00:00Z', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'DomainCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TopDomains' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'TopDomain' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MaxBps' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Rank' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalAccess' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TrafficPercent' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30.64191989360235', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'TotalTraffic' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'MaxBpsTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1457111400', - ], - ], - ], - ], - ], - ], + 'Id' => ['description' => 'The device ID.', 'type' => 'string', 'example' => '348*****380-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The format of the specified StartTime is invalid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The format of the specified EndTime is invalid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', - ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The specified StartTime is invalid.', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Stop Lens Movement', + 'summary' => 'Stops camera movement, such as panning, tilting, and zooming.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopMove'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopMove', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DomainOnlineCount\\": 12,\\n \\"EndTime\\": \\"2018-12-10T18:00:00Z\\",\\n \\"StartTime\\": \\"2021-12-10T10:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainCount\\": 20,\\n \\"TopDomains\\": {\\n \\"TopDomain\\": [\\n {\\n \\"MaxBps\\": 100,\\n \\"Rank\\": 1,\\n \\"TotalAccess\\": 100,\\n \\"TrafficPercent\\": \\"30.64191989360235\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"TotalTraffic\\": \\"100\\",\\n \\"MaxBpsTime\\": \\"1457111400\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'SetPreset' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopPublishStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], - ], - [ - 'name' => 'PresetId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -18075,62 +18420,57 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30295DF1-1DC7-48BA-BE5A-D58E61EB2375', - ], + 'Code' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"30295DF1-1DC7-48BA-BE5A-D58E61EB2375\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'SetPreset', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GotoPreset' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopPublishStream'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 0,\\n \\"Message\\": 0,\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'StopRecordStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], + 'schema' => ['description' => 'Stream ID.', 'type' => 'string', 'required' => false, 'example' => '323*****997-cn-qingdao', 'title' => ''], ], [ - 'name' => 'PresetId', + 'name' => 'PlayDomain', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['description' => 'Playback domain name of the stream.', 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''], + ], + [ + 'name' => 'App', + 'in' => 'query', + 'schema' => ['description' => 'App name of the stream.', 'type' => 'string', 'required' => false, 'example' => 'live', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'Stream name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -18138,119 +18478,133 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '30295DF1-1DC7-48BA-BE5A-D58E61EB2375', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"30295DF1-1DC7-48BA-BE5A-D58E61EB2375\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GotoPreset', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeletePreset' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Stop On-Demand Recording', + 'summary' => 'Stops on-demand recording for a specified stream.', + 'description' => '> You can specify a stream by ID or by PlayDomain/App/Name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopRecordStream'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopRecordStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopRenderingSession' => [ + 'summary' => 'Shut down the specified cloud application service session and revoke the associated instance resources.', + 'description' => '## Request information', + 'path' => '/', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], + 'schema' => ['description' => 'Project ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], ], [ - 'name' => 'PresetId', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2', - ], + 'schema' => ['description' => 'Session ID. Specify either SessionId or ClientId.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'session-i205217481741918129226'], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => 'Unique ID of the end customer. Specify either SessionId or ClientId.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '04c30850-1d91-4da1-b811-66d0ee94af7d'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F18FD685-B194-4489-9609-F80A9490A258', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"F18FD685-B194-4489-9609-F80A9490A258\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeletePreset', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribePresets' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Shutdown Session', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopRenderingSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], + 'schema' => ['description' => 'The ID of the stream.', 'type' => 'string', 'required' => true, 'example' => '32388487****92997-cn-qingdao', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the stream.', 'type' => 'string', 'required' => false, 'example' => '31000000*****0000002', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The time to restart the stream.', 'type' => 'string', 'required' => false, 'example' => '2021-12-12T10:00:00Z', 'title' => ''], ], ], 'responses' => [ @@ -18258,103 +18612,114 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9FE0CA83-BFD3-4EBD-A429-FABB9B9AE772', - ], - 'Presets' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2', - ], - ], - ], - ], + 'Id' => ['description' => 'The ID of the stream.', 'type' => 'string', 'example' => '32388487****92997-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'The request ID of this operation.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"9FE0CA83-BFD3-4EBD-A429-FABB9B9AE772\\",\\n \\"Presets\\": [\\n {\\n \\"Name\\": \\"预置位2\\",\\n \\"Id\\": \\"2\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribePresets', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"32388487****92997-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Stop a stream', + 'summary' => 'Stops a stream.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'StopMove' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopStream'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopTransferStream' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], + 'schema' => ['description' => 'The stream ID.', 'type' => 'string', 'required' => true, 'example' => '323434****83423432', 'title' => ''], ], [ - 'name' => 'Pan', + 'name' => 'Transcode', 'in' => 'query', + 'schema' => ['description' => 'The name of the transcoding rule. You must bind a transcoding template first.', 'type' => 'string', 'required' => false, 'example' => 'sd', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID of this task.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + ], 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Tilt', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Stop Transfer Stream', + 'summary' => 'Stops a stream.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopTransferStream'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopTransferStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'SyncCatalogs' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Zoom', + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '3238****739092996-cn-shenzhen', 'title' => ''], ], ], 'responses' => [ @@ -18362,73 +18727,58 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'Id' => ['description' => 'Device ID.', 'type' => 'string', 'example' => '3238****739092996-cn-shenzhen', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'StopAdjust' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"3238****739092996-cn-shenzhen\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Synchronize Platform Channel', + 'summary' => 'Synchronizes platform channel information.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncCatalogs'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:SyncCatalogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UnbindDirectory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], - ], - [ - 'name' => 'Iris', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Folder ID.', 'type' => 'string', 'required' => true, 'example' => '3998**************9488-cn-qingdao', 'title' => ''], ], [ - 'name' => 'Focus', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Device ID.', 'type' => 'string', 'required' => true, 'example' => '34871************3380-cn-qingdao', 'title' => ''], ], ], 'responses' => [ @@ -18436,36 +18786,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'StopAdjust', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Detach a device from a folder', + 'summary' => 'Detach a device from a folder.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ContinuousMove' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindDirectory'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:UnbindDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UnbindParentPlatformDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18474,44 +18830,14 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], - ], - [ - 'name' => 'Pan', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0.5', - ], - ], - [ - 'name' => 'Tilt', + 'name' => 'ParentPlatformId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0.5', - ], + 'schema' => ['description' => 'The ID of the parent platform.', 'type' => 'string', 'required' => true, 'example' => '361*****212-cn-qingdao', 'title' => ''], ], [ - 'name' => 'Zoom', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0.5', - ], + 'schema' => ['description' => 'The ID of the device.', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', 'title' => ''], ], ], 'responses' => [ @@ -18519,36 +18845,41 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ContinuousMove', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ContinuousAdjust' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Dissociate a device from a parent platform', + 'summary' => 'Dissociates a device from a parent platform push configuration so that the device is no longer pushed.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindParentPlatformDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:UnbindParentPlatformDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UnbindPurchasedDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18557,34 +18888,9 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', - ], - ], - [ - 'name' => 'Iris', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0.5', - ], - ], - [ - 'name' => 'Focus', + 'name' => 'DeviceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0.5', - ], + 'schema' => ['description' => 'The ID of the device.', 'type' => 'string', 'required' => true, 'example' => '3939*****6580539-cn-qingdao', 'title' => ''], ], ], 'responses' => [ @@ -18592,83 +18898,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"348*****380-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ContinuousAdjust', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateDirectory' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Detach a purchased device', + 'summary' => 'Unbinds a purchased device from a space.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindPurchasedDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:UnbindPurchasedDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UnbindTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The ID of the template.', 'type' => 'string', 'required' => false, 'example' => '323*****998-cn-qingdao', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'TemplateType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The type of the template. Valid values:'."\n" + ."\n" + .'- record'."\n" + ."\n" + .'- snapshot', + 'enumValueTitles' => ['record' => 'record', 'snapshot' => 'snapshot'], 'type' => 'string', 'required' => false, - 'example' => '', + 'example' => 'record', + 'title' => '', ], ], [ - 'name' => 'GroupId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****174-cn-qingdao', - ], + 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => '323*****994-cn-qingdao', 'title' => ''], ], [ - 'name' => 'ParentId', + 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The type of the instance. Valid values:'."\n" + ."\n" + .'- group'."\n" + ."\n" + .'- stream', + 'enumValueTitles' => ['stream' => 'stream', 'group' => 'group'], 'type' => 'string', 'required' => true, - 'example' => '399*****774-cn-qingdao', + 'example' => 'group', + 'title' => '', ], ], ], @@ -18677,714 +18988,848 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****488-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'TemplateType' => ['description' => 'The type of the template.', 'type' => 'string', 'example' => 'record', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => '323*****994-cn-qingdao', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], + 'InstanceType' => ['description' => 'The type of the instance.', 'type' => 'string', 'example' => 'group', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the template.', 'type' => 'string', 'example' => '323*****998-cn-qingdao', 'title' => ''], ], - ], - ], - ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"399*****488-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreateDirectory', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteDirectory' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****174-cn-qingdao', + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TemplateType\\": \\"record\\",\\n \\"InstanceId\\": \\"323*****994-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"InstanceType\\": \\"group\\",\\n \\"TemplateId\\": \\"323*****998-cn-qingdao\\"\\n}","type":"json"}]', + 'title' => 'Detach a template from a specified instance ', + 'summary' => 'Unbind a template from a specified instance, such as a group instance or a stream.', + 'description' => '> Specify at least one of TemplateId or TemplateType.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindTemplate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:UnbindTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteDirectory', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ModifyDirectory' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UninstallCloudApp' => [ + 'summary' => 'You can uninstall a specified cloud application from a specified cloud application instance. This operation is asynchronous. You can use the ListCloudAppInstallations operation to check the uninstallation progress. After successful uninstallation, the query operation no longer returns related information.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207920', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '399*****488-cn-qingdao', - ], + 'schema' => ['description' => 'Cloud application instance ID', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'Name', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Cloud application ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], ], [ - 'name' => 'Description', + 'name' => 'RenderingInstanceIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'maxItems' => 100, + 'description' => 'List of cloud application instance IDs', + 'title' => 'List of cloud application service instance IDs ', + 'type' => 'array', + 'items' => ['title' => 'Cloud application service instance ID ', 'description' => 'Cloud application instance ID', 'type' => 'string', 'required' => false, 'example' => 'render-4523e7b93ca246febd10cd12347d70c0'], 'required' => false, 'example' => '', ], ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['title' => 'Project ID ', 'description' => 'Project ID', 'type' => 'string', 'required' => false, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => 'Maximum number of selected instances under the project. This parameter is valid only when ProjectId is not empty. It limits the maximum number of instances on which the action can be executed within the project to control the impact scope. Default value: 100. Valid values: 1 to 100. ', 'description' => 'Maximum number of instances selected in the project. This parameter applies only when ProjectId is not empty. It limits the maximum number of instances affected by this operation to control impact scope. Default value: 100. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '100', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => 'The page number for paged query of instance association relationships under a project (paged queries are sorted in descending order by instance association time by default). This parameter is valid only when ProjectId is not empty. It limits the maximum number of instances on which an action can be executed within the project to control the impact scope of the action. Default value: 1. '."\n" + .'1. Regarding the valid range of PageNumber: '."\n" + .' a. 【Recommended】Method 1: Calculate the upper limit based on the total number of instances associated with the project (which can be obtained via the ListRenderingProjectInstances API). '."\n" + .' b. Method 2: Determine whether PageNumber has reached the project\'s upper limit by checking the API return value. 【Advantage: No need to calculate the valid range.】 PageNumber is considered to have reached the upper limit if either of the following conditions is met: '."\n" + .' i. The API returns a 403 error with error code Code 200301. '."\n" + .' ii. The sum of SuccessInstanceCount and FailedInstanceCount in the API response is less than PageSize. '."\n" + .'2. Example scenario: '."\n" + .' a. Full uninstallation of all instances under a project: When the number of project instances exceeds PageSize (default: 100), you can repeatedly invoke the uninstall API, incrementing PageNumber by 1 each time, to achieve full uninstallation. You can obtain the uninstallation progress of project instances by calling the ListCloudAppInstallations API. ', 'description' => 'Page number for paged queries of instance associations in the project. Results are sorted by association time in descending order. This parameter applies only when ProjectId is not empty. It limits the maximum number of instances affected by this operation to control impact scope. Default value: 1.'."\n" + ."\n" + .'1. Valid PageNumber range:'."\n" + .' a. Recommended method: Calculate the upper limit based on the total number of instances associated with the project. You can get this count using the ListRenderingProjectInstances API.'."\n" + .' b. Alternative method: Check the API response to determine whether PageNumber has reached the upper limit. This avoids manual calculation. PageNumber has reached the upper limit if either of the following occurs:'."\n" + .' ⅰ. The API returns HTTP status 403 and error code 200301.'."\n" + .' ⅱ. The sum of SuccessInstanceCount and FailedInstanceCount in the response is less than PageSize.'."\n" + ."\n" + .'2. Example scenario:'."\n" + .' a. Full uninstall across all project instances: If the project has more instances than PageSize (default 100), call UninstallCloudApp multiple times, incrementing PageNumber by 1 each time. Track uninstall progress using the ListCloudAppInstallations API.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PatchId', + 'in' => 'query', + 'schema' => ['title' => 'The ID of the patch package to uninstall. Supported only in Windows scenarios. '."\n" + .'1. By default, StablePatchId is uninstalled. '."\n" + .'2. Specify "origin" to uninstall the original version. '."\n" + .'3. Specify "all" to uninstall all installed versions. ', 'description' => 'ID of the patch package to uninstall. Supported only on Windows.'."\n" + ."\n" + .'1. Default: uninstall the StablePatchId.'."\n" + ."\n" + .'2. Set to origin to uninstall the original version.'."\n" + ."\n" + .'3. Set to all to uninstall all installed versions.', 'type' => 'string', 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****488-cn-qingdao', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'SuccessInstanceCount' => ['title' => 'Number of succeeded cloud application service instances ', 'description' => 'Number of successfully uninstalled cloud application instances', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'SuccessInstances' => [ + 'description' => 'A list of service instances for which the cloud application was uninstalled successfully.', + 'title' => 'List of successful cloud application service instances ', + 'type' => 'array', + 'items' => [ + 'description' => 'Cloud application instance', + 'title' => 'Cloud application service instance ', + 'type' => 'object', + 'properties' => [ + 'RenderingInstanceId' => ['title' => 'Cloud application service instance ID ', 'description' => 'Cloud application instance ID', 'type' => 'string', 'example' => 'render-e6cf423c787e4e43b460a788da254fe3'], + ], + 'example' => '', + ], + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', + 'FailedInstanceCount' => ['title' => 'Number of failed cloud application service instances ', 'description' => 'The number of cloud application service instances that failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'FailedInstances' => [ + 'description' => 'List of failed cloud application service instances', + 'title' => 'List of failed cloud application service instances ', + 'type' => 'array', + 'items' => [ + 'description' => 'Failed cloud application instance', + 'title' => 'Failed cloud application service instance ', + 'type' => 'object', + 'properties' => [ + 'RenderingInstanceId' => ['title' => 'Cloud application service instance ID ', 'description' => 'Cloud application instance ID', 'type' => 'string', 'example' => 'render-b45f28650ffe4591bf4c5c95996a428c'], + 'ErrMessage' => ['title' => 'Failure reason message ', 'description' => 'Error message', 'type' => 'string', 'example' => 'Rejected due to timeout'], + 'ErrCode' => ['description' => 'Error code', 'type' => 'integer', 'format' => 'int32', 'example' => '300000', 'title' => ''], + ], + 'example' => '', + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"399*****488-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ModifyDirectory', - ], - 'DescribeDirectory' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SuccessInstanceCount\\": 5,\\n \\"SuccessInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-e6cf423c787e4e43b460a788da254fe3\\"\\n }\\n ],\\n \\"FailedInstanceCount\\": 0,\\n \\"FailedInstances\\": [\\n {\\n \\"RenderingInstanceId\\": \\"render-b45f28650ffe4591bf4c5c95996a428c\\",\\n \\"ErrMessage\\": \\"Rejected due to timeout\\",\\n \\"ErrCode\\": 300000\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Uninstall application ', + 'changeSet' => [ + ['createdAt' => '2025-08-21T12:22:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallCloudApp'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:UninstallCloudApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], ], + ], + 'UnlockDevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '399*****488-cn-qingdao', - ], + 'schema' => ['description' => 'Device ID', 'type' => 'string', 'required' => true, 'example' => '323884****9092996', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', - 'properties' => [ - 'ParentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****774-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****174-cn-qingdao', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-10T10:00:00Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****488-cn-qingdao', - ], + 'properties' => [ + 'Id' => ['description' => 'Device ID', 'type' => 'string', 'example' => '323884****9092996', 'title' => ''], + 'RequestId' => ['description' => 'Request ID for this operation.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ParentId\\": \\"399*****774-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Description\\": \\"目录1\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"Name\\": \\"目录1\\",\\n \\"CreatedTime\\": \\"2021-09-10T10:00:00Z\\",\\n \\"Id\\": \\"399*****488-cn-qingdao\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeDirectory', - ], - 'DescribeDirectories' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"323884****9092996\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Unlock the device', + 'summary' => 'Unlock a device.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockDevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:UnlockDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateCloudAppInfo' => [ + 'summary' => 'Updates information for a cloud application, such as its description and tags. You can upload patch or hotfix packages and create hotfix packages for the Android cloud application marketplace. A cloud application supports up to 20 patch packages, but only one package can be in the uploading state at a time.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207912', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'GroupId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****174-cn-qingdao', - ], + 'schema' => ['description' => 'The ID of the cloud application, which corresponds to a unique application package.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], ], [ - 'name' => 'ParentId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '399*****774-cn-qingdao', - ], + 'schema' => ['description' => 'The description of the application.', 'type' => 'string', 'required' => false, 'maxLength' => 255, 'title' => '', 'example' => '用于测试使用'], ], [ - 'name' => 'SortBy', + 'name' => 'StablePatchId', 'in' => 'query', + 'schema' => ['title' => 'Stable PatchId. This is the default PatchId used when customers\' services are in use (such as during session startup) and no PatchId is specified. Supported only in Windows scenarios. '."\n" + .'Special value instructions: '."\n" + .'1. Input value "origin": cancels the patch version and defaults to the initial version.', 'description' => 'The ID of the stable patch. This patch is used by default if you do not specify a PatchId when the application is in use, such as during a session startup. This parameter is not supported when PkgType is android.'."\n" + .'Special value:'."\n" + ."\n" + .'1. If you set this parameter to origin, the patch version is removed and the initial version is used.', 'type' => 'string', 'required' => false, 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4'], + ], + [ + 'name' => 'Patch', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Information about the patch package to upload.'."\n" + ."\n" + .'1. This parameter is not supported when PkgType is android.'."\n" + ."\n" + .'2. For the same AppId, only one patch can be in the process of uploading at a time. This means only one patch can be in a state other than its desired state.', + 'title' => 'Information of the patch package to upload. Supported only in Windows scenarios.', + 'type' => 'object', + 'properties' => [ + 'PatchName' => ['title' => 'Patch package name or description, which serves as one of the unique identifiers under the AppId. Supported only in Windows scenarios. '."\n" + .'Default naming rules: '."\n" + .'1. Cannot be equal to "origin" or "all" '."\n" + .'2. Length must be between 1 and 50 characters '."\n" + .'3. Allowed characters: lowercase letters, digits, underscores (\'_\'), hyphens (\'-\'), and dots (\'.\') for segmentation '."\n" + .'4. The first and last characters must be a letter or digit', 'description' => 'The name or description of the patch package. This is a unique identifier under the AppId.'."\n" + .'Default naming conventions:'."\n" + ."\n" + .'1. Cannot be origin or all.'."\n" + ."\n" + .'2. Must be 1 to 50 characters in length.'."\n" + ."\n" + .'3. Can contain lowercase letters, digits, underscores (\\_), hyphens (-), and periods (.).'."\n" + ."\n" + .'4. The first and last characters must be a letter or a digit.', 'type' => 'string', 'required' => false, 'example' => 'p1', 'maxLength' => 50, 'minLength' => 1], + 'DownloadURL' => ['title' => 'Download URL of the patch package. '."\n" + .'The default patch package format is consistent with the format of the original cloud application package.', 'description' => 'The download URL for the patch package.'."\n" + .'You must specify either RenderingInstanceId or DownloadURL.'."\n" + .'DownloadURL takes precedence.', 'type' => 'string', 'required' => false, 'example' => 'https://test_host/app/test-tar-pkg.tar'], + 'Md5' => ['title' => 'The MD5 hash of the patch package, used to verify Integrity', 'description' => 'The MD5 hash of the patch package, used to verify integrity. This parameter is valid only if DownloadURL is not empty. It is required if DownloadURL is not empty.', 'type' => 'string', 'required' => false, 'example' => '346f6404395adfg5bae1e45g4e943bf7'], + 'PkgFormat' => [ + 'title' => 'Package format. By default, it is the file extension of the download URL. This parameter is valid only when DownloadURL is not empty. Valid values:'."\n" + .'1. tar.gz'."\n" + .'2. tar'."\n" + .'3. zip'."\n" + .'4. rar', + 'description' => 'The format of the installation package. By default, the system uses the file extension from the download URL. This parameter is valid only if DownloadURL is not empty. Valid values:'."\n" + ."\n" + .'1. tar.gz'."\n" + ."\n" + .'2. tar'."\n" + ."\n" + .'3. zip'."\n" + ."\n" + .'4. rar', + 'type' => 'string', + 'example' => 'tar', + 'enum' => ['tar', 'tar.gz', 'zip', 'rar'], + 'required' => false, + ], + 'RenderingInstanceId' => ['title' => 'Instance ID on which the patch package depends. Valid only for Android application marketplace scenarios (PkgType=andrpid_appmarket). Either RenderingInstanceId or DownloadURL must be specified, and DownloadURL takes precedence.', 'description' => 'The instance ID required to create the patch package. This parameter is valid only in the Android application marketplace scenario (PkgType=andrpid\\_appmarket). Specify either RenderingInstanceId or DownloadURL. DownloadURL takes precedence.', 'type' => 'string', 'required' => false, 'example' => 'render-d7ec79fe47ce47aca2d8d7500d25a28a'], + 'AsStablePatch' => ['title' => 'Specifies whether to automatically configure the uploaded patch as a stable patch. Default value: false.', 'description' => 'Specifies whether to automatically set the patch as the stable version after it is successfully uploaded. The default value is false.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false'], + ], 'required' => false, - 'example' => 'ID', + 'example' => '', ], ], [ - 'name' => 'SortDirection', + 'name' => 'PkgLabels', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The tags for the cloud application. You can select multiple tags. This action resets all existing tags for the cloud application.'."\n" + ."\n" + .'1. Valid values:'."\n" + .' hot, game, and app.'."\n" + ."\n" + .'2. Special case:'."\n" + .' To delete all tags, enter \\["NULL"].', + 'title' => 'Cloud application labels, multiple selection allowed. This will reset the cloud application labels. '."\n" + .'1. Valid values: '."\n" + .' a. hot '."\n" + .' b. game '."\n" + .' c. app '."\n" + .'2. Special cases: '."\n" + .' a. To delete all labels, input ["NULL"] ', + 'type' => 'array', + 'items' => ['title' => 'Cloud application label ', 'description' => 'A tag for the cloud application.', 'type' => 'string', 'required' => false, 'example' => 'app'], 'required' => false, - 'example' => 'asc', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'PatchId' => ['title' => 'Patch package ID', 'description' => 'The ID of the patch package.', 'type' => 'string', 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"PatchId\\": \\"patch-03fa76e8e13a49b6a966b063d9d309b4\\"\\n}","type":"json"}]', + 'title' => 'Update Basic Application Information', + 'changeSet' => [ + ['createdAt' => '2025-08-21T12:22:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCloudAppInfo'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:UpdateCloudAppInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateFileInfo' => [ + 'summary' => 'Update basic information for a file, such as its description.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '215941', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], + 'parameters' => [ [ - 'name' => 'NoPagination', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the file. Each file has a unique ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'f-16713accddtgtj6340jgnclhwsg1813f718db2f7'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The file description.', 'type' => 'string', 'required' => true, 'maxLength' => 255, 'title' => '', 'example' => '测试使用'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Directories' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ParentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****774-cn-qingdao', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****174-cn-qingdao', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-10T10:00:00Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****488-cn-qingdao', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 1,\\n \\"PageCount\\": 1,\\n \\"Directories\\": [\\n {\\n \\"ParentId\\": \\"399*****774-cn-qingdao\\",\\n \\"Description\\": \\"目录2\\",\\n \\"GroupId\\": \\"348*****174-cn-qingdao\\",\\n \\"Name\\": \\"目录2\\",\\n \\"CreatedTime\\": \\"2021-09-10T10:00:00Z\\",\\n \\"Id\\": \\"399*****488-cn-qingdao\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeDirectories', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BindDirectory' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Update Basic File Information ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFileInfo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:UpdateFileInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateRenderingInstanceConfiguration' => [ + 'summary' => 'This operation updates the configuration parameters of a cloud application service instance. It lets you modify various configurations of the Cloud Android system, such as prop, location, and network, to create a real device simulation.'."\n" + .'You can retrieve the configured values for the real device simulation by calling the DescribeRenderingInstance API.'."\n" + .'To query the configuration parameters of the real-time environment, see the DescribeRenderingInstanceConfiguration API.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '213807', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], + ], 'parameters' => [ [ - 'name' => 'DirectoryId', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '399*****488-cn-qingdao', - ], + 'schema' => ['description' => 'The ID of the cloud application service instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111'], ], [ - 'name' => 'DeviceId', - 'in' => 'query', + 'name' => 'Configuration', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The configuration content.', + 'type' => 'array', + 'items' => [ + 'description' => 'The properties of the real device simulation module.', + 'type' => 'object', + 'properties' => [ + 'ModuleName' => ['description' => 'The name of the real device simulation module. Valid values include the following:'."\n" + ."\n" + .'1. ctl: control module'."\n" + ."\n" + .'2. prop: property module'."\n" + ."\n" + .'3. location: location module'."\n" + ."\n" + .'4. battery: battery module'."\n" + ."\n" + .'5. network: network module'."\n" + ."\n" + .'6. bluetooth: bluetooth module'."\n" + ."\n" + .'7. sim: SIM card module'."\n" + ."\n" + .'8. display: device module'."\n" + ."\n" + .'9. system: basic module', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'location'], + 'Attributes' => [ + 'title' => '', + 'description' => 'The list of properties for the module.', + 'type' => 'array', + 'items' => [ + 'description' => 'The property information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the property.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'lon'], + 'Value' => ['description' => 'The value of the property.', 'type' => 'any', 'required' => true, 'title' => '', 'example' => '100'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'deprecated' => false, 'required' => true, - 'example' => '348*****380-cn-qingdao', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3CB843A9-DD34-4881-B8D6-B0D539D111E4', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3CB843A9-DD34-4881-B8D6-B0D539D111E4\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BindDirectory', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UnbindDirectory' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Update Configuration Parameters of a Cloud Application Service Instance '."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRenderingInstanceConfiguration'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:UpdateRenderingInstanceConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], + ], ], + ], + 'UpdateRenderingInstanceSettings' => [ + 'summary' => 'Updates the settings of a cloud application service instance.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvs4YZ3LQ'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], 'parameters' => [ [ - 'name' => 'DirectoryId', + 'name' => 'RenderingInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '3998**************9488-cn-qingdao', - ], + 'schema' => ['description' => 'ID of the cloud application service instance.', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', 'title' => ''], ], [ - 'name' => 'DeviceId', + 'name' => 'Settings', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '34871************3380-cn-qingdao', + 'description' => 'List of instance settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'An instance setting.', + 'type' => 'object', + 'properties' => [ + 'AttributeName' => ['description' => 'Name of the instance setting.', 'type' => 'string', 'required' => false, 'example' => 'navbar.hide', 'title' => ''], + 'AttributeValue' => ['description' => 'Value of the instance setting.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', - ], - 'BatchBindDirectories' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Update Cloud Application Service Instance Settings', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRenderingInstanceSettings'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:UpdateRenderingInstanceSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateRenderingProject' => [ + 'summary' => 'Updates a project’s properties.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREvsGPC7NJ'], + ], 'parameters' => [ [ - 'name' => 'DirectoryId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '399*****488-cn-qingdao', - ], + 'schema' => ['description' => 'Project ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b'], ], [ - 'name' => 'DeviceId', + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => ['description' => 'Default naming rules:'."\n" + ."\n" + .'1. Length 1-128'."\n" + ."\n" + .'2. Lowercase letters, numbers, underscores (\\_), hyphens (-), and periods (.).'."\n" + ."\n" + .'3. The first and last characters must be letters or digits. At least one of ProjectName, SessionAttribs, or Description must be specified.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'idata_content'], + ], + [ + 'name' => 'SessionAttribs', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', + 'title' => '', + 'description' => 'Session attributes', + 'type' => 'object', + 'properties' => [ + 'StartMode' => [ + 'description' => 'The mode used to start cloud application services for the session. Valid values:'."\n" + ."\n" + .'1. Async: asynchronous'."\n" + ."\n" + .'2. Sync: synchronization', + 'type' => 'string', + 'required' => false, + 'enum' => ['Async', 'Sync'], + 'title' => '', + 'example' => 'Async', + ], + ], + 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'Project description', 'type' => 'string', 'maxLength' => 255, 'title' => '', 'required' => false, 'example' => '目录1'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'An error occurred while processing your request.', - ], - 'DirectoryId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '399*****488-cn-qingdao', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"An error occurred while processing your request.\\",\\n \\"DirectoryId\\": \\"399*****488-cn-qingdao\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'BatchBindDirectories', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateParentPlatform' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Update project information ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:UpdateRenderingProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateVsPullStreamInfoConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'Protocol', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'gb28181', - 'default' => 'gb28181', - ], + 'schema' => ['description' => 'Your stream pulling domain.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], ], [ - 'name' => 'GbId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '31000*****2170123451', - ], + 'schema' => ['description' => 'The name of the application to which the live stream belongs.', 'type' => 'string', 'required' => true, 'example' => 'xxxApp', 'title' => ''], ], [ - 'name' => 'Ip', + 'name' => 'StreamName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '10.10.10.10', - ], + 'schema' => ['description' => 'The name of the live stream.', 'type' => 'string', 'required' => true, 'example' => 'xxxStream', 'title' => ''], ], [ - 'name' => 'Port', + 'name' => 'SourceUrl', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '5060', - ], + 'schema' => ['description' => 'The origin server of your live stream.'."\n" + ."\n" + .'> Supports multiple values, separated by English semicolons (;).', 'type' => 'string', 'required' => true, 'example' => 'up.xxx.com.cn', 'title' => ''], ], [ - 'name' => 'ClientAuth', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The start time of stream pulling.'."\n" + ."\n" + .'> UTC time format. The interval between StartTime and EndTime must be within 7 days.', 'type' => 'string', 'required' => false, 'example' => '2021-12-10T10:00:00Z', 'title' => ''], ], [ - 'name' => 'ClientUsername', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'user01', - ], + 'schema' => ['description' => 'The end time of stream pulling.'."\n" + ."\n" + .'> UTC time format. The interval between StartTime and EndTime must be within 7 days, and EndTime must be later than the current time.', 'type' => 'string', 'required' => false, 'example' => '2018-12-10T18:00:00Z', 'title' => ''], ], [ - 'name' => 'ClientPassword', + 'name' => 'Always', 'in' => 'query', 'schema' => [ - 'description' => '', 'type' => 'string', 'required' => false, - 'example' => 'admin123', - ], - ], - [ - 'name' => 'AutoStart', - 'in' => 'query', - 'schema' => [ + 'enum' => ['yes', 'no'], 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'title' => '', + 'example' => '', ], ], ], @@ -19393,2990 +19838,3420 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '359*****374-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"359*****374-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 359*****374-cn-qingdao\\n BEA5625F-8FCF-48F4-851B-CA63946DA664\\n","errorExample":""}]', - 'title' => 'CreateParentPlatform', - ], - 'DeleteParentPlatform' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '359*****374-cn-qingdao', - ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Param.Missing.StartTime', 'errorMessage' => 'You must specify StartTime.', 'description' => ''], + ['errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', 'description' => ''], + ['errorCode' => 'Duration.Exceed', 'errorMessage' => 'The duration between StartTime and EndTime is too long.', 'description' => 'The duration between StartTime and EndTime is too long.'], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Update Stream Pulling Configuration', + 'summary' => 'Updates the configuration for stream pulling. You can modify the start and end times of origin server addresses in an existing stream pulling task.', + 'extraInfo' => '## Special Error Codes'."\n" + .'| error code | Description | HTTP status code | semantics |'."\n" + .'|------------|-------------|------------------|-----------|'."\n" + .'| InternalError | The request processing has failed due to some unknown error. | 500 | An unknown error occurred in the backend. |'."\n" + .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | The domain was not found under the current account. |'."\n" + .'| IllegalOperation | Illegal domain operation is not permitted. | 403 | The current operation is not supported, such as using a non-live streaming domain. |'."\n" + .'| InvalidStartTime.Malformed | Specified StartTime is malformed. | 400 | The stream pulling start time format is invalid. |'."\n" + .'| InvalidEndTime.Malformed | Specified EndTime is malformed. | 400 | The stream pulling end time format is invalid. |'."\n" + .'| InvalidEndTime.Mismatch | StartTime is after EndTime. | 400 | The stream pulling start time is later than the end time. |'."\n" + .'| Duration.Exceed | Duration between StartTime and EndTime is too long. | 400 | The query time range is too long. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateVsPullStreamInfoConfig'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:UpdateVsPullStreamInfoConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"\\n BEA5625F-8FCF-48F4-851B-CA63946DA664\\n","errorExample":""}]', - 'title' => 'DeleteParentPlatform', ], - 'ModifyParentPlatform' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UploadCloudApp' => [ + 'summary' => 'Upload or list a cloud application package. This is an asynchronous API. Use the ListCloudApps API to check upload progress.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '207909', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '359*****374-cn-qingdao', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'GbId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '31000*****2170123451', - ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The application name. For Android apps, use the package name, such as com.aaa.bbb.'."\n" + ."\n" + .'Value requirements:'."\n" + ."\n" + .'1. Length: 4–50 characters'."\n" + ."\n" + .'2. Allowed characters: lowercase letters, digits, underscores (\\_), hyphens (-), and dots (.)'."\n" + ."\n" + .'3. The first and last characters must be a letter or digit', 'type' => 'string', 'required' => true, 'maxLength' => 50, 'minLength' => 4, 'title' => '', 'example' => 'com.aaa.bbb'], ], [ - 'name' => 'Ip', + 'name' => 'AppVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10.10.10.10', - ], + 'schema' => ['description' => 'Value requirements:'."\n" + ."\n" + .'1. Length: 1–50 characters'."\n" + ."\n" + .'2. Allowed characters: lowercase letters, digits, underscores (\\_), hyphens (-), and dots (.)'."\n" + ."\n" + .'3. The first and last characters must be a letter or digit', 'type' => 'string', 'required' => true, 'maxLength' => 50, 'minLength' => 1, 'title' => '', 'example' => '1.1.1'], ], [ - 'name' => 'Port', + 'name' => 'DownloadUrl', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5060', - ], + 'schema' => ['description' => 'The download URL of the application package.', 'type' => 'string', 'required' => true, 'example' => 'https://xxx.xxx.xxx.apk', 'title' => ''], ], [ - 'name' => 'ClientAuth', + 'name' => 'Md5', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The MD5 hash of the application package, used to verify package integrity.', 'type' => 'string', 'required' => true, 'example' => '0CFBB7BD10CDD7279642ADAB8FEF3DEE', 'title' => ''], ], [ - 'name' => 'ClientUsername', + 'name' => 'PkgFormat', 'in' => 'query', 'schema' => [ - 'description' => '', + 'title' => 'Package format. By default, it is inferred from the file extension of the download URL. Valid values: '."\n" + .'1. apk '."\n" + .'2. tar.gz '."\n" + .'3. tar '."\n" + .'4. zip '."\n" + .'5. rar '."\n", + 'description' => 'The package format. By default, this is inferred from the file extension in the DownloadUrl. Valid values:'."\n" + ."\n" + .'1. apk'."\n" + ."\n" + .'2. tar.gz'."\n" + ."\n" + .'3. tar'."\n" + ."\n" + .'4. zip'."\n" + ."\n" + .'5. rar', 'type' => 'string', + 'enum' => ['apk', 'tar.gz', 'tar', 'zip', 'rar'], 'required' => false, - 'example' => 'user01', + 'example' => 'apk', ], ], [ - 'name' => 'ClientPassword', + 'name' => 'PkgType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'title' => 'Package type. Valid values: '."\n" + .'1. android '."\n" + .'2. win '."\n" + ."\n" + .'If not specified, the package type is automatically mapped based on PkgFormat (or parsed automatically from the file extension of DownloadUrl). The default mapping between PkgFormat and package type is as follows: '."\n" + .'1. android: apk '."\n" + .'2. win: tar.gz, tar, zip, rar '."\n", + 'description' => 'The package type.'."\n" + ."\n" + .'## Valid values:'."\n" + ."\n" + .'1. android'."\n" + ."\n" + .'2. win'."\n" + ."\n" + .'3. android\\_appmarket: for Android app marketplace scenarios. This scenario enforces real APK PackageName restrictions:'."\n" + .' a. PackageNames must be unique across different AppNames.'."\n" + .' b. The same AppName with different AppVersions can map to different PackageNames.'."\n" + ."\n" + .'## Default behavior:'."\n" + ."\n" + .'If not specified, the system automatically maps the package type based on PkgFormat (or infers PkgFormat from the DownloadUrl file extension). The default mapping is:'."\n" + ."\n" + .'1. android: apk'."\n" + ."\n" + .'2. win: tar.gz, tar, zip, rar'."\n" + ."\n" + .'3. android\\_appmarket: apk', 'type' => 'string', + 'enum' => ['android', 'win', 'android_appmarket'], 'required' => false, - 'example' => 'admin123', + 'example' => 'android', ], ], [ - 'name' => 'AutoStart', + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'A description of the application.', 'type' => 'string', 'maxLength' => 255, 'title' => '', 'required' => false, 'example' => '测试应用包'], + ], + [ + 'name' => 'PkgLabels', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'boolean', + 'description' => 'Cloud application labels. You can select multiple. Valid values:'."\n" + ."\n" + .'1. hot'."\n" + ."\n" + .'2. game'."\n" + ."\n" + .'3. app', + 'title' => 'Cloud application labels, multiple choice. Valid values: '."\n" + .'1. hot '."\n" + .'2. game '."\n" + .'3. app', + 'type' => 'array', + 'items' => [ + 'title' => 'Cloud application label', + 'description' => 'A cloud application label.', + 'type' => 'string', + 'enum' => ['app', 'game', 'hot'], + 'required' => false, + 'example' => 'app', + ], 'required' => false, - 'example' => 'false', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '359*****374-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'AppId' => ['description' => 'The cloud application ID, which uniquely identifies the application package.', 'type' => 'string', 'title' => '', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"359*****374-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 359*****374-cn-qingdao\\n BEA5625F-8FCF-48F4-851B-CA63946DA664\\n","errorExample":""}]', - 'title' => 'ModifyParentPlatform', - ], - 'DescribeParentPlatform' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"AppId\\": \\"cap-b06b26edfhytbn b94a75ae1a79efc90eb\\"\\n}","type":"json"}]', + 'title' => 'Upload Application '."\n", + 'changeSet' => [ + ['createdAt' => '2025-08-21T12:22:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-10T06:10:59.000Z', 'description' => 'Request parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadCloudApp'], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '359*****374-cn-qingdao', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'on', - ], - 'ClientPort' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5160', - ], - 'ClientGbId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '31010*****317542006', - ], - 'Protocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gb28181', - ], - 'Ip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.10.10.10', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5060', - ], - 'ClientPassword' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'admin123', - ], - 'ClientUsername' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'user01', - ], - 'AutoStart' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ClientAuth' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GbId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '31000*****2170123451', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ClientIp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-12-10T21:00:00Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '359*****374-cn-qingdao', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:UploadCloudApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"on\\",\\n \\"ClientPort\\": 5160,\\n \\"ClientGbId\\": \\"31010*****317542006\\",\\n \\"Protocol\\": \\"gb28181\\",\\n \\"Ip\\": \\"10.10.10.10\\",\\n \\"Port\\": 5060,\\n \\"ClientPassword\\": \\"admin123\\",\\n \\"ClientUsername\\": \\"user01\\",\\n \\"AutoStart\\": false,\\n \\"ClientAuth\\": true,\\n \\"GbId\\": \\"31000*****2170123451\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Description\\": \\"级联平台描述\\",\\n \\"ClientIp\\": \\"192.168.0.1\\",\\n \\"Name\\": \\"国标级联平台测试\\",\\n \\"CreatedTime\\": \\"2018-12-10T21:00:00Z\\",\\n \\"Id\\": \\"359*****374-cn-qingdao\\"\\n}","errorExample":""},{"type":"xml","example":"\\n on\\n 5160\\n 31010*****317542006\\n gb28181\\n 10.10.10.10\\n 5060\\n admin123\\n user01\\n false\\n true\\n 31000*****2170123451\\n BEA5625F-8FCF-48F4-851B-CA63946DA664\\n 级联平台描述\\n 192.168.0.1\\n 国标级联平台测试\\n 2018-12-10T21:00:00Z\\n 359*****374-cn-qingdao\\n","errorExample":""}]', - 'title' => 'DescribeParentPlatform', ], - 'DescribeParentPlatforms' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UploadFile' => [ + 'summary' => 'Uploads a file from a public URL to local or cloud storage. This is an asynchronous operation. You can call the ListFiles operation to monitor the upload progress.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'abilityTreeCode' => '215923', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'GbId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '31000*****2170123451', - ], - ], - [ - 'name' => 'Status', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - ], + 'schema' => ['description' => 'A custom file name. The name must be unique and serves as a unique identifier for the file. The name must meet the following requirements:'."\n" + ."\n" + .'1. It must be 8 to 255 characters in length.'."\n" + ."\n" + .'2. It can contain lowercase letters, digits, underscores (\\_), hyphens (-), and periods (.).'."\n" + ."\n" + .'3. The first and last characters must be a letter or a digit.', 'type' => 'string', 'required' => true, 'maxLength' => 255, 'minLength' => 8, 'title' => '', 'example' => 'mytest'], ], [ - 'name' => 'SortBy', + 'name' => 'OriginUrl', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id', - ], + 'schema' => ['description' => 'The download URL of the file.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'https://xxx.xxx.xxx.tar'], ], [ - 'name' => 'SortDirection', + 'name' => 'Md5', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - ], + 'schema' => ['description' => 'The MD5 hash of the file. This is used to verify the integrity of the file.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '150b6083f50dd08159d45a0d5e4b56f9'], ], [ - 'name' => 'PageSize', + 'name' => 'TargetPath', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The destination path on the service instance. This must be an absolute path to a file. You cannot specify only a folder. The parent folder of the destination path is restricted to the following locations:'."\n" + ."\n" + .'1. /data/local'."\n" + ."\n" + .'2. /data/user'."\n" + ."\n" + .'3. /data/data'."\n" + ."\n" + .'4. /data/cache'."\n" + ."\n" + .'5. /data/tmp'."\n" + ."\n" + .'6. /data/storage'."\n" + ."\n" + .'7. /data/media/0', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '/data/tmp/test/xxx.tar'], ], [ - 'name' => 'PageNum', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The description of the file.', 'type' => 'string', 'maxLength' => 255, 'title' => '', 'required' => false, 'example' => '测试使用'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Platforms' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'on', - ], - 'ClientPort' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5160', - ], - 'Protocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'gb28181', - ], - 'ClientGbId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '31010*****317542006', - ], - 'Ip' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.10.10.10', - ], - 'Port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5060', - ], - 'ClientUsername' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'user01', - ], - 'ClientPassword' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'admin123', - ], - 'AutoStart' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ClientAuth' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GbId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '31000*****2170123451', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ClientIp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '192.168.0.1', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'CreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-12-10T21:00:00Z', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '359*****374-cn-qingdao', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], + 'FileId' => ['description' => 'The ID of the file. This ID is unique for each file.', 'type' => 'string', 'title' => '', 'example' => 'f-1671330gr7934d4771813f7141d28db2f7'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 1,\\n \\"PageCount\\": 1,\\n \\"Platforms\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"ClientPort\\": 5160,\\n \\"Protocol\\": \\"gb28181\\",\\n \\"ClientGbId\\": \\"31010*****317542006\\",\\n \\"Ip\\": \\"10.10.10.10\\",\\n \\"Port\\": 5060,\\n \\"ClientUsername\\": \\"user01\\",\\n \\"ClientPassword\\": \\"admin123\\",\\n \\"AutoStart\\": false,\\n \\"ClientAuth\\": true,\\n \\"GbId\\": \\"31000*****2170123451\\",\\n \\"Description\\": \\"国标级联平台描述\\",\\n \\"ClientIp\\": \\"192.168.0.1\\",\\n \\"Name\\": \\"国标级联平台测试\\",\\n \\"CreatedTime\\": \\"2018-12-10T21:00:00Z\\",\\n \\"Id\\": \\"359*****374-cn-qingdao\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 20\\n BEA5625F-8FCF-48F4-851B-CA63946DA664\\n 1\\n 1\\n \\n on\\n 5160\\n gb28181\\n 31010*****317542006\\n 10.10.10.10\\n 5060\\n user01\\n admin123\\n false\\n true\\n 31000*****2170123451\\n 国标级联平台描述\\n 192.168.0.1\\n 国标级联平台测试\\n 2018-12-10T21:00:00Z\\n 359*****374-cn-qingdao\\n \\n","errorExample":""}]', - 'title' => 'DescribeParentPlatforms', - ], - 'DescribeParentPlatformDevices' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"FileId\\": \\"f-1671330gr7934d4771813f7141d28db2f7\\"\\n}","type":"json"}]', + 'title' => 'Upload File ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadFile'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:UploadFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UploadPublicKey' => [ + 'summary' => 'Upload a new public key.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'abilityTreeCode' => '207881', + 'abilityTreeNodes' => ['FEATUREvs8VD2LG'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'KeyName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '359*****374-cn-qingdao', - ], + 'schema' => ['description' => 'Name of the public key. Must be unique.'."\n" + ."\n" + .'1. Length: 8 to 255 characters.'."\n" + ."\n" + .'2. Valid characters: lowercase letters, digits, underscores (\\_), hyphens (-), and periods (.).'."\n" + ."\n" + .'3. First character must be a letter or digit.'."\n" + ."\n" + .'4. Prefix cannot be group-.', 'type' => 'string', 'required' => true, 'maxLength' => 255, 'minLength' => 8, 'title' => '', 'example' => 'mykey-v1.0'], ], [ - 'name' => 'SortBy', + 'name' => 'KeyGroup', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'id', - ], + 'schema' => ['description' => 'Group for the public key. Used for public key management.'."\n" + ."\n" + .'1. Length: 0 to 255 characters.'."\n" + ."\n" + .'2. Valid characters: lowercase letters, digits, underscores (\\_), hyphens (-), and periods (.).'."\n" + ."\n" + .'3. First character must be a letter or digit.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'g-test'], ], [ - 'name' => 'SortDirection', + 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - ], + 'schema' => ['description' => 'Base64-encoded public key content.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'verify_dffeb6610035dcb77b413a59c3*****'], ], [ - 'name' => 'PageSize', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'Description of the public key.', 'type' => 'string', 'maxLength' => 255, 'title' => '', 'required' => false, 'example' => '测试使用'], ], [ - 'name' => 'PageNum', + 'name' => 'KeyType', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Type of the public key. Valid values:'."\n" + ."\n" + .'- **adb**: ADB key.'."\n" + ."\n" + .'- **ssh**: SSH key.', + 'type' => 'string', 'required' => false, - 'example' => '1', + 'default' => 'adb', + 'enum' => ['adb', 'ssh'], + 'example' => 'ssh', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ - 'PageNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Devices' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ParentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3614*****766212-cn-qingdao', - ], - 'GbId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '310101*****7542007', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3484*****8732174-cn-qingdao', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3487*****323380-cn-qingdao', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request.', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"TotalCount\\": 1,\\n \\"PageCount\\": 1,\\n \\"Devices\\": [\\n {\\n \\"ParentId\\": \\"3614*****766212-cn-qingdao\\",\\n \\"GbId\\": \\"310101*****7542007\\",\\n \\"GroupId\\": \\"3484*****8732174-cn-qingdao\\",\\n \\"Name\\": \\"测试设备1\\",\\n \\"Id\\": \\"3487*****323380-cn-qingdao\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 20\\n BEA5625F-8FCF-48F4-851B-CA63946DA664\\n 1\\n 1\\n \\n 3614*****766212-cn-qingdao\\n 310101*****7542007\\n 3484*****8732174-cn-qingdao\\n 测试设备1\\n 3487*****323380-cn-qingdao\\n \\n","errorExample":""}]', - ], - 'StartParentPlatform' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'title' => 'Upload Public Key', + 'changeSet' => [ + ['createdAt' => '2024-09-12T08:34:15.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadPublicKey'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:UploadPublicKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'VerifyVsDomainOwner' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'The domain name of Visual Edge Computing Service.', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', 'title' => ''], + ], + [ + 'name' => 'VerifyType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The verification method. Valid values:'."\n" + ."\n" + .'- **dnsCheck**: DNS verification.'."\n" + .'- **fileCheck**: File verification.', + 'enumValueTitles' => ['fileCheck' => 'File verification.', 'dnsCheck' => 'DNS verification.'], 'type' => 'string', 'required' => true, - 'example' => '359*****374-cn-qingdao', + 'example' => 'dnsCheck', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '359*****374-cn-qingdao', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], + 'Content' => ['description' => '校验内容。'."\n" + ."\n" + .'> '."\n" + .'调用成功不返回该参数，调用失败返回校验内容。', 'type' => 'string', 'example' => 'verify_dffeb6610035dcb77b413a59c32c****'."\n", 'title' => ''], + 'RequestId' => ['title' => '', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664'], ], + 'example' => '', ], ], ], 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"359*****374-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 359*****374-cn-qingdao\\n BEA5625F-8FCF-48F4-851B-CA63946DA664\\n","errorExample":""}]', - 'title' => 'StartParentPlatform', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"verify_dffeb6610035dcb77b413a59c32c****\\\\n\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyVsDomainOwner'], + ], + ], + 'ramActions' => [], + 'summary' => 'VerifyVsDomainOwner', + 'title' => '', ], - 'BindParentPlatformDevice' => [ - 'methods' => [ - 'post', - 'get', + ], + 'endpoints' => [ + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vs.cn-shenzhen.aliyuncs.com', 'endpoint' => 'vs.cn-shenzhen.aliyuncs.com', 'vpc' => 'vs-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vs.cn-qingdao.aliyuncs.com', 'endpoint' => 'vs.cn-qingdao.aliyuncs.com', 'vpc' => 'vs-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vs.cn-beijing.aliyuncs.com', 'endpoint' => 'vs.cn-beijing.aliyuncs.com', 'vpc' => 'vs-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vs.cn-shanghai.aliyuncs.com', 'endpoint' => 'vs.cn-shanghai.aliyuncs.com', 'vpc' => 'vs-vpc.cn-shanghai.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'ConfigAlreadyExists', 'message' => 'The specified configuration already exists.', 'http_code' => 400, 'description' => 'The specified configuration already exists.'], + ['code' => 'Deny.TooMany.Stream', 'message' => 'The operation is denied because the maximum number of streams is exceeded.', 'http_code' => 403, 'description' => ''], + ['code' => 'DomainOwnerVerifyFail', 'message' => 'Owner verification of the root domain failed.', 'http_code' => 400, 'description' => ''], + ['code' => 'Duration.Exceed', 'message' => 'The duration between StartTime and EndTime is too long.', 'http_code' => 400, 'description' => 'The duration between StartTime and EndTime is too long.'], + ['code' => 'Forbidden.General', 'message' => 'You are not authorized to perform the operation.', 'http_code' => 403, 'description' => ''], + ['code' => 'Invalid.DuplicateSubscriberName', 'message' => 'The specified subscriber nickname already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'Invalid.SubscriberIdNotFound', 'message' => 'The specified SubscriberId does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidDuration.ExceedOneDay', 'message' => 'The duration between StartTime and EndTime cannot be longer than one day.', 'http_code' => 400, 'description' => 'The duration between StartTime and EndTime cannot be longer than one day.'], + ['code' => 'InvalidEndTime.Malformed', 'message' => 'The format of the specified EndTime is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidEndTime.Mismatch', 'message' => 'The specified EndTime is earlier than the StartTime.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidInterval.Malformed', 'message' => 'The specified Interval is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRequest.Body', 'message' => 'The specified request body is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRequest.General', 'message' => 'The specified request is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidRequest.Parameters', 'message' => 'The specified request parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidResumeTime.Malformed', 'message' => 'The specified ResumeTime is invalid. Please check the parameter.', 'http_code' => 400, 'description' => 'The specified ResumeTime is invalid. Please check the parameter.'], + ['code' => 'InvalidStartTime.Malformed', 'message' => 'The format of the specified StartTime is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidStartTime.ValueNotSupported', 'message' => 'The specified StartTime is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidTime.ValueNotSupported', 'message' => 'StartTime or EndTime is miss match.', 'http_code' => 400, 'description' => ''], + ['code' => 'Param.Missing.StartTime', 'message' => 'You must specify StartTime.', 'http_code' => 400, 'description' => ''], + ['code' => 'QpsOverLimit', 'message' => 'Qps exceeded the limit for this domainName.', 'http_code' => 400, 'description' => 'Qps exceeded the limit for this domainName.'], + ['code' => 'QuotaExceeded.Blacklist', 'message' => 'The maximum number of blacklist entries is exceeded.', 'http_code' => 400, 'description' => 'The maximum number of blacklist entries is exceeded.'], + ['code' => 'ResourceNotFound.Device', 'message' => 'The specified device does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound.General', 'message' => 'The specified resource does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound.Group', 'message' => 'The specified group does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound.Record', 'message' => 'The specified record does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound.Stream', 'message' => 'The specified stream does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'ResourceNotFound.Template', 'message' => 'The specified template does not exist.', 'http_code' => 404, 'description' => ''], + ['code' => 'ServerError.Database', 'message' => 'A database error occurred while processing your request.', 'http_code' => 500, 'description' => ''], + ['code' => 'ServerError.General', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => ''], + ['code' => 'UserNotExists', 'message' => 'User does not exist, please register user information.', 'http_code' => 400, 'description' => 'User does not exist, please register user information'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateRenderingInstance'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-12-03T03:08:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeRenderingInstance'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2025-11-27T05:36:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListPublicKeys'], + ['description' => 'Response parameters changed', 'api' => 'ManageLogin'], + ['description' => 'Request parameters changed', 'api' => 'UploadPublicKey'], + ], + 'createdAt' => '2024-09-12T08:34:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeVsUserResourcePackage'], + ], + 'createdAt' => '2024-01-24T16:00:13.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopTransferStream'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainBpsData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindPurchasedDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncCatalogs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteParentPlatform'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainPvData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshRenderingInstanceStreaming'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartRenderingSession'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDirectory'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUnbindTemplates'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindTemplate'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteVsStreamsNotifyUrlConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPublicKeys'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDirectories'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFilePushStatuses'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParentPlatforms'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewRenderingInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyRenderingInstanceBandwidth'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsVerifyContent'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFileInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopMove'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeviceURL'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebootRenderingInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRenderingInstanceStreamingInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadPublicKey'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPublishStream'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetVsDomainCertificate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopStream'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUnbindPurchasedDevices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsTopDomainsByFlow'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRenderingInstanceSettings'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyVsDomainOwner'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDirectory'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRenderingInstanceSettings'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ForbidVsStream'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchBindPurchasedDevices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDeviceChannels'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindDirectory'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateParentPlatform'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRenderingInstanceConfiguration'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddVsPullStreamInfoConfig'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteVsDomainConfigs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTemplate'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateVsPullStreamInfoConfig'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVsStreamsOnlineList'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainConfigs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAccountStat'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartStream'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindParentPlatformDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFiles'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRenderingInstanceGateway'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDevicesData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindParentPlatformDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ManageLogin'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainReqTrafficData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadCloudApp'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindPurchasedDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreamVodList'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchSetVsDomainConfigs'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsUserResourcePackage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchBindTemplate'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainRegionData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetRenderingInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchStartDevices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDirectory'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRenderingInstanceCommandsStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchStartStreams'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PushFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreamURL'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUnbindTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRenderingInstanceConfiguration'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRenderingInstanceSettings'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeviceChannels'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDeviceCapture'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsCertificateList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainRecordData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartRecordStream'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVsStreamsNotifyUrlConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartTransferStream'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopPublishStream'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetPreset'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallCloudApp'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ContinuousMove'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartParentPlatform'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRenderingDataPackage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStreamSnapshot'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDeviceAlarm'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchBindParentPlatformDevices'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsCertificateDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDeviceAlarm'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopAdjust'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePresets'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecoverRenderingDataPackage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRenderingInstances'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseRenderingDataPackage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GotoPreset'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindDirectory'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRenderingInstanceGateway'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsUpPeakPublishStreamData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUnbindParentPlatformDevices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRenderingInstanceConfiguration'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchStopStreams'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteVsPullStreamInfoConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStream'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainUvData'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResumeVsStream'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopRecordStream'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedDevices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRenderingInstance'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVsPullStreamInfoConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDirectory'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCloudApp'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchBindTemplates'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePreset'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchUnbindDirectories'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePurchasedDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRecords'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParentPlatformDevices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTemplates'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTemplate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyParentPlatform'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainTrafficData'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainCertificateInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRenderingDataPackages'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ContinuousAdjust'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchDeleteDevices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroups'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainPvUvData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePublicKey'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseRenderingInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallCloudApp'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchBindDirectories'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainReqBpsData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCloudApps'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchStopDevices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRenderingInstanceGateway'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyRenderingInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVsDomainSnapshotData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVodStreamURL'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePublishStreamStatus'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStreams'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCloudAppInstallations'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetVsStreamsNotifyUrlConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeviceGateway'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchForbidVsStream'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendRenderingInstanceCommands'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDevices'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeParentPlatform'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVsStreamsPublishList'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchResumeVsStream'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDevice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCloudAppInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRenderingInstance'], + ], + ], + 'ram' => [ + 'productCode' => 'VideoSurveillanceSystem', + 'productName' => 'Visual Edge Computing Service', + 'ramCodes' => ['vs'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DescribeDevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ParentPlatformId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '361*****212-cn-qingdao', + [ + 'apiName' => 'AddHiveEdgeWorkers', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:AddHiveEdgeWorkers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', + ], + [ + 'apiName' => 'BatchBindTemplates', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchBindTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - ], + [ + 'apiName' => 'BatchUnbindPurchasedDevices', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchUnbindPurchasedDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'BatchBindParentPlatformDevices' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DeleteCloudApp', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteCloudApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeComfyUserDatas', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DescribeComfyUserDatas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ModifyDeviceCapture', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyDeviceCapture', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ParentPlatformId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '361*****212-cn-qingdao', + [ + 'apiName' => 'DescribeTemplate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', + ], + [ + 'apiName' => 'UploadCloudApp', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:UploadCloudApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'some error', - ], - 'ParentPlatformId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '361*****212-cn-qingdao', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeGroups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"ParentPlatformId\\": \\"361*****212-cn-qingdao\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'UnbindParentPlatformDevice' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'BatchStopDevices', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchStopDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'PushFile', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:PushFile', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'BatchDeleteDevices', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchDeleteDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ParentPlatformId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '361*****212-cn-qingdao', + [ + 'apiName' => 'CreateDirectory', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', + ], + [ + 'apiName' => 'BatchDeleteVsDomainConfigs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchDeleteVsDomainConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - ], + [ + 'apiName' => 'DeleteVsPullStreamInfoConfig', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteVsPullStreamInfoConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', - ], - 'BatchUnbindParentPlatformDevices' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteDevice', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ParentPlatformId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '361*****212-cn-qingdao', + [ + 'apiName' => 'StopRecordStream', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopRecordStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '348*****380-cn-qingdao', + ], + [ + 'apiName' => 'ModifyRenderingInstanceBandwidth', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ModifyRenderingInstanceBandwidth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'some error', - ], - 'ParentPlatformId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '361*****212-cn-qingdao', - ], - 'DeviceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '348*****380-cn-qingdao', - ], - ], - ], - ], - ], + [ + 'apiName' => 'ModifyDeviceChannels', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyDeviceChannels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Results\\": [\\n {\\n \\"Error\\": \\"some error\\",\\n \\"ParentPlatformId\\": \\"361*****212-cn-qingdao\\",\\n \\"DeviceId\\": \\"348*****380-cn-qingdao\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'DescribeVsDomainPvData' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateStreamSnapshot', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateStreamSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeVsDomainReqBpsData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainReqBpsData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeComfyUserDataDownloadUrl', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeComfyUserDataDownloadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ + [ + 'apiName' => 'DescribePresets', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribePresets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', + [ + 'apiName' => 'BindTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BindTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-10T17:00:00Z', + ], + [ + 'apiName' => 'DeleteParentPlatform', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteParentPlatform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-15T15:59:59Z', + ], + [ + 'apiName' => 'MoveHiveEdgeWorkers', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:MoveHiveEdgeWorkers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-11-12T15:59:59Z', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-11-22T00:00:00Z', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'DataInterval' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3600', - ], - 'PvDataInterval' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'UsageData' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'TimeStamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-11-22T00:00:00Z', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeDeviceGateway', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDeviceGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The format of the specified StartTime is invalid.', + [ + 'apiName' => 'DescribeVsStreamsOnlineList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsStreamsOnlineList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The format of the specified EndTime is invalid.', + ], + ], + [ + 'apiName' => 'DescribeRenderingInstanceSettings', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DescribeRenderingInstanceSettings', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidTime.ValueNotSupported', - 'errorMessage' => 'StartTime or EndTime is miss match.', + ], + ], + [ + 'apiName' => 'DescribeVsCertificateDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsCertificateDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + [ + 'apiName' => 'AddVsPullStreamInfoConfig', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:AddVsPullStreamInfoConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-11-12T15:59:59Z\\",\\n \\"StartTime\\": \\"2021-11-22T00:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"PvDataInterval\\": {\\n \\"UsageData\\": [\\n {\\n \\"Value\\": \\"100\\",\\n \\"TimeStamp\\": \\"2021-11-22T00:00:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeVsDomainUvData' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'StartDevice', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StartDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'RenewRenderingInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:RenewRenderingInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SyncCatalogs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:SyncCatalogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ + [ + 'apiName' => 'DescribePurchasedDevices', + 'description' => '', 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', + 'ramAction' => [ + 'action' => 'vs:DescribePurchasedDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-12T10:00:00Z', + ], + [ + 'apiName' => 'DescribeDeviceURL', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDeviceURL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-11-24T00:00:00Z', + ], + [ + 'apiName' => 'RefreshRenderingInstanceStreaming', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:RefreshRenderingInstanceStreaming', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2015-11-30T00:00:00Z', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2015-11-29T00:00:00Z', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'DataInterval' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3600', - ], - 'UvDataInterval' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'UsageData' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'TimeStamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2015-11-29T15:00:00Z', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'CreateComfyTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateComfyTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The format of the specified StartTime is invalid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The format of the specified EndTime is invalid.', - ], - [ - 'errorCode' => 'InvalidTime.ValueNotSupported', - 'errorMessage' => 'StartTime or EndTime is miss match.', - ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The specified StartTime is invalid.', + [ + 'apiName' => 'ListRenderingProjectInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListRenderingProjectInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2015-11-30T00:00:00Z\\",\\n \\"StartTime\\": \\"2015-11-29T00:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"UvDataInterval\\": {\\n \\"UsageData\\": [\\n {\\n \\"Value\\": \\"100\\",\\n \\"TimeStamp\\": \\"2015-11-29T15:00:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeVsDomainPvUvData' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribePurchasedDevice', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribePurchasedDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateRenderingInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:CreateRenderingInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UnbindDirectory', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:UnbindDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyRenderingChargeType', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyRenderingChargeType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:vs::{#accountId}:crs/{#CrsId}'], + ], ], ], - 'systemTags' => [ + [ + 'apiName' => 'DescribeVsDomainSnapshotData', + 'description' => '', 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainSnapshotData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-14T23:00:00Z', + ], + [ + 'apiName' => 'DeleteHive', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:DeleteHive', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-11-24T00:00:00Z', + ], + [ + 'apiName' => 'ModifyTemplate', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-11-24T00:00:00Z', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-12T10:00:00Z', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'DataInterval' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3600', - ], - 'PvUvDataInfos' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'PvUvDataInfo' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PV' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'TimeStamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-14T23:00:00Z', - ], - 'UV' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'ResetRenderingInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ResetRenderingInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The format of the specified StartTime is invalid.', + [ + 'apiName' => 'DeleteRenderingInstanceGateway', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DeleteRenderingInstanceGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The format of the specified EndTime is invalid.', + ], + ], + [ + 'apiName' => 'ListRenderingInstanceGateway', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ListRenderingInstanceGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidTime.ValueNotSupported', - 'errorMessage' => 'StartTime or EndTime is miss match.', + ], + ], + [ + 'apiName' => 'DeleteVsStreamsNotifyUrlConfig', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteVsStreamsNotifyUrlConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + [ + 'apiName' => 'BatchUnbindTemplates', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchUnbindTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-11-24T00:00:00Z\\",\\n \\"StartTime\\": \\"2021-12-12T10:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"PvUvDataInfos\\": {\\n \\"PvUvDataInfo\\": [\\n {\\n \\"PV\\": \\"100\\",\\n \\"TimeStamp\\": \\"2021-10-14T23:00:00Z\\",\\n \\"UV\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeVsDomainRecordData' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'BatchBindPurchasedDevices', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchBindPurchasedDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'RebootRenderingServer', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:RebootRenderingServer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateVsPullStreamInfoConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:UpdateVsPullStreamInfoConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ + [ + 'apiName' => 'DescribeVsStreamsPublishList', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsStreamsPublishList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example.aliyundoc.com', + [ + 'apiName' => 'GetRenderingInstanceStreamingInfo', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:GetRenderingInstanceStreamingInfo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-09-29T16:00:00Z', + ], + [ + 'apiName' => 'DescribeVsPullStreamInfoConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsPullStreamInfoConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-11-19T15:59:59Z', + ], + [ + 'apiName' => 'UnlockDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:UnlockDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', + ], + [ + 'apiName' => 'StopTransferStream', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopTransferStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'RecordDataPerInterval' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DataModule' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TimeStamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-11-19T15:59:59Z', - ], - 'StreamCountValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'RecordValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'CancelComfyTask', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:CancelComfyTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The format of the specified StartTime is invalid.', + [ + 'apiName' => 'ListFilePushStatuses', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListFilePushStatuses', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The format of the specified EndTime is invalid.', + ], + ], + [ + 'apiName' => 'DelHiveEdgeWorkers', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:DelHiveEdgeWorkers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + ], + ], + [ + 'apiName' => 'DescribeVsCertificateList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsCertificateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + [ + 'apiName' => 'StartRenderingSession', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StartRenderingSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RecordDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2021-11-19T15:59:59Z\\",\\n \\"StreamCountValue\\": \\"1\\",\\n \\"RecordValue\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeVsDomainSnapshotData' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ModifyDeviceAlarm', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyDeviceAlarm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ReleaseRenderingInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ReleaseRenderingInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UploadFile', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:UploadFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ + [ + 'apiName' => 'DescribeRecords', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example.aliyundoc.com', + [ + 'apiName' => 'StopRenderingSession', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopRenderingSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-05T16:00:00Z', + ], + [ + 'apiName' => 'StartStream', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StartStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-18T16:00:00Z', + ], + [ + 'apiName' => 'RecoverRenderingDataPackage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:RecoverRenderingDataPackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'SnapshotDataPerInterval' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DataModule' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SnapshotValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'TimeStamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2015-12-10T20:00:00Z', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'BindDirectory', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BindDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyDirectory', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The format of the specified StartTime is invalid.', + [ + 'apiName' => 'UploadPublicKey', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:UploadPublicKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The format of the specified EndTime is invalid.', + ], + ], + [ + 'apiName' => 'DescribeTemplates', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + ], + ], + [ + 'apiName' => 'GetRenderingInstanceCommandsStatus', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:GetRenderingInstanceCommandsStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#accountId}:crs/{#CrsId}'], ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + [ + 'apiName' => 'BatchUnbindTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchUnbindTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"SnapshotDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"SnapshotValue\\": \\"1\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeVsDomainRegionData' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeRenderingInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeRenderingInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'BatchBindDirectories', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchBindDirectories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeComfyUserDataUploadUrl', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DescribeComfyUserDataUploadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ + [ + 'apiName' => 'CreateRenderingInstanceGateway', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:CreateRenderingInstanceGateway', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeDeviceChannels', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDeviceChannels', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example.aliyundoc.com', + [ + 'apiName' => 'BatchSetVsDomainConfigs', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchSetVsDomainConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-30T16:00:00Z', + ], + [ + 'apiName' => 'UnbindTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:UnbindTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-31T15:59:59Z', + ], + [ + 'apiName' => 'DescribeVsUpPeakPublishStreamData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsUpPeakPublishStreamData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-31T15:59:59Z', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-30T16:00:00Z', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'DataInterval' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3600', - ], - 'Value' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'RegionProportionData' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TotalQuery' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3', - ], - 'TotalBytes' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2400057', - ], - 'AvgResponseRate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '154.3345765545624', - ], - 'AvgResponseTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5183.666666666667', - ], - 'ReqErrRate' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'AvgObjectSize' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2888253.7875', - ], - 'Bps' => [ - 'description' => '', - 'type' => 'string', - 'example' => '380.9614285714286', - ], - 'Qps' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.001746031746031746', - ], - 'RegionEname' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'chongqing', - ], - 'Region' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Proportion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.01155980271270037', - ], - 'BytesProportion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.003544181046236794', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'CreateComfyUserDataDir', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:CreateComfyUserDataDir', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The format of the specified StartTime is invalid.', + [ + 'apiName' => 'BatchBindTemplate', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchBindTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BatchBindParentPlatformDevices', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchBindParentPlatformDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeVsDomainReqTrafficData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainReqTrafficData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The format of the specified EndTime is invalid.', + ], + ], + [ + 'apiName' => 'CreateParentPlatform', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateParentPlatform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + ], + ], + [ + 'apiName' => 'UnbindPurchasedDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:UnbindPurchasedDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + [ + 'apiName' => 'DeleteGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-10-31T15:59:59Z\\",\\n \\"StartTime\\": \\"2021-10-30T16:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"Value\\": {\\n \\"RegionProportionData\\": [\\n {\\n \\"TotalQuery\\": \\"3\\",\\n \\"TotalBytes\\": \\"2400057\\",\\n \\"AvgResponseRate\\": \\"154.3345765545624\\",\\n \\"AvgResponseTime\\": \\"5183.666666666667\\",\\n \\"ReqErrRate\\": \\"0\\",\\n \\"AvgObjectSize\\": \\"2888253.7875\\",\\n \\"Bps\\": \\"380.9614285714286\\",\\n \\"Qps\\": \\"0.001746031746031746\\",\\n \\"RegionEname\\": \\"chongqing\\",\\n \\"Region\\": \\"重庆市\\",\\n \\"Proportion\\": \\"0.01155980271270037\\",\\n \\"BytesProportion\\": \\"0.003544181046236794\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeVsDomainBpsData' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'StopMove', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopMove', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpdateFileInfo', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:UpdateFileInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateCloudAppInfo', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:UpdateCloudAppInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ - 'operationType' => 'get', + [ + 'apiName' => 'BindParentPlatformDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BindParentPlatformDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example.aliyundoc.com', + [ + 'apiName' => 'CreateGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-12-26T16:00:00Z', + ], + [ + 'apiName' => 'StartRecordStream', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StartRecordStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-02T02:30:48Z', + ], + [ + 'apiName' => 'DescribeVsDevicesData', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDevicesData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Interval', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '300', + ], + [ + 'apiName' => 'DescribeDirectory', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IspNameEn', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'unicom', + ], + [ + 'apiName' => 'UnbindParentPlatformDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:UnbindParentPlatformDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'LocationNameEn', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'guangdong', + ], + [ + 'apiName' => 'DeletePreset', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeletePreset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-01T07:10:48Z', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-18T16:00:00Z', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'DataInterval' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2100', - ], - 'BpsDataPerInterval' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DataModule' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BpsValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1000', - ], - 'TimeStamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2015-12-10T20:00:00Z', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'BatchForbidVsStream', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchForbidVsStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeStreamVodList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeStreamVodList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeDirectories', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDirectories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The format of the specified StartTime is invalid.', + [ + 'apiName' => 'DescribeGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The format of the specified EndTime is invalid.', + ], + ], + [ + 'apiName' => 'StartTransferStream', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StartTransferStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + ], + ], + [ + 'apiName' => 'ForbidVsStream', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:ForbidVsStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + [ + 'apiName' => 'DescribeVsDomainUvData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainUvData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-10-01T07:10:48Z\\",\\n \\"StartTime\\": \\"2021-09-18T16:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"2100\\",\\n \\"BpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"BpsValue\\": \\"1000\\",\\n \\"TimeStamp\\": \\"2015-12-10T20:00:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeVsDomainReqBpsData' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ContinuousAdjust', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:ContinuousAdjust', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeComfyProductionDownloadUrl', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeComfyProductionDownloadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeDevice', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ + [ + 'apiName' => 'DescribeVodStreamURL', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVodStreamURL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example.aliyundoc.com', + [ + 'apiName' => 'ListRenderingProjects', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListRenderingProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-01-15T16:00:00Z', + ], + [ + 'apiName' => 'ModifyHiveAttribute', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyHiveAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-16T07:00:46Z', + ], + [ + 'apiName' => 'DescribeAccountStat', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeAccountStat', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Interval', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 300 => '300', - 3600 => '3600', - 86400 => '86400', - ], - 'example' => '300', + ], + [ + 'apiName' => 'DescribeVsDomainBpsData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainBpsData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IspNameEn', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'telecom', + ], + [ + 'apiName' => 'DescribeVsDomainRegionData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainRegionData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'LocationNameEn', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'beijing', + ], + [ + 'apiName' => 'DeleteFile', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DeleteFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-24T03:30:46Z', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-24T16:00:00Z', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'DataInterval' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3600', - ], - 'ReqBpsDataPerInterval' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DataModule' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TimeStamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-24T16:00:00Z', - ], - 'ReqBpsValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1000', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'SetPreset', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:SetPreset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The format of the specified StartTime is invalid.', + [ + 'apiName' => 'UpdateRenderingInstanceSettings', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:UpdateRenderingInstanceSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The format of the specified EndTime is invalid.', + ], + ], + [ + 'apiName' => 'SetVsStreamsNotifyUrlConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:SetVsStreamsNotifyUrlConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + ], + ], + [ + 'apiName' => 'DeleteRenderingProject', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteRenderingProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + [ + 'apiName' => 'RebootRenderingInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:RebootRenderingInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-09-24T03:30:46Z\\",\\n \\"StartTime\\": \\"2021-12-24T16:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"ReqBpsDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2021-12-24T16:00:00Z\\",\\n \\"ReqBpsValue\\": \\"1000\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeVsDomainTrafficData' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeVsStreamsNotifyUrlConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsStreamsNotifyUrlConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UninstallCloudApp', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:UninstallCloudApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteComfyUserData', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DeleteComfyUserData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ - 'operationType' => 'get', + [ + 'apiName' => 'DeleteRenderingInstanceConfiguration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DeleteRenderingInstanceConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example.aliyundoc.com', + [ + 'apiName' => 'BatchResumeVsStream', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchResumeVsStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-08-18T16:00:00Z', + ], + [ + 'apiName' => 'DescribeComfyProductions', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DescribeComfyProductions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-09-21T02:50:42Z', + ], + [ + 'apiName' => 'ListEdgeWorkers', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ListEdgeWorkers', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], ], ], - [ - 'name' => 'Interval', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3600', + ], + [ + 'apiName' => 'UpdateRenderingProject', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:UpdateRenderingProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IspNameEn', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'telecom', + ], + [ + 'apiName' => 'StopDevice', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'LocationNameEn', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'beijing', + ], + [ + 'apiName' => 'CreateDeviceAlarm', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateDeviceAlarm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-20T07:10:42Z', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-10-25T16:00:00Z', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'DataInterval' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3600', - ], - 'TrafficDataPerInterval' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DataModule' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TrafficValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '100', - ], - 'TimeStamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-20T07:10:42Z', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'BatchStopStreams', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchStopStreams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'OpenVsService', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:OpenVsService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRenderingProjectInstanceStateMetrics', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:GetRenderingProjectInstanceStateMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The format of the specified StartTime is invalid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The format of the specified EndTime is invalid.', - ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + [ + 'apiName' => 'ListFiles', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + [ + 'apiName' => 'CreateComfyWorkflow', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateComfyWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-09-20T07:10:42Z\\",\\n \\"StartTime\\": \\"2021-10-25T16:00:00Z\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"TrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TrafficValue\\": \\"100\\",\\n \\"TimeStamp\\": \\"2021-09-20T07:10:42Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeVsDomainReqTrafficData' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeStream', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpdateRenderingInstanceConfiguration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:UpdateRenderingInstanceConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ReleaseRenderingDataPackage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ReleaseRenderingDataPackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ - 'operationType' => 'get', + [ + 'apiName' => 'StopStream', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example.aliyundoc.com', + [ + 'apiName' => 'ResumeVsStream', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:ResumeVsStream', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-09-30T16:00:00Z', + ], + [ + 'apiName' => 'ModifyDevice', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2021-10-13T10:00:41Z', + ], + [ + 'apiName' => 'DescribeStreams', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeStreams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Interval', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3600', + ], + [ + 'apiName' => 'ListRenderingInstances', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ListRenderingInstances', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], ], ], - [ - 'name' => 'IspNameEn', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'unicom', + ], + [ + 'apiName' => 'DescribeParentPlatform', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeParentPlatform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'LocationNameEn', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'shanghai', + ], + [ + 'apiName' => 'DescribeParentPlatformDevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeParentPlatformDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-22T03:40:41Z', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-21T16:00:00Z', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '9BEC5E85-C76B-56EF-A922-860EFDB8B64B', - ], - 'DomainName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.aliyundoc.com', - ], - 'DataInterval' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3600', - ], - 'ReqTrafficDataPerInterval' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DataModule' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ReqTrafficValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10000', - ], - 'TimeStamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-09-22T03:40:41Z', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'ListCloudAppPatches', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListCloudAppPatches', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The format of the specified StartTime is invalid.', + [ + 'apiName' => 'ModifyRenderingInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ModifyRenderingInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The format of the specified EndTime is invalid.', + ], + ], + [ + 'apiName' => 'ModifyComfyWorkflow', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ModifyComfyWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + ], + ], + [ + 'apiName' => 'ListCloudAppInstallations', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListCloudAppInstallations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + [ + 'apiName' => 'DescribeComfyTasks', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DescribeComfyTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EndTime\\": \\"2021-09-22T03:40:41Z\\",\\n \\"StartTime\\": \\"2021-09-21T16:00:00Z\\",\\n \\"RequestId\\": \\"9BEC5E85-C76B-56EF-A922-860EFDB8B64B\\",\\n \\"DomainName\\": \\"example.aliyundoc.com\\",\\n \\"DataInterval\\": \\"3600\\",\\n \\"ReqTrafficDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"ReqTrafficValue\\": \\"10000\\",\\n \\"TimeStamp\\": \\"2021-09-22T03:40:41Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeVsDevicesData' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeVsUserResourcePackage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsUserResourcePackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DisassociateRenderingProjectInstances', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:DisassociateRenderingProjectInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeVsDomainConfigs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainConfigs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '348*****174-cn-qingdao', + [ + 'apiName' => 'DescribeVsDomainTrafficData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainTrafficData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-01-04T16:00:00Z', + ], + [ + 'apiName' => 'SendRenderingInstanceCommands', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:SendRenderingInstanceCommands', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2022-01-30T16:00:00Z', + ], + [ + 'apiName' => 'ManageLogin', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ManageLogin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - 'DevicesDataPerInterval' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DataModule' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TimeStamp' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-01-04T16:00:00Z', - ], - 'DevicesDataValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '128', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeParentPlatforms', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeParentPlatforms', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidStartTime.Malformed', - 'errorMessage' => 'The format of the specified StartTime is invalid.', + [ + 'apiName' => 'DescribeRenderingSession', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeRenderingSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Malformed', - 'errorMessage' => 'The format of the specified EndTime is invalid.', + ], + ], + [ + 'apiName' => 'BatchStartDevices', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchStartDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidEndTime.Mismatch', - 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', + ], + ], + [ + 'apiName' => 'ListPublicKeys', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListPublicKeys', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidStartTime.ValueNotSupported', - 'errorMessage' => 'The specified StartTime is invalid.', + ], + ], + [ + 'apiName' => 'DeleteDirectory', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DevicesDataPerInterval\\": {\\n \\"DataModule\\": [\\n {\\n \\"TimeStamp\\": \\"2022-01-04T16:00:00Z\\",\\n \\"DevicesDataValue\\": \\"128\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - ], - 'DescribeVsUpPeakPublishStreamData' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateRenderingProject', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateRenderingProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ContinuousMove', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:ContinuousMove', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ModifyParentPlatform', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyParentPlatform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ + [ + 'apiName' => 'DescribeStreamURL', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeStreamURL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2017-12-10T20:00:00Z', + [ + 'apiName' => 'DeleteRenderingInstanceSettings', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DeleteRenderingInstanceSettings', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2017-12-10T21:00:00Z', + ], + [ + 'apiName' => 'ModifyGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRenderingSessions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListRenderingSessions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopAdjust', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StopAdjust', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DomainSwitch', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - 'enum' => [ - 'on', - 'off', - ], + ], + [ + 'apiName' => 'DeleteTemplate', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', + ], + [ + 'apiName' => 'ListHives', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ListHives', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '27A3C548-A699-48F9-97CD-F35D81075AF3', - ], - 'DescribeVsUpPeakPublishStreamDatas' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'DescribeVsUpPeakPublishStreamData' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'QueryTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1522166400000', - ], - 'BandWidth' => [ - 'type' => 'string', - ], - 'StatName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'example.com', - ], - 'PeakTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1522252320000', - ], - 'PublishStreamNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '31', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeVsDomainDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"27A3C548-A699-48F9-97CD-F35D81075AF3\\",\\n \\"DescribeVsUpPeakPublishStreamDatas\\": {\\n \\"DescribeVsUpPeakPublishStreamData\\": [\\n {\\n \\"QueryTime\\": \\"1522166400000\\",\\n \\"BandWidth\\": \\"\\",\\n \\"StatName\\": \\"example.com\\",\\n \\"PeakTime\\": \\"1522252320000\\",\\n \\"PublishStreamNum\\": 31\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 27A3C548-A699-48F9-97CD-F35D81075AF3\\n \\n 1522166400000\\n example.com\\n 1522252320000\\n 31\\n \\n","errorExample":""}]', - 'title' => 'DescribeVsUpPeakPublishStreamData', - ], - 'VerifyVsDomainOwner' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListRenderingDataPackages', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ListRenderingDataPackages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'BindPurchasedDevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BindPurchasedDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeVsDomainRecordData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainRecordData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', + [ + 'apiName' => 'DeletePublicKey', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DeletePublicKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'VerifyType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'fileCheck' => '', - 'dnsCheck' => '', - ], - 'example' => 'dnsCheck', + ], + [ + 'apiName' => 'BatchUnbindParentPlatformDevices', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchUnbindParentPlatformDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'verify_dffeb6610035dcb77b413a59c32c****'."\n", - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - ], + [ + 'apiName' => 'StartParentPlatform', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:StartParentPlatform', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Content\\": \\"verify_dffeb6610035dcb77b413a59c32c****\\\\n\\"\\n}","type":"json"}]', - ], - 'DescribeVsVerifyContent' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'SetVsDomainCertificate', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:SetVsDomainCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeRenderingInstanceConfiguration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DescribeRenderingInstanceConfiguration', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'BatchStartStreams', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchStartStreams', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DomainName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'example.aliyundoc.com', + [ + 'apiName' => 'CreateDevice', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateDevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'verify_dffeb6610035dcb77b413a59c3*****', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', - ], - ], + [ + 'apiName' => 'CreateTemplate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:CreateTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Content\\": \\"verify_dffeb6610035dcb77b413a59c3*****\\"\\n}","type":"json"}]', - ], - 'StartPublishStream' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ModifyRenderingInstanceAttribute', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:ModifyRenderingInstanceAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'BatchUnbindDirectories', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:BatchUnbindDirectories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateHive', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:CreateHive', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, + [ + 'apiName' => 'DeleteComfyWorkflow', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vs:DeleteComfyWorkflow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PublishUrl', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, + ], + [ + 'apiName' => 'CreateRenderingDataPackage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:CreateRenderingDataPackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Message' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + [ + 'apiName' => 'AssociateRenderingProjectInstances', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:AssociateRenderingProjectInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [], - ], - 'DescribePublishStreamStatus' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListSpecifications', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:ListSpecifications', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListCloudApps', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vs:ListCloudApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeVsTopDomainsByFlow', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsTopDomainsByFlow', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, + [ + 'apiName' => 'DeleteComfyProduction', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vs:DeleteComfyProduction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Message' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + [ + 'apiName' => 'DescribeVsDomainPvUvData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainPvUvData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [], - 'responseDemo' => null, - ], - 'StopPublishStream' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeVsDomainCertificateInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainCertificateInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeVsDomainPvData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vs:DescribeVsDomainPvData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeComfyWorkflows', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'vs:DescribeComfyWorkflows', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, + [ + 'apiName' => 'GotoPreset', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'vs:GotoPreset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Message' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + [ + 'apiName' => 'InstallCloudApp', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vs:InstallCloudApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VideoSurveillanceSystem', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], ], ], ], - 'errorCodes' => [], - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'vs.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'vs.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'vs.cn-shanghai.aliyuncs.com', ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'vs.cn-shenzhen.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Crs', 'arn' => 'acs:videosurveillancesystem::{#AccountId}:crs/{#CrsId}'], + ['validationType' => 'always', 'resourceType' => 'Crs', 'arn' => 'acs:vs::{#accountId}:crs/{#CrsId}'], + ['validationType' => 'always', 'resourceType' => 'Crs', 'arn' => 'acs:vs::{#accountId}:crs/*'], ], ], ]; -- cgit v1.2.3