'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'vs', 'version' => '2018-12-12', ], 'directories' => [ [ 'id' => 390443, 'title' => '云应用服务管理', 'type' => 'directory', 'children' => [ [ 'id' => 390444, 'title' => '实例管理', 'type' => 'directory', 'children' => [ 'ModifyRenderingChargeType', 'CreateRenderingInstance', 'ListRenderingInstances', 'ModifyRenderingInstanceAttribute', 'DescribeRenderingInstance', 'GetRenderingInstanceStreamingInfo', 'RefreshRenderingInstanceStreaming', 'SendRenderingInstanceCommands', 'GetRenderingInstanceCommandsStatus', 'ModifyRenderingInstance', 'RebootRenderingInstance', 'RebootRenderingServer', 'ResetRenderingInstance', 'ModifyRenderingInstanceBandwidth', 'RenewRenderingInstance', 'ReleaseRenderingInstance', ], ], [ 'id' => 390461, 'title' => '数据包管理', 'type' => 'directory', 'children' => [ 'CreateRenderingDataPackage', 'ListRenderingDataPackages', 'RecoverRenderingDataPackage', 'ReleaseRenderingDataPackage', ], ], [ 'id' => 390466, 'title' => '安全登录', 'type' => 'directory', 'children' => [ 'UploadPublicKey', 'ListPublicKeys', 'ManageLogin', 'DeletePublicKey', ], ], [ 'id' => 390471, 'title' => '云应用管理', 'type' => 'directory', 'children' => [ 'UploadCloudApp', 'ListCloudApps', 'UpdateCloudAppInfo', 'ListCloudAppPatches', 'InstallCloudApp', 'ListCloudAppInstallations', 'UninstallCloudApp', 'DeleteCloudApp', ], ], [ 'id' => 390480, 'title' => '系统配置', 'type' => 'directory', 'children' => [ 'DescribeRenderingInstanceConfiguration', 'UpdateRenderingInstanceConfiguration', 'DeleteRenderingInstanceConfiguration', 'DescribeRenderingInstanceSettings', 'UpdateRenderingInstanceSettings', 'DeleteRenderingInstanceSettings', ], ], [ 'id' => 390487, 'title' => '文件管理', 'type' => 'directory', 'children' => [ 'UploadFile', 'ListFiles', 'UpdateFileInfo', 'PushFile', 'ListFilePushStatuses', 'DeleteFile', ], ], [ 'id' => 390494, 'title' => '自定义网关', 'type' => 'directory', 'children' => [ 'CreateRenderingInstanceGateway', 'ListRenderingInstanceGateway', 'DeleteRenderingInstanceGateway', ], ], [ 'id' => 390498, 'title' => '项目管理', 'type' => 'directory', 'children' => [ 'CreateRenderingProject', 'ListRenderingProjects', 'UpdateRenderingProject', 'AssociateRenderingProjectInstances', 'ListRenderingProjectInstances', 'GetRenderingProjectInstanceStateMetrics', 'DisassociateRenderingProjectInstances', 'DeleteRenderingProject', ], ], [ 'id' => 390507, 'title' => '会话管理', 'type' => 'directory', 'children' => [ 'StartRenderingSession', 'ListRenderingSessions', 'DescribeRenderingSession', 'StopRenderingSession', ], ], ], ], [ 'id' => 390512, 'title' => '账户', 'type' => 'directory', 'children' => [ 'DescribeAccountStat', 'DescribeVsUserResourcePackage', 'OpenVsService', ], ], [ 'id' => 390516, 'title' => '空间管理', 'type' => 'directory', 'children' => [ 'CreateGroup', 'DeleteGroup', 'ModifyGroup', 'DescribeGroup', 'DescribeGroups', ], ], [ 'id' => 390522, 'title' => '设备管理', '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', ], ], [ 'id' => 390549, 'title' => '流管理', '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', ], ], [ 'id' => 390575, 'title' => '模板管理', 'type' => 'directory', 'children' => [ 'CreateTemplate', 'DeleteTemplate', 'ModifyTemplate', 'DescribeTemplate', 'DescribeTemplates', 'BindTemplate', 'UnbindTemplate', 'BatchBindTemplate', 'BatchUnbindTemplate', 'BatchBindTemplates', 'BatchUnbindTemplates', ], ], [ 'id' => 390587, 'title' => '录制管理', 'type' => 'directory', 'children' => [ 'StartRecordStream', 'StopRecordStream', 'DescribeRecords', ], ], [ 'id' => 390591, 'title' => '域名管理', 'type' => 'directory', 'children' => [ 'SetVsDomainCertificate', 'DescribeVsCertificateDetail', 'DescribeVsDomainCertificateInfo', 'DescribeVsCertificateList', 'DescribeVsDomainDetail', 'DescribeVsDomainConfigs', 'BatchSetVsDomainConfigs', 'BatchDeleteVsDomainConfigs', 'DescribeVsTopDomainsByFlow', ], ], [ 'id' => 390601, 'title' => 'PTZ管理', 'type' => 'directory', 'children' => [ 'SetPreset', 'GotoPreset', 'DeletePreset', 'DescribePresets', 'StopMove', 'StopAdjust', 'ContinuousMove', 'ContinuousAdjust', ], ], [ 'id' => 390610, 'title' => '目录管理', 'type' => 'directory', 'children' => [ 'CreateDirectory', 'DeleteDirectory', 'ModifyDirectory', 'DescribeDirectory', 'DescribeDirectories', 'BindDirectory', 'UnbindDirectory', 'BatchBindDirectories', ], ], [ 'id' => 390619, 'title' => '级联平台管理', 'type' => 'directory', 'children' => [ 'CreateParentPlatform', 'DeleteParentPlatform', 'ModifyParentPlatform', 'DescribeParentPlatform', 'DescribeParentPlatforms', 'DescribeParentPlatformDevices', 'StartParentPlatform', 'BindParentPlatformDevice', 'BatchBindParentPlatformDevices', 'UnbindParentPlatformDevice', 'BatchUnbindParentPlatformDevices', ], ], [ 'id' => 390631, 'title' => '用量查询', 'type' => 'directory', 'children' => [ 'DescribeVsDomainPvData', 'DescribeVsDomainUvData', 'DescribeVsDomainPvUvData', 'DescribeVsDomainRecordData', 'DescribeVsDomainSnapshotData', 'DescribeVsDomainRegionData', 'DescribeVsDomainBpsData', 'DescribeVsDomainReqBpsData', 'DescribeVsDomainTrafficData', 'DescribeVsDomainReqTrafficData', 'DescribeVsDevicesData', 'DescribeVsUpPeakPublishStreamData', ], ], [ 'id' => 390644, 'title' => '其他', 'type' => 'directory', 'children' => [ 'VerifyVsDomainOwner', 'DescribeVsVerifyContent', 'StartPublishStream', 'DescribePublishStreamStatus', 'StopPublishStream', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'ModifyRenderingChargeType' => [ 'summary' => '变配云渲染资源实例付费类型', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREvsJ3UH6I', ], ], 'parameters' => [ [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => '> 此值仅在 `InstanceChargeType` 为 `PrePaid`（包年包月）时有效。'."\n" ."\n" .'开启或关闭自动续费，取值：'."\n" .'* **true**：开启。'."\n" .'* **false**：关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => '> 此值仅在 `InstanceChargeType` 为 `PrePaid`（包年包月）时有效。'."\n" ."\n" .'包年包月的时长。取值范围（注：当选12的时候会被换算为一年，其余以月为周期单位）：'."\n" ."\n" .'- 1（默认）'."\n" .'- 2'."\n" .'- 3'."\n" .'- 4'."\n" .'- 5'."\n" .'- 6'."\n" .'- 7'."\n" .'- 8'."\n" .'- 9'."\n" .'- 12', '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' => '> 此值仅在 `InstanceChargeType` 为 `PostPaid`（按量付费）时有效。'."\n" ."\n" .'计费类型，取值范围：'."\n" ."\n" .'- Hour：小时。', 'type' => 'string', 'required' => false, 'example' => 'Hour', 'default' => 'Hour', 'enum' => [ 'Hour', ], ], ], [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例 ID。', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'InstanceChargeType', 'in' => 'query', 'schema' => [ 'description' => '实例的目标付费方式，取值范围：'."\n" ."\n" .'- PrePaid（默认）：预付费包年包月。'."\n" .'- PostPaid：后付费按量付费。', 'type' => 'string', 'required' => true, 'example' => 'PostPaid', 'enum' => [ 'PrePaid', 'PostPaid', ], ], ], ], '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' => '云渲染实例ID', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\"\\n}","type":"json"}]', 'title' => '云应用服务实例付费方式变配', ], 'CreateRenderingInstance' => [ 'summary' => '调用CreateRenderingInstance创建一个云应用服务实例', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREvsJ3UH6I', ], ], 'parameters' => [ [ 'name' => 'RenderingSpec', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例规格', 'description' => '云应用服务实例规格'."\n" ."\n" .'- 规格为crs.cp.*系列，付费方式可选择预付费或者后付费。'."\n" .'- 规格为crs.vm.*系列，付费方式可选择预付费或者后付费。'."\n" .'- 其它剩余系列，付费方式只支持预付费。', 'type' => 'string', 'required' => true, 'example' => 'crs.cp.l1', ], ], [ 'name' => 'ClientInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '客户端信息', 'description' => '客户端信息', 'type' => 'object', 'properties' => [ 'ClientIp' => [ 'title' => '客户端IP地址', 'description' => '客户端IP地址', 'type' => 'string', 'required' => false, 'example' => '172.21.128.110', ], ], 'required' => false, ], ], [ 'name' => 'InternetMaxBandwidth', 'in' => 'query', 'schema' => [ 'description' => '最大带宽，单位 Mbps，默认值10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', ], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => '> 此值仅在 `InstanceChargeType` 为 `PrePaid`（包年包月）时有效。'."\n" ."\n" .'开启或关闭自动续费，取值：'."\n" .'* **true**：开启。'."\n" .'* **false**：关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => '> 此值仅在 `InstanceChargeType` 为 `PrePaid`（包年包月）时有效。'."\n" ."\n" .'包年包月的时长。取值范围（注：当选12的时候会被换算为一年，其余以月为周期单位）：'."\n" ."\n" .'- 1（默认）'."\n" .'- 2'."\n" .'- 3'."\n" .'- 4'."\n" .'- 5'."\n" .'- 6'."\n" .'- 7'."\n" .'- 8'."\n" .'- 9'."\n" .'- 12', 'type' => 'string', 'required' => false, 'example' => '1', 'enum' => [ '1', '2', '3', '4', '5', '6', '7', '8', '9', '12', ], ], ], [ 'name' => 'InstanceChargeType', 'in' => 'query', 'schema' => [ 'description' => '实例的付费方式，取值范围：'."\n" ."\n" .'- PrePaid（默认）：预付费包年包月。'."\n" .'- PostPaid：后付费按量付费。', 'type' => 'string', 'required' => false, 'example' => 'PrePaid', 'enum' => [ 'PrePaid', 'PostPaid', ], ], ], [ 'name' => 'InternetChargeType', 'in' => 'query', 'schema' => [ 'description' => '> 只能有一种计费方式，如果已存在计费方式，则新值默认无效，以已存在的为准。注意用户第一次购买的时候该字段必填。'."\n" ."\n" .'网络计费类型，取值：'."\n" .'- 95BandwidthByMonth：月95峰值带宽。', 'type' => 'string', 'required' => false, 'example' => '95BandwidthByMonth', 'enum' => [ '95BandwidthByMonth', 'BandwidthByDay', ], ], ], [ 'name' => 'StorageSize', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例使用云存储容量（注：非本地存储）。', 'type' => 'string', 'required' => false, 'example' => '20', ], ], [ 'name' => 'InstanceBillingCycle', 'in' => 'query', 'schema' => [ 'description' => '> 此值仅在 `InstanceChargeType` 为 `PostPaid`（按量付费）时有效。'."\n" ."\n" .'计费类型，取值范围：'."\n" ."\n" .'- Hour：小时。', 'type' => 'string', 'required' => false, 'example' => 'Hour', 'enum' => [ 'Hour', ], ], ], [ 'name' => 'Attributes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '> 非特殊需求，请保持默认值。有特殊需求的客户，请沟通确认后填写相关参数。'."\n" ."\n" .'属性信息', 'type' => 'object', 'properties' => [ 'Zone' => [ 'description' => '资源域。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Private' => 'Private', 'Public' => 'Public', ], 'example' => 'Public', ], 'OutAccess' => [ 'description' => '出网配置。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'OFF' => 'OFF', 'ON' => 'ON', ], 'example' => 'ON', ], 'InAccess' => [ 'description' => '入网配置。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'OFF' => 'OFF', 'ON' => 'ON', ], 'example' => 'ON', ], 'EdgeMediaService' => [ 'description' => '流化服务。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'OFF' => 'OFF', 'ON' => 'ON', ], 'example' => 'ON', ], ], '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' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"RenderingInstanceId\\": \\"render-9f8c57355d224ad7beaf95e145f22111\\"\\n}","type":"json"}]', 'title' => '云应用服务实例创建', ], 'ListRenderingInstances' => [ 'summary' => '查询云应用服务实例基本信息列表，支持分页查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '199255', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingSpec', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例规格', 'type' => 'string', 'required' => false, 'example' => 'crs.cp.l1', ], ], [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => '分页查询时设置的页码。 起始值：1。默认值：1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => '分页查询时设置的每页行数。 取值范围：1~100。默认值：10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'StorageSize', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例存储容量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2021-10-31T07:59:59Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2021-10-31T15:59:59Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'RenderingInstances' => [ 'description' => '云应用服务实例信息列表', 'type' => 'array', 'items' => [ 'description' => '云应用服务实例基本信息', 'type' => 'object', 'properties' => [ 'RenderingInstanceId' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', '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' => [ 'description' => '云存储容量，单位：GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], ], ], ], 'TotalCount' => [ 'title' => '云渲染实例总数', 'description' => '云应用服务实例总数', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], ], ], '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' => '查询云应用服务实例基本信息列表', ], 'ModifyRenderingInstanceAttribute' => [ 'summary' => '修改云应用服务实例属性。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvsGPC7NJ', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '设备密码。', 'type' => 'string', 'required' => true, 'example' => 'Toehold2020', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '修改云应用服务实例属性', ], 'DescribeRenderingInstance' => [ 'summary' => '查询一个云应用服务实例的详细信息。', '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' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'RenderingInstanceId' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], 'CreationTime' => [ 'title' => '实例创建时间', 'description' => '实例创建时间', 'type' => 'string', 'example' => '2024-05-07T02:27:06Z', ], 'SystemInfo' => [ 'description' => '系统信息，包括分辨率等', 'type' => 'object', 'properties' => [ 'Resolution' => [ 'description' => '分辨率。取值：'."\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', ], 'Frequency' => [ 'description' => '实例刷新率，单位HZ', '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' => '实例操作状态，取值范围，'."\n" .'1. Preparing：初始化准备中'."\n" .'2. Rebooting：重启中'."\n" .'3. Resetting：重置中'."\n" .'4. Working：工作中，属于终态'."\n" .'5. Failure：操作失败，属于终态', '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' => '出/入方向带宽限速。单位Mb/s。', 'type' => 'object', 'properties' => [ 'MaxIngressBandwidth' => [ 'description' => '入方向最大限流，单位Mb/s。0表示无限流配置', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'MaxEgressBandwidth' => [ 'description' => '出方向最大限流，单位Mb/s。0表示无限流配置', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'BandwidthStatus' => [ 'description' => '带宽生效状态，取值：'."\n" ."\n" .'1. waiting：生效中'."\n" .'2. success：已生效'."\n" .'3. failed：生效失败', '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' => '真机仿真功能模块名，取值范围包括，'."\n" .'1. ctl：控制模块'."\n" .'2. prop：属性模块'."\n" .'3. location：定位模块'."\n" .'4. battery：电池模块'."\n" .'5. network：网络模块'."\n" .'6. bluetooth：蓝牙模块'."\n" .'7. sim：SIM卡模块'."\n" .'8. display：设备模块'."\n" .'9. system：基础模块', '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' => '云应用服务实例域名/访问IP', 'type' => 'string', 'example' => 'cn-xxx.ecr.aliyuncs.com', ], 'Isp' => [ 'title' => '运营商编码，取值范围：'."\n" .'1. cmcc'."\n" .'2. unicom'."\n" .'3. telecom', 'description' => '运营商编码，取值范围：'."\n" .'1. cmcc'."\n" .'2. unicom'."\n" .'3. telecom', 'type' => 'string', 'example' => 'telecom', ], 'PortMappings' => [ 'title' => '端口映射信息', 'description' => '端口映射信息列表', 'type' => 'array', 'items' => [ 'description' => '端口映射信息', 'type' => 'object', 'properties' => [ 'ExternalPort' => [ 'title' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'description' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'type' => 'string', 'example' => '10013/10020', ], 'InternalPort' => [ 'title' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'description' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'type' => 'string', 'example' => '49008/49015', ], ], ], ], 'RenderingSpec' => [ 'description' => '云应用服务实例规格', 'type' => 'string', 'example' => 'crs.cp.l1', ], 'StorageSize' => [ 'description' => '云应用服务实例存储容量', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'EgressIp' => [ 'title' => '出站IP', 'description' => '出站IP', 'type' => 'string', 'example' => '1.1.8.8', ], 'AdditionalIngresses' => [ 'title' => '其他可选的入口网络信息', 'description' => '其他可选的入口网络信息', 'type' => 'array', 'items' => [ 'description' => '可选的入口网络信息', 'type' => 'object', 'properties' => [ 'Hostname' => [ 'title' => '云应用服务实例域名/IP', 'description' => '云应用服务实例域名/IP', 'type' => 'string', 'example' => '101.66.165.213', ], 'Isp' => [ 'title' => '运营商编码，取值范围：'."\n" .'1. cmcc'."\n" .'2. unicom'."\n" .'3. telecom', 'description' => '运营商编码，取值范围：'."\n" .'1. cmcc'."\n" .'2. unicom'."\n" .'3. telecom', 'type' => 'string', 'example' => 'cmcc', ], 'PortMappings' => [ 'title' => '端口映射列表', 'description' => '端口映射列表', 'type' => 'array', 'items' => [ 'description' => '端口映射信息', 'type' => 'object', 'properties' => [ 'ExternalPort' => [ 'title' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'description' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'type' => 'string', 'example' => '12500/12519', ], 'InternalPort' => [ 'title' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'description' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'type' => 'string', 'example' => '11120/11139', ], ], ], ], ], ], ], 'InternalIp' => [ 'description' => '内网IP', 'type' => 'string', 'example' => '10.1.17.32', ], 'ResourceAttributes' => [ 'title' => '云应用服务实例属性信息', 'description' => '云应用服务实例属性信息', 'type' => 'object', 'properties' => [ 'Zone' => [ 'title' => '资源域，取值范围：Private、Public', 'description' => '资源域，取值范围：Private、Public', 'type' => 'string', 'example' => 'Public', 'enum' => [ 'Private', 'Public', ], ], 'OutAccess' => [ 'title' => '出网配置，取值范围：'."\n" .'1. ON：开启。资源具备访问公网能力。'."\n" .'2. OFF：关闭。', 'description' => '出网配置，取值范围：'."\n" .'1. ON：开启。资源具备访问公网能力。'."\n" .'2. OFF：关闭。', 'type' => 'string', 'example' => 'ON', 'enum' => [ 'ON', 'OFF', ], ], 'InAccess' => [ 'title' => '入网配置，取值范围：'."\n" .'1. ON：开启。资源可被外部访问。'."\n" .'2. OFF：关闭。', 'description' => '入网配置，取值范围：'."\n" .'1. ON：开启。资源可被外部访问。'."\n" .'2. OFF：关闭。', 'type' => 'string', 'example' => 'ON', 'enum' => [ 'ON', 'OFF', ], ], 'EdgeMediaService' => [ 'title' => '流化服务，取值范围：'."\n" .'1. ON：开启。'."\n" .'2. OFF：关闭。', 'description' => '流化服务，取值范围：'."\n" .'1. ON：开启。'."\n" .'2. OFF：关闭。', 'type' => 'string', 'example' => 'ON', 'enum' => [ 'ON', 'OFF', ], ], ], ], 'InstanceChargeType' => [ 'title' => '实例计费类型', 'description' => '实例计费类型', 'type' => 'string', 'example' => 'PostPaid', ], ], ], ], ], '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"}]', 'title' => '查询云应用服务实例详细信息', ], 'GetRenderingInstanceStreamingInfo' => [ 'summary' => '获取一个云应用服务实例的流连接信息，每次流化建联前都需要调用此接口获取最新连接信息。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '199704', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'RenderingInstanceId' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], 'Gateway' => [ 'description' => '云应用服务实例流化网关域名', 'type' => 'string', 'example' => '10.178.208.22', ], 'Hostname' => [ 'description' => '云应用服务实例串流域名/IP', 'type' => 'string', 'example' => '10.18.20.2', ], 'Port' => [ 'description' => '流化连接端口', 'type' => 'string', 'example' => '10003', ], 'FlowId' => [ 'description' => '本次连接的令牌', 'type' => 'string', 'example' => '792fy125-594c-4dde-ab35-9ff8hrf0a86f', ], ], ], ], ], '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' => '查询云应用服务实例流连接信息', ], 'RefreshRenderingInstanceStreaming' => [ 'summary' => '调用 RefreshRenderingInstanceStreaming 刷新云应用服务实例流连接。', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvs4YZ3LQ', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例ID。', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'ClientInfo', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '客户端信息。', 'type' => 'object', 'properties' => [ 'ClientIp' => [ 'description' => '客户端IP地址。', 'type' => 'string', 'required' => false, 'example' => '172.21.128.110', ], 'NewClient' => [ 'description' => '是否为新的客户端。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'RenderingInstanceId' => [ 'description' => '云应用服务实例ID。', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], 'Gateway' => [ 'description' => '云应用服务实例流化网关域名。', 'type' => 'string', 'example' => '10.178.208.22', ], 'Hostname' => [ 'description' => '云应用服务实例串流域名/IP。', 'type' => 'string', 'example' => 'cn-xxx.ecr.aliyuncs.com', ], 'Port' => [ 'description' => '流连接端口。', 'type' => 'string', 'example' => '8080', ], 'FlowId' => [ 'description' => '本次连接的令牌。', 'type' => 'string', 'example' => '792fy125-594c-4dde-ab35-9ff8hrf0a86f', ], ], ], ], ], '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' => '刷新云应用服务实例流连接', 'description' => '> 模板ID和模板类型至少指定一个。', ], 'SendRenderingInstanceCommands' => [ 'summary' => '向一个云应用服务实例下发shell控制指令，支持同步/异步响应命令。'."\n" .'同步场景，不适用于耗时命令（最大耗时不能超过30s）。'."\n" .'异步场景，可通过GetRenderingInstanceCommandsStatus接口查询命令执行状态与结果。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '213860', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'Commands', 'in' => 'formData', 'schema' => [ 'title' => 'shell命令字符串。支持输入多条命令，以";"分隔', 'description' => 'shell命令字符串。支持输入多条命令，以";"/换行符分隔，'."\n" ."\n" .'- 禁用rm/reboot等危险命令', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => 'date;ls -l /tmp', ], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => [ 'title' => '命令响应模式，取值范围：'."\n" .'1. Sync：同步响应。默认值。'."\n" .'2. Async：异步响应', 'description' => '命令响应模式，取值范围：'."\n" .'1. Sync：同步响应。默认值。'."\n" .'2. Async：异步响应', 'type' => 'string', 'required' => false, 'example' => 'Async', 'enum' => [ 'Async', 'Sync', ], ], ], [ 'name' => 'Timeout', 'in' => 'query', 'schema' => [ 'title' => '命令执行的超时时间，单位秒。取值范围与Mode响应模式取值有关：'."\n" .'1. Mode=Sync，0-30，默认30'."\n" .'2. Mode=Async，0-3600，默认300', 'description' => '命令执行的超时时间，单位秒。取值范围与Mode响应模式取值有关：'."\n" .'1. Mode=Sync，0-30，默认30'."\n" .'2. Mode=Async，0-3600，默认300', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '60', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Result' => [ 'title' => '命令的执行结果字符串', 'description' => '命令响应结果', 'type' => 'string', 'example' => 'Thu Jun 27 16:06:26 CST 2024', ], 'CmdId' => [ 'title' => '命令请求的唯一ID。默认1天内有效，对于异步场景，对结果有关注的情况，建议在有效时间内尽快查询结果（最好在命令执行超期时间内）。', 'description' => '命令请求的唯一ID。默认1天内有效，对于异步场景，对结果有关注的情况，建议在有效时间内尽快查询结果（最好在命令执行超期时间内）。', 'type' => 'string', 'example' => 'cmd-81de027b66e442e99c1e0e09a16a0be5', ], ], ], ], ], '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' => '下发云应用服务实例控制指令', ], 'GetRenderingInstanceCommandsStatus' => [ 'summary' => '查询控制命令的执行状态，获取命令是否执行成功、执行结果字符串等。', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '213860', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'CmdId', 'in' => 'query', 'schema' => [ 'title' => '命令下发请求的唯一ID', 'description' => '命令下发请求的唯一ID', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => 'cmd-81de027b66e442e99c1e0e09a16a0be5', ], ], ], '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' => '命令执行状态，取值范围：'."\n" .'1. Doing：执行中'."\n" .'2. Success：已成功'."\n" .'3. Failed：失败。超时时间内，失败会自动重试，客户可以选择继续等待或重新发起请求。', 'type' => 'string', 'example' => 'Success', ], 'Message' => [ 'title' => '描述信息。Status=Failed时，包含失败原因', 'description' => '描述信息。Status=Failed时，包含失败原因', 'type' => 'string', 'example' => 'conn failed!', ], ], ], ], ], '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' => '查看实例控制命令执行状态', ], 'ModifyRenderingInstance' => [ 'summary' => '变配云应用服务实例', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREvsJ3UH6I', ], ], 'parameters' => [ [ 'name' => 'RenderingSpec', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例规格', 'description' => '云应用服务实例规格。', 'type' => 'string', 'required' => false, 'example' => 'crs.cp.l1', ], ], [ 'name' => 'StorageSize', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例使用云存储容量（注：非本地存储）。', 'type' => 'string', 'required' => false, 'example' => '20', ], ], [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例ID（注：只支持同系列规格的变配）。', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], ], '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"}]', 'title' => '云应用服务实例变配', ], 'RebootRenderingInstance' => [ 'summary' => '重启一个云应用服务实例。'."\n" .'可通过查询接口DescribeRenderingInstance获取重启进度。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '212048', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '重启云应用服务实例', ], 'RebootRenderingServer' => [ 'summary' => '云应用服务实例主机重启', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvsGPC7NJ', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '云应用服务实例ID列表', 'type' => 'array', 'items' => [ 'description' => '云应用服务实例ID列表', 'type' => 'string', 'required' => false, 'example' => '[\\"render-6cdd65c6964c4ef2a635341f8c024191\\"]', ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'SuccessInstanceCount' => [ 'description' => '成功的云应用服务实例量', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'SuccessInstances' => [ 'description' => '云应用服务实例ID与关联结果描述信息', 'type' => 'array', 'items' => [ 'description' => '云应用服务实例ID与关联结果描述信息', 'type' => 'object', 'properties' => [ 'RenderingInstanceId' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-e6cf423c787e4e43b460a788da254fe3', ], ], ], ], 'FailedInstanceCount' => [ 'description' => '失败的云应用服务实例量', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'FailedInstances' => [ 'description' => '云应用服务实例ID与关联失败信息', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RenderingInstanceId' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-421cd2a1125947c19fcd5c7dd2c7d31e', ], 'ErrMessage' => [ 'description' => '失败原因信息', 'type' => 'string', 'example' => 'Rejected due to timeout', ], 'ErrCode' => [ 'description' => '失败错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '300000', ], ], ], ], ], ], ], ], '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' => '重启云应用服务实例所属主机', ], 'ResetRenderingInstance' => [ 'summary' => '重置一个云应用服务实例。'."\n" .'可通过查询接口DescribeRenderingInstance获取重置进度。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '234195', 'abilityTreeNodes' => [ 'FEATUREvsUGIQL3', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'DataPackageId', 'in' => 'query', 'schema' => [ 'description' => '数据基线id', 'type' => 'string', 'required' => false, 'example' => 'dp-449ea3d16c0841b8bf33ec5bbc86a152', ], ], [ 'name' => 'ActionName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'example' => 'Reset', 'default' => 'Reset', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '重置云应用服务实例', ], 'ModifyRenderingInstanceBandwidth' => [ 'summary' => '更新一个云应用服务实例的限速带宽。'."\n" .'可以通过实例查询接口DescribeRenderingInstance，获取限速值与限速更新状态。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '213857', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'MaxIngressBandwidth', 'in' => 'query', 'schema' => [ 'title' => 'MaxIngressBandwidth/MaxEgressBandwidth至少必选其一'."\n" .'● 入方向最大限流，单位Mb/s；'."\n" .'● 实例原始配置不限流；'."\n" .'● 无输入或输入0时，默认保留最后一次配置'."\n" .'● 输入小于0时，重置为不限流', 'description' => '入方向最大限流，单位Mb/s。MaxIngressBandwidth/MaxEgressBandwidth至少必选其一，'."\n" .'- 实例原始配置不限流；'."\n" .'- 无输入或输入0时，默认保留最后一次配置'."\n" .'- 输入小于0时，重置为不限流', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'MaxEgressBandwidth', 'in' => 'query', 'schema' => [ 'title' => 'MaxIngressBandwidth/MaxEgressBandwidth至少必选其一'."\n" .'● 出方向最大限流，单位Mb/s'."\n" .'● 实例原始配置不限流；'."\n" .'● 无输入或输入0时，默认保留最后一次配置'."\n" .'● 输入小于0时，重置为不限流', 'description' => '出方向最大限流，单位Mb/s。MaxIngressBandwidth/MaxEgressBandwidth至少必选其一，'."\n" .'- 实例原始配置不限流；'."\n" .'- 无输入或输入0时，默认保留最后一次配置'."\n" .'- 输入小于0时，重置为不限流', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '更新云应用服务实例限速带宽', ], 'RenewRenderingInstance' => [ 'summary' => '调用RenewRenderingInstance续费一个云应用服务实例', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ 'description' => '开启或关闭自动续费，取值：'."\n" .'* **true**：开启。'."\n" .'* **false**。关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => [ 'description' => '包年包月的时长。 取值范围 1(默认) 2 3 4 5 6 7 8 9 12当选12的时候会被换算为一年，其余以月为周期单位', 'type' => 'string', 'required' => false, 'example' => '1', 'enum' => [ '1', '2', '3', '4', '5', '6', '7', '8', '9', '12', ], ], ], [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '云应用服务实例续费', ], 'ReleaseRenderingInstance' => [ 'summary' => '调用ReleaseRenderingInstance释放一个云应用服务实例', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '云应用服务实例释放', ], 'CreateRenderingDataPackage' => [ 'summary' => '创建云应用服务数据包', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREvsJ3UH6I', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例ID（注：只可针对crs.cp.*系列实例类型进行操作）。', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '描述信息。', 'type' => 'string', 'required' => false, 'example' => 'testdescription', 'maxLength' => 64, ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => '数据类型。可选值：'."\n" .'- Package（默认值）。'."\n" .'- Baseline。', 'type' => 'string', 'required' => false, 'example' => 'Package', 'enum' => [ 'Package', 'Baseline', ], ], ], [ 'name' => 'InstanceBillingCycle', 'in' => 'query', 'schema' => [ 'description' => '计费类型，取值范围：'."\n" ."\n" .'- Hour：小时。', 'type' => 'string', 'required' => false, 'example' => 'Hour', 'enum' => [ 'Hour', 'Day', 'Month', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'DataPackageId' => [ 'description' => '云应用服务数据包ID', 'type' => 'string', 'example' => 'dp-9f8c57355d224ad7beaf95e145f22111'."\n" ."\n", ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"DataPackageId\\": \\"dp-9f8c57355d224ad7beaf95e145f22111\\\\n\\\\n\\"\\n}","type":"json"}]', 'title' => '云应用服务数据包创建', ], 'ListRenderingDataPackages' => [ 'summary' => '查询所有云应用数据包信息，支持分页查询。', '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' => 'Size', 'in' => 'query', 'schema' => [ 'description' => '数据包大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'DataPackageId', 'in' => 'query', 'schema' => [ 'description' => '数据包id', 'type' => 'string', 'required' => false, 'example' => 'dp-449ea3d16c0841b8bf33ec5bbc86a152', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '数据包状态。取值：'."\n" .'- available（可绑定）'."\n" .'- packing（制作中）'."\n" .'- failed（失败）'."\n" .'- bonded（已绑定）', 'type' => 'string', 'required' => false, 'example' => 'available', ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'description' => '类别，取值：'."\n" .'- Package 包'."\n" .'- Baseline 基线', 'type' => 'string', 'required' => false, 'example' => 'Baseline', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => '查询列表的页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ '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。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2021-10-30T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为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' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'DataPackages' => [ 'description' => '云应用服务数据包列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '数据包状态。取值：'."\n" .'available（可绑定）'."\n" .'packing（制作中）'."\n" .'failed（失败）'."\n" .'bonded（已绑定）', 'type' => 'string', 'example' => 'available', ], 'Description' => [ 'description' => '备注信息', 'type' => 'string', 'example' => 'test', ], 'Category' => [ 'description' => '类别，取值：'."\n" .'- Package 包'."\n" .'- Baseline 基线', 'type' => 'string', 'example' => 'Package', ], 'Size' => [ 'description' => '数据包大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'RenderingInstanceId' => [ 'description' => '云应用服务实例ID', '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' => '数据包id', 'type' => 'string', 'example' => 'dp-449ea3d16c0841b8bf33ec5bbc86a152'."\n", ], ], ], ], 'TotalCount' => [ 'title' => '云渲染实例总数', 'description' => '云渲染实例总数', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], ], ], ], ], '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' => '查询数据包列表', ], 'RecoverRenderingDataPackage' => [ 'summary' => '恢复数据到云渲染实例', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '212048', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'DataPackageId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务数据包ID', 'type' => 'string', 'required' => true, 'example' => 'dp-449ea3d16c0841b8bf33ec5bbc86a152'."\n", ], ], [ 'name' => 'LoadMode', 'in' => 'query', 'schema' => [ 'description' => '数据加载模式，取值：System/Process，默认为System。System表示系统级，稳定性高，耗时相对久，Process表示进程级，加载时效性高，稳定性相对差。', 'type' => 'string', 'required' => false, 'example' => 'Process', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '恢复数据到云应用服务', ], 'ReleaseRenderingDataPackage' => [ 'summary' => '释放云应用服务数据包', 'path' => '', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeNodes' => [ 'FEATUREvsJ3UH6I', ], ], 'parameters' => [ [ 'name' => 'DataPackageId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务数据包ID', 'type' => 'string', 'required' => true, 'example' => 'dp-9f8c57355d224ad7beaf95e145f22111', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BEF36E7-3838-5B92-BA32-87DBF1425ABC\\"\\n}","type":"json"}]', 'title' => '云应用服务数据包释放', ], 'UploadPublicKey' => [ 'summary' => '上传一个新的公钥信息。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '207881', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'KeyName', 'in' => 'query', 'schema' => [ 'title' => '公钥名称，不可重复。'."\n" .'取值规范：'."\n" .'1. 长度8-255'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首字符必须为字母或数字'."\n" .'4. 前缀不能为"group-"', 'description' => '公钥名称，不可重复。'."\n" .'取值规范：'."\n" .'1. 长度8-255'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首字符必须为字母或数字'."\n" .'4. 前缀不能为"group-"', 'type' => 'string', 'required' => true, 'example' => 'mykey-v1.0', 'maxLength' => 255, 'minLength' => 8, ], ], [ 'name' => 'KeyGroup', 'in' => 'query', 'schema' => [ 'title' => '公钥分组，用于公钥管理。'."\n" .'不同分组的公钥可以单独下发到具体设备。'."\n" .'取值规范：'."\n" .'1. 长度0-255'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首字符必须为字母或数字', 'description' => '公钥分组，用于公钥管理。'."\n" .'取值规范：'."\n" .'1. 长度0-255'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首字符必须为字母或数字', 'type' => 'string', 'required' => false, 'example' => 'g-test', ], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => [ 'title' => '经过编码的公钥内容，默认编码格式Base64。', 'description' => '经过编码的公钥内容，默认编码格式Base64。', 'type' => 'string', 'required' => true, 'example' => 'verify_dffeb6610035dcb77b413a59c3*****', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '公钥描述信息', 'description' => '公钥描述信息', 'type' => 'string', 'required' => false, 'example' => '测试使用', 'maxLength' => 255, ], ], [ 'name' => 'KeyType', 'in' => 'query', 'schema' => [ 'description' => '公钥的类型。可取值：'."\n" ."\n" .'- **adb**：ADB Key'."\n" .'- **ssh**：SSH Key', 'type' => 'string', 'required' => false, 'example' => 'ssh', 'default' => 'adb', 'enum' => [ 'adb', 'ssh', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '上传公钥', ], 'ListPublicKeys' => [ 'summary' => '查询满足条件的公钥信息列表，支持分页查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '207885', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'KeyName', 'in' => 'query', 'schema' => [ 'title' => '公钥名称', 'description' => '公钥名称', 'type' => 'string', 'required' => false, 'example' => 'mykey', ], ], [ 'name' => 'KeyGroup', 'in' => 'query', 'schema' => [ 'title' => '公钥分组，用于公钥管理。', 'description' => '公钥分组名', 'type' => 'string', 'required' => false, 'example' => 'g-test', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '查询列表的页码。起始值为1。'."\n" .'默认值：1。', 'description' => '查询列表的页码。起始值为1。'."\n" .'默认值：1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '分页查询时设置的每页行数，最大值为100行。'."\n" .'默认值：10。', 'description' => '分页查询时设置的每页行数，取值1～100。'."\n" .'默认值：10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', ], ], [ 'name' => 'KeyType', 'in' => 'query', 'schema' => [ 'description' => '公钥的类型。可取值：'."\n" ."\n" .'- **adb**：ADB Key'."\n" .'- **ssh**：SSH Key', 'type' => 'string', 'required' => false, 'example' => 'ssh', 'enum' => [ 'ssh', 'adb', ], ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2021-09-21T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为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' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', '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' => [ 'description' => '公钥的类型。可取值：'."\n" ."\n" .'- **adb**：ADB Key'."\n" .'- **ssh**：SSH Key', 'type' => 'string', 'example' => 'ssh', ], 'KeyGroup' => [ 'title' => '公钥分组', 'description' => '公钥分组', 'type' => 'string', 'example' => 'mygroup', ], 'Content' => [ 'title' => '经过编码的公钥内容，默认编码格式：Base64', 'description' => '经过编码的公钥内容，默认编码格式：Base64', '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', ], ], ], ], ], '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' => '查询公钥信息列表', ], 'ManageLogin' => [ 'summary' => '安全登录管理。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '207906', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'KeyName', 'in' => 'query', 'schema' => [ 'title' => '公钥名称，与 KeyGroup 至少存在一个，二者都存在时，KeyName 优先级更高且必须属于KeyGroup。', 'description' => '公钥名称，与KeyGroup至少存在一个', 'type' => 'string', 'required' => false, 'example' => 'mykey', ], ], [ 'name' => 'KeyGroup', 'in' => 'query', 'schema' => [ 'title' => '公钥分组，如果 KeyName 不存在，则下发 KeyGroup 内所有的公钥。', 'description' => '公钥分组，如果KeyName不存在，则下发KeyGroup内所有的公钥', 'type' => 'string', 'required' => false, 'example' => 'mygroup', ], ], [ 'name' => 'ActionName', 'in' => 'query', 'schema' => [ 'title' => '管理动作，取值：'."\n" .'open - 打开登陆，默认值'."\n" .'close - 关闭登陆', 'description' => '管理动作名，取值：'."\n" .'1. open - 生效公钥，默认值'."\n" .'2. close - 失效公钥', 'type' => 'string', 'required' => false, 'example' => 'open', 'default' => 'open', 'enum' => [ 'open', 'close', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'LoginInfo' => [ 'title' => '连接信息', 'description' => '连接信息', 'type' => 'object', 'properties' => [ 'LoginHostname' => [ 'title' => 'ssh 连接的host', 'description' => 'ssh 连接的host', 'type' => 'string', 'example' => '12.10.4.10', ], 'LoginPort' => [ 'title' => 'ssh 连接端口', 'description' => 'ssh 连接端口', 'type' => 'integer', 'format' => 'int32', 'example' => '10004', ], 'AdbLoginPort' => [ 'description' => 'adb 连接端口', 'type' => 'integer', 'format' => 'int32', 'example' => '10005', ], ], ], ], ], ], ], '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' => '云应用服务实例安全登录管理', ], 'DeletePublicKey' => [ 'summary' => '删除一个指定公钥。该公钥关联的所有云应用服务实例将自动失效登录授权。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '207905', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'KeyName', 'in' => 'query', 'schema' => [ 'title' => '公钥名称', 'description' => '公钥名称', 'type' => 'string', 'required' => true, 'example' => 'appKey', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '删除公钥', ], 'UploadCloudApp' => [ 'summary' => '上传/上架一个云应用包。'."\n" .'属于异步接口，可通过ListCloudApps接口查询上传进度。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '207909', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'title' => '是 应用名。安卓应用需使用其包名，如com.aaa.bbb。'."\n" .'默认取值规范：'."\n" .'1. 长度4-50'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首、尾字符必须为字母或数字', 'description' => '应用名。安卓应用建议使用其包名，如com.aaa.bbb。'."\n" ."\n" .'取值规范：'."\n" .'1. 长度4-50'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首、尾字符必须为字母或数字', 'type' => 'string', 'required' => true, 'example' => 'com.aaa.bbb', 'maxLength' => 50, 'minLength' => 4, ], ], [ 'name' => 'AppVersion', 'in' => 'query', 'schema' => [ 'title' => '是 应用版本。安卓应用需使用其VersionName，如1.1.1。'."\n" .'默认取值规范：'."\n" .'1. 长度1-50'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首、尾字符必须为字母或数字', 'description' => '应用版本。安卓应用建议使用其VersionName，如1.1.1。'."\n" .'取值规范：'."\n" .'1. 长度1-50'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首、尾字符必须为字母或数字', 'type' => 'string', 'required' => true, 'example' => '1.1.1', 'maxLength' => 50, 'minLength' => 1, ], ], [ 'name' => 'DownloadUrl', 'in' => 'query', 'schema' => [ 'description' => '应用包下载地址', 'type' => 'string', 'required' => true, 'example' => 'https://xxx.xxx.xxx.apk', ], ], [ 'name' => 'Md5', 'in' => 'query', 'schema' => [ 'description' => '应用包md5，用于检查应用包完整性', 'type' => 'string', 'required' => true, 'example' => '0CFBB7BD10CDD7279642ADAB8FEF3DEE', ], ], [ 'name' => 'PkgFormat', 'in' => 'query', 'schema' => [ 'title' => '安装包格式，默认是下载文件地址后缀。取值范围：'."\n" .'1. apk'."\n" .'2. tar.gz'."\n" .'3. tar'."\n" .'4. zip'."\n" .'5. rar', 'description' => '安装包格式，默认是下载文件地址后缀。取值范围：'."\n" .'1. apk'."\n" .'2. tar.gz'."\n" .'3. tar'."\n" .'4. zip'."\n" .'5. rar', 'type' => 'string', 'required' => false, 'example' => 'apk', 'enum' => [ 'apk', 'tar.gz', 'tar', 'zip', 'rar', ], ], ], [ 'name' => 'PkgType', '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', 'description' => '安装包类型。'."\n" ."\n" .'## 取值范围：'."\n" ."\n" .'1. android'."\n" .'2. win'."\n" .'3. android_appmarket：对应安卓应用市场场景，该场景下有apk真实PackageName限制'."\n" .'a. 不同AppName 的PackageName，不能重复'."\n" .'b. 同一AppName 不同AppVersion 可以关联 不同的PackageName'."\n" ."\n" .'## 默认值说明：'."\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', 'required' => false, 'example' => 'android', 'enum' => [ 'android', 'win', 'android_appmarket', ], ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '应用描述信息', 'description' => '应用描述信息', 'type' => 'string', 'required' => false, 'example' => '测试应用包', 'maxLength' => 255, ], ], [ 'name' => 'PkgLabels', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '云应用标签，可多选，取值范围：'."\n" .'1. hot'."\n" .'2. game'."\n" .'3. app', 'description' => '云应用标签，可多选，取值范围：'."\n" .'1. hot'."\n" .'2. game'."\n" .'3. app', 'type' => 'array', 'items' => [ 'title' => '云应用标签', 'description' => '云应用标签', 'type' => 'string', 'required' => false, 'example' => 'app', 'enum' => [ 'app', 'game', 'hot', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'AppId' => [ 'title' => '云应用ID，对应唯一的应用包', 'description' => '云应用ID，对应唯一的应用包', 'type' => 'string', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"AppId\\": \\"cap-b06b26edfhytbn b94a75ae1a79efc90eb\\"\\n}","type":"json"}]', 'title' => '上传应用', ], 'ListCloudApps' => [ 'summary' => '查询云应用列表，支持分页查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '207913', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '云应用ID，对应唯一的应用包', 'description' => '云应用ID，对应唯一的应用包', 'type' => 'string', 'required' => false, 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'title' => '应用名', 'description' => '应用名', 'type' => 'string', 'required' => false, 'example' => 'com.aaa.bbb', ], ], [ 'name' => 'AppVersion', 'in' => 'query', 'schema' => [ 'title' => '应用版本', 'description' => '应用版本', 'type' => 'string', 'required' => false, 'example' => '1.0', ], ], [ 'name' => 'PkgType', 'in' => 'query', 'schema' => [ 'title' => '安装包类型，取值范围：'."\n" .'1. android'."\n" .'2. win'."\n" .'3. android_appmarket'."\n", 'description' => '安装包类型，取值范围：'."\n" .'1. android'."\n" .'2. win'."\n" .'3. android_appmarket', 'type' => 'string', 'required' => false, 'example' => 'android', 'enum' => [ 'android', 'win', 'android_appmarket', ], ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '查询列表的页码。起始值为1。'."\n" .'默认值：1。', 'description' => '查询列表的页码。起始值为1。'."\n" .'默认值：1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '分页查询时设置的每页行数，最大值为100行。'."\n" .'默认值：10。', 'description' => '分页查询时设置的每页行数，取值范围1～100。'."\n" .'默认值：10', '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。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2021-09-29T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2021-09-30T02:23:00Z', ], ], [ 'name' => 'LatestVersionOnly', 'in' => 'query', 'schema' => [ 'title' => '是否仅输出应用最新提交的版本，默认false', 'description' => '是否仅输出应用最新提交的版本，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'PkgLabel', 'in' => 'query', 'schema' => [ 'title' => '云应用标签，'."\n" .'1. 取值范围：'."\n" .' a. hot'."\n" .' b. game'."\n" .' c. app'."\n" .'2. 特殊情况：'."\n" .' a. 查询无标签的应用列表：输入"NULL"', 'description' => '云应用标签，'."\n" .'1. 取值范围：'."\n" .' a. hot'."\n" .' b. game'."\n" .' c. app'."\n" .'2. 特殊情况：'."\n" .' a. 查询无标签的应用列表：输入"NULL"', 'type' => 'string', 'required' => false, 'example' => 'app', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'title' => '应用上传状态，取值范围：'."\n" .'1. Success：终态，成功'."\n" .'2. Failed：终态，失败'."\n" .'3. Created'."\n" .'4. Doing', 'description' => '应用上传状态，取值范围：'."\n" .'1. Success：终态，成功'."\n" .'2. Failed：终态，失败'."\n" .'3. Created'."\n" .'4. Doing', 'type' => 'string', 'required' => false, 'example' => 'Success', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'CloudApps' => [ 'title' => '云应用信息列表', 'description' => '云应用信息列表', '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' => '应用上传状态，取值范围：'."\n" .'1. Created'."\n" .'2. Doing'."\n" .'3. Success：终态'."\n" .'4. Failed：终态', 'type' => 'string', 'example' => 'Success', ], 'Description' => [ 'title' => '应用描述信息', 'description' => '应用描述信息', 'type' => 'string', 'example' => 'demo', ], 'AppId' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', ], 'PkgFormat' => [ 'title' => '安装包格式', 'description' => '安装包格式', 'type' => 'string', 'example' => 'apk', ], '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', 'description' => '安装包类型，android/win', 'type' => 'string', 'example' => 'android', ], 'AppName' => [ 'title' => '应用名', 'description' => '应用名', 'type' => 'string', 'example' => 'com.aaa.bbb', ], 'StablePatchId' => [ 'title' => '稳定版Patch包ID', 'description' => '稳定版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', ], ], ], ], ], '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' => '查询应用列表', ], 'UpdateCloudAppInfo' => [ 'summary' => '更新一个云应用的信息，如更新描述信息、更新应用标签、上传Patch等。'."\n" .'支持上传补丁包/热更包、支持安卓云应用市场制作热更包，一个云应用最多可上传20个补丁包、一个云应用同时只允许一个Patch是上传中状态。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '207912', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '云应用ID，对应唯一的应用包', 'description' => '云应用ID，对应唯一的应用包', 'type' => 'string', 'required' => true, 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '应用描述信息', 'description' => '应用描述信息', 'type' => 'string', 'required' => false, 'example' => '用于测试使用', 'maxLength' => 255, ], ], [ 'name' => 'StablePatchId', 'in' => 'query', 'schema' => [ 'title' => '稳定版PatchId。客户业务使用中(如会话启动)未指定PatchId情况，默认使用的PatchId。仅win场景支持。'."\n" .'特殊取值说明：'."\n" .'1. 输入值origin：表示取消patch版本，默认使用初始版本', 'description' => '稳定版PatchId。客户业务使用中(如会话启动)未指定PatchId情况，默认使用的PatchId。PkgType=android时不支持。'."\n" .'特殊取值说明：'."\n" .'1. 输入值origin：表示取消patch版本，默认使用初始版本', 'type' => 'string', 'required' => false, 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', ], ], [ 'name' => 'Patch', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '待上传的Patch包信息，仅win场景支持', 'description' => '待上传的Patch包信息。'."\n" .'1. PkgType=android时不支持;'."\n" .'2. 同AppId同时只允许一个Patch上传中（即同AppId同时只允许一个Patch非终态)', 'type' => 'object', 'properties' => [ 'PatchName' => [ 'title' => 'Patch包名称或描述，AppId下唯一标记之一。仅win场景支持。'."\n" .'默认取值规范：'."\n" .'1. 不能等于origin、all'."\n" .'2. 长度1-50'."\n" .'3. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'4. 首、尾字符必须为字母或数字', 'description' => 'Patch包名称或描述，AppId下唯一标记之一。'."\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优先级高。', 'description' => 'Patch包下载地址。'."\n" .'RenderingInstanceId/DownloadURL 必选其一，'."\n" .'DownloadURL优先级高。', 'type' => 'string', 'required' => false, 'example' => 'https://test_host/app/test-tar-pkg.tar', ], 'Md5' => [ 'title' => 'patch包md5，用于检查完整性。仅DownloadURL非空时有效，DownloadURL非空时必选。', 'description' => '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', 'description' => '安装包格式，默认是下载文件地址后缀。仅DownloadURL非空时有效，取值范围：'."\n" .'1. tar.gz'."\n" .'2. tar'."\n" .'3. zip'."\n" .'4. rar', 'type' => 'string', 'required' => false, 'example' => 'tar', 'enum' => [ 'tar', 'tar.gz', 'zip', 'rar', ], ], 'RenderingInstanceId' => [ 'title' => '制作patch包依赖的实例ID。仅安卓应用市场（PkgType=andrpid_appmarket）场景有效。RenderingInstanceId/DownloadURL 必选其一，'."\n" .'DownloadURL优先级高。', 'description' => '制作patch包依赖的实例ID。仅安卓应用市场（PkgType=andrpid_appmarket）场景有效。RenderingInstanceId/DownloadURL 必选其一，'."\n" .'DownloadURL优先级高。', 'type' => 'string', 'required' => false, 'example' => 'render-d7ec79fe47ce47aca2d8d7500d25a28a', ], 'AsStablePatch' => [ 'title' => '上传成功后是否自动配置为稳定版Patch，默认false。', 'description' => '上传成功后是否自动配置为稳定版Patch，默认false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', ], ], 'required' => false, ], ], [ 'name' => 'PkgLabels', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '云应用标签，可多选，将重置云应用标签，'."\n" .'1. 取值范围：'."\n" .' a. hot'."\n" .' b. game'."\n" .' c. app'."\n" .'2. 特殊情况：'."\n" .' a. 删除所有标签：输入["NULL"]', 'description' => '云应用标签，可多选，将重置云应用标签，'."\n" .'1. 取值范围：'."\n" .' a. hot'."\n" .' b. game'."\n" .' c. app'."\n" .'2. 特殊情况：'."\n" .' a. 删除所有标签：输入["NULL"]', 'type' => 'array', 'items' => [ 'title' => '云应用标签', 'description' => '云应用标签', 'type' => 'string', 'required' => false, 'example' => 'app', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'PatchId' => [ 'title' => '补丁包ID', 'description' => '补丁包ID', 'type' => 'string', 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"PatchId\\": \\"patch-03fa76e8e13a49b6a966b063d9d309b4\\"\\n}","type":"json"}]', 'title' => '更新应用基本信息', ], 'ListCloudAppPatches' => [ 'summary' => '查询一个云应用的Patch列表。', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '207913', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '云应用ID，对应唯一的应用包', 'description' => '云应用ID，对应唯一的应用包', 'type' => 'string', 'required' => true, 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', ], ], [ 'name' => 'PatchName', 'in' => 'query', 'schema' => [ 'title' => '补丁包名称', 'description' => '补丁包名称', 'type' => 'string', 'required' => false, 'example' => 'patch-1', ], ], [ 'name' => 'PatchId', 'in' => 'query', 'schema' => [ 'title' => '补丁包ID', 'description' => '补丁包ID', 'type' => 'string', 'required' => false, 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '查询列表的页码。起始值为1。'."\n" .'默认值：1。', 'description' => '查询列表的页码。起始值为1。'."\n" .'默认值：1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '分页查询时设置的每页行数，最大值为100行。'."\n" .'默认值：10。', 'description' => '分页查询时设置的每页行数，最大值为100行。'."\n" .'默认值：10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '10', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2015-11-29T00:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2017-12-10T21:00:00Z', ], ], ], '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' => '云应用Patch列表', 'type' => 'array', 'items' => [ 'title' => '云应用Patch信息', 'description' => '云应用Patch信息', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '应用上传状态，取值范围：'."\n" .'1. Created'."\n" .'2. Doing'."\n" .'3. Success：终态'."\n" .'4. Failed：终态'."\n" .'5. Deleting'."\n" .'6. DeleteFailed：终态', 'description' => '应用上传状态，取值范围：'."\n" .'1. Created'."\n" .'2. Doing'."\n" .'3. Success：终态'."\n" .'4. Failed：终态'."\n" .'5. Deleting'."\n" .'6. DeleteFailed：终态', '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' => '补丁包ID', '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', ], ], ], ], ], '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' => '查询云应用的Patch列表', 'description' => '>模板ID和模板类型至少指定一个。', ], 'InstallCloudApp' => [ 'summary' => '安装一个云应用到一个指定云应用实例。'."\n" .'属于异步接口，可通过ListCloudAppInstallations接口查询安装进度。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '207914', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云应用服务实例ID。'."\n" .'RenderingInstanceId、RenderingInstanceIds、ProjectId至少必选其一。'."\n" .'优先级RenderingInstanceId > RenderingInstanceIds > ProjectId', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '云应用ID', 'description' => '云应用ID', 'type' => 'string', 'required' => true, 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', ], ], [ 'name' => 'RenderingInstanceIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '云应用服务实例ID列表', 'description' => '云应用服务实例ID列表', 'type' => 'array', 'items' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-4523e7b93ca246febd10cd12347d70c0', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => false, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '项目下被选中的实例最大个数。仅ProjectId非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认100。取值1-100。', 'description' => '项目下被选中的实例最大个数。仅ProjectId非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认100。取值1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '100', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '项目下实例关联关系分页页码（分页查询默认按实例关联时间倒序）。仅ProjectId非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认1。'."\n" .'1. 关于PageNumber取值范围：'."\n" .' a. 【推荐】方法一：根据项目关联实例总数（接口ListRenderingProjectInstances可获取），换算出上限值。'."\n" .' b. 方法二：可以通过接口返回值判断PageNumber是否达到Project上限值，【优点：不用换算取值范围】。接口返回满足以下任意一个条件时，就可以认为PageNumber达到上限值：'."\n" .' ⅰ. 接口返回403+错误码Code 200301'."\n" .' ⅱ. 接口的返回值SuccessInstanceCount+FailedInstanceCount '项目下实例关联关系分页页码（分页查询默认按实例关联时间倒序）。仅ProjectId非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认1。'."\n" .'1. 关于PageNumber取值范围：'."\n" .' a. 【推荐】方法一：根据项目关联实例总数（接口ListRenderingProjectInstances可获取），换算出上限值。'."\n" .' b. 方法二：可以通过接口返回值判断PageNumber是否达到Project上限值，【优点：不用换算取值范围】。接口返回满足以下任意一个条件时，就可以认为PageNumber达到上限值：'."\n" .' ⅰ. 接口返回403+错误码Code 200301'."\n" .' ⅱ. 接口的返回值SuccessInstanceCount+FailedInstanceCount 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PatchId', 'in' => 'query', 'schema' => [ 'title' => '要安装的Patch包ID，仅win场景支持。'."\n" .'1. 默认安装StablePatchId'."\n" .'2. 输入值origin，表示安装原始版本', 'description' => '要安装的Patch包ID，仅win场景支持。'."\n" .'1. 默认安装StablePatchId'."\n" .'2. 输入值origin，表示安装原始版本', 'type' => 'string', 'required' => false, 'example' => 'patch-7bdf679812484df08a956b73e0b3bdf6', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'SuccessInstanceCount' => [ 'title' => '成功的云应用服务实例量', 'description' => '成功的云应用服务实例量', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'SuccessInstances' => [ 'title' => '成功的云应用服务实例列表', 'description' => '成功的云应用服务实例列表', 'type' => 'array', 'items' => [ 'title' => '云应用服务实例', 'description' => '云应用服务实例', 'type' => 'object', 'properties' => [ 'RenderingInstanceId' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-5130e2feb23f442fb9456a3d977f03d4', ], ], ], ], 'FailedInstanceCount' => [ 'title' => '失败的云应用服务实例量', 'description' => '失败的云应用服务实例量', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'FailedInstances' => [ 'title' => '失败的云应用服务实例列表', 'description' => '失败的云应用服务实例列表', 'type' => 'array', 'items' => [ 'title' => '失败的云应用服务实例', 'description' => '失败的云应用服务实例', 'type' => 'object', 'properties' => [ 'RenderingInstanceId' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-b45f28650ffe4591bf4c5c95996a428c', ], 'ErrMessage' => [ 'title' => '失败原因信息', 'description' => '失败原因信息', 'type' => 'string', 'example' => 'Rejected due to timeout', ], 'ErrCode' => [ 'description' => '失败错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '300000', ], ], ], ], ], ], ], ], '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' => '安装应用', ], 'ListCloudAppInstallations' => [ 'summary' => '查询云应用的安装信息列表，返回信息包括云应用服务实例的安装状态，支持分页查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '207921', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '云应用ID，对应唯一的应用包', 'description' => '云应用ID，对应唯一的应用包', 'type' => 'string', 'required' => false, 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', ], ], [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例ID，用于查询指定实例上安装的云应用', 'description' => '云应用服务实例ID，用于查询指定实例上安装的云应用', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'title' => '应用名', 'description' => '应用名', 'type' => 'string', 'required' => false, 'example' => 'com.aaa.bbb', ], ], [ 'name' => 'AppVersion', 'in' => 'query', 'schema' => [ 'title' => '应用版本', 'description' => '应用版本', 'type' => 'string', 'required' => false, 'example' => '1.0', ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => false, 'example' => 'project-b93ea81de76f48609eed3cd420f0399f', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '查询列表的页码。起始值为1。'."\n" .'默认值：1。', 'description' => '查询列表的页码。起始值为1。'."\n" .'默认值：1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '分页查询时设置的每页行数，最大值为100行。'."\n" .'默认值：10。', 'description' => '分页查询时设置的每页行数，取值范围1～100。'."\n" .'默认值：10', '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。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2025-05-26T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2025-06-02T02:18:00Z', ], ], [ 'name' => 'PatchId', 'in' => 'query', 'schema' => [ 'title' => 'Patch包ID，仅win场景支持。'."\n" .'1. 输入值origin，表示仅过滤出原始版本', 'description' => 'Patch包ID，仅win场景支持。'."\n" .'1. 输入值origin，表示仅过滤出原始版本', 'type' => 'string', 'required' => false, 'example' => 'patch-7bdf679812484df08a956b73e0b3bdf6', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', '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' => '云应用安装状态，取值范围：'."\n" .'1. 中间态：install-init、installing'."\n" .'2. 终态：installed、install-failed', 'type' => 'string', 'example' => 'installed', ], 'AppId' => [ 'title' => '应用ID', 'description' => '应用ID', 'type' => 'string', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', ], 'RenderingInstanceId' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', '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', 'description' => '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', ], ], ], ], ], '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' => '查询应用安装信息列表', ], 'UninstallCloudApp' => [ 'summary' => '卸载一个指定云应用实例上的一个指定云应用。'."\n" .'属于异步接口。可通过ListCloudAppInstallations接口查询卸载进度，卸载成功后，查询接口将不再输出相关内容。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '207920', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云应用服务实例ID。'."\n" .'RenderingInstanceId、RenderingInstanceIds、ProjectId至少必选其一。'."\n" .'优先级RenderingInstanceId > RenderingInstanceIds > ProjectId', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '云应用ID', 'description' => '云应用ID', 'type' => 'string', 'required' => true, 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', ], ], [ 'name' => 'RenderingInstanceIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '云应用服务实例ID列表', 'description' => '云应用服务实例ID列表', 'type' => 'array', 'items' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-4523e7b93ca246febd10cd12347d70c0', ], 'required' => false, 'maxItems' => 100, ], ], [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => false, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '项目下被选中的实例最大个数。仅ProjectId非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认100。取值1-100。', 'description' => '项目下被选中的实例最大个数。仅ProjectId非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认100。取值1-100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '100', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '项目下实例关联关系分页页码（分页查询默认按实例关联时间倒序）。仅ProjectId非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认1。'."\n" .'1. 关于PageNumber取值范围：'."\n" .' a. 【推荐】方法一：根据项目关联实例总数（接口ListRenderingProjectInstances可获取），换算出上限值。'."\n" .' b. 方法二：可以通过接口返回值判断PageNumber是否达到Project上限值，【优点：不用换算取值范围】。接口返回满足以下任意一个条件时，就可以认为PageNumber达到上限值：'."\n" .' ⅰ. 接口返回403+错误码Code 200301'."\n" .' ⅱ. 接口的返回值SuccessInstanceCount+FailedInstanceCount '项目下实例关联关系分页页码（分页查询默认按实例关联时间倒序）。仅ProjectId非空场景有效，限制项目下执行动作的最大实例数，以控制动作的影响面。默认1。'."\n" .'1. 关于PageNumber取值范围：'."\n" .' a. 【推荐】方法一：根据项目关联实例总数（接口ListRenderingProjectInstances可获取），换算出上限值。'."\n" .' b. 方法二：可以通过接口返回值判断PageNumber是否达到Project上限值，【优点：不用换算取值范围】。接口返回满足以下任意一个条件时，就可以认为PageNumber达到上限值：'."\n" .' ⅰ. 接口返回403+错误码Code 200301'."\n" .' ⅱ. 接口的返回值SuccessInstanceCount+FailedInstanceCount 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PatchId', 'in' => 'query', 'schema' => [ 'title' => '要卸载的Patch包ID，仅win场景支持。'."\n" .'1. 默认卸载StablePatchId'."\n" .'2. 输入值origin，表示卸载原始版本'."\n" .'3. 输入值all，表示卸载所有已安装版本', 'description' => '要卸载的Patch包ID，仅win场景支持。'."\n" .'1. 默认卸载StablePatchId'."\n" .'2. 输入值origin，表示卸载原始版本'."\n" .'3. 输入值all，表示卸载所有已安装版本', 'type' => 'string', 'required' => false, 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'SuccessInstanceCount' => [ 'title' => '成功的云应用服务实例量', 'description' => '成功的云应用服务实例量', 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'SuccessInstances' => [ 'title' => '成功的云应用服务实例列表', 'description' => '成功的云应用服务实例列表', 'type' => 'array', 'items' => [ 'title' => '云应用服务实例', 'description' => '云应用服务实例', 'type' => 'object', 'properties' => [ 'RenderingInstanceId' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-e6cf423c787e4e43b460a788da254fe3', ], ], ], ], 'FailedInstanceCount' => [ 'title' => '失败的云应用服务实例量', 'description' => '失败的云应用服务实例量', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'FailedInstances' => [ 'title' => '失败的云应用服务实例列表', 'description' => '失败的云应用服务实例列表', 'type' => 'array', 'items' => [ 'title' => '失败的云应用服务实例', 'description' => '失败的云应用服务实例', 'type' => 'object', 'properties' => [ 'RenderingInstanceId' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-b45f28650ffe4591bf4c5c95996a428c', ], 'ErrMessage' => [ 'title' => '失败原因信息', 'description' => '失败原因信息', 'type' => 'string', 'example' => 'Rejected due to timeout', ], 'ErrCode' => [ 'description' => '失败错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '300000', ], ], ], ], ], ], ], ], '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' => '卸载应用', ], 'DeleteCloudApp' => [ 'summary' => '删除一个云应用。使用中的云应用不允许删除。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208098', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '云应用ID，对应唯一的应用包', 'description' => '云应用ID，对应唯一的应用包', 'type' => 'string', 'required' => true, 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '删除应用', ], 'DescribeRenderingInstanceConfiguration' => [ 'summary' => '查询一个云应用服务实例系统配置的实时信息。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '213856', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'Configuration', '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, ], 'deprecated' => false, 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Configuration' => [ 'title' => '配置内容', 'description' => '配置内容', 'type' => 'array', 'items' => [ 'description' => '真机仿真模块属性', 'type' => 'object', 'properties' => [ 'ModuleName' => [ 'title' => '模块名称', 'description' => '真机仿真功能模块名，取值范围包括，'."\n" ."\n" .'1. ctl：控制模块'."\n" .'2. prop：属性模块'."\n" .'3. location：定位模块'."\n" .'4. battery：电池模块'."\n" .'5. network：网络模块'."\n" .'6. bluetooth：蓝牙模块'."\n" .'7. sim：SIM卡模块'."\n" .'8. display：设备模块'."\n" .'9. system：基础模块', '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', ], ], ], ], ], ], ], ], ], ], ], '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' => '查询云应用服务实例配置信息', ], 'UpdateRenderingInstanceConfiguration' => [ 'summary' => '更新一个云应用服务实例的配置参数。支持修改云安卓系统的prop/location/network 等各种配置，构建真机仿真。'."\n" .'可通过实例查询接口DescribeRenderingInstance，获取已设置的真机仿真配置值。'."\n" .'查询实时环境的配置参数，参考接口DescribeRenderingInstanceConfiguration。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '213807', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'Configuration', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '配置内容', 'description' => '配置内容', 'type' => 'array', 'items' => [ 'description' => '真机仿真模块属性', 'type' => 'object', 'properties' => [ 'ModuleName' => [ 'title' => '模块名称', 'description' => '真机仿真功能模块名，取值范围包括，'."\n" .'1. ctl：控制模块'."\n" .'2. prop：属性模块'."\n" .'3. location：定位模块'."\n" .'4. battery：电池模块'."\n" .'5. network：网络模块'."\n" .'6. bluetooth：蓝牙模块'."\n" .'7. sim：SIM卡模块'."\n" .'8. display：设备模块'."\n" .'9. system：基础模块', '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, ], ], 'required' => false, ], 'deprecated' => false, 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '更新云应用服务实例配置参数', ], 'DeleteRenderingInstanceConfiguration' => [ 'summary' => '清除一个云应用服务实例的配置设置。仅可删除通过UpdateRenderingInstanceConfiguration接口已配置的模块属性。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '213808', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '删除云应用服务实例的配置设置', ], 'DescribeRenderingInstanceSettings' => [ 'summary' => '调用 DescribeRenderingInstanceSettings 查询云应用服务实例配置', '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' => '云应用服务实例ID。', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'AttributeNames', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '实例配置名称列表。', 'type' => 'array', 'items' => [ 'description' => '实例配置名称。', 'type' => 'string', 'required' => false, 'example' => 'navbar.hide', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求 ID。', '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', ], ], ], ], ], ], ], ], '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' => '查询云应用服务实例配置', ], 'UpdateRenderingInstanceSettings' => [ 'summary' => '调用 UpdateRenderingInstanceSettings 更新云应用服务实例设置', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvs4YZ3LQ', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'Settings', '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, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '更新云应用服务实例设置', ], 'DeleteRenderingInstanceSettings' => [ 'summary' => '调用 DeleteRenderingInstanceSettings 删除云应用服务实例设置', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvs4YZ3LQ', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'AttributeNames', '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, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '删除云应用服务实例设置', ], 'UploadFile' => [ 'summary' => '上传一个文件。基于外链URL（公网可下载文件）实现文件上传到本地/云存储。'."\n" .'属于异步操作，可通过ListFiles接口查询上传进度。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '215923', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'FileName', 'in' => 'query', 'schema' => [ 'title' => '文件名。'."\n" .'默认取值规范：'."\n" .'1. 长度8-255'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首、尾字符必须为字母或数字', 'description' => '自定义文件名，不可重复，将作为文件的唯一标记之一。'."\n" .'默认取值规范：'."\n" .'1. 长度8-255'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首、尾字符必须为字母或数字', 'type' => 'string', 'required' => true, 'example' => 'mytest', 'maxLength' => 255, 'minLength' => 8, ], ], [ 'name' => 'OriginUrl', 'in' => 'query', 'schema' => [ 'title' => '文件下载地址。', 'description' => '文件下载地址', 'type' => 'string', 'required' => true, 'example' => 'https://xxx.xxx.xxx.tar', ], ], [ 'name' => 'Md5', 'in' => 'query', 'schema' => [ 'title' => '文件md5，用于检查文件完整性', 'description' => '文件md5，用于检查文件完整性', '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' => '向云应用服务实例推送的目标路径，必须是绝对路径，不支持输入目录。目标路径所在上级目录有范围限制，取值范围：'."\n" .'1. /data/local'."\n" .'2. /data/user'."\n" .'3. /data/data'."\n" .'4. /data/cache'."\n" .'5. /data/tmp'."\n" .'6. /data/storage'."\n" .'7. /data/media/0', 'type' => 'string', 'required' => true, 'example' => '/data/tmp/test/xxx.tar', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '文件描述信息', 'description' => '文件描述信息', 'type' => 'string', 'required' => false, 'example' => '测试使用', 'maxLength' => 255, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'FileId' => [ 'title' => '文件ID，对应唯一的文件，如f-xxx', 'description' => '文件ID，对应唯一的文件', 'type' => 'string', 'example' => 'f-1671330gr7934d4771813f7141d28db2f7', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"FileId\\": \\"f-1671330gr7934d4771813f7141d28db2f7\\"\\n}","type":"json"}]', 'title' => '上传文件', ], 'ListFiles' => [ 'summary' => '查询上传的文件列表，返回内容包含文件的上传状态，支持分页查询。', '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' => [ 'title' => '文件ID，对应唯一的可用文件', 'description' => '文件ID，对应唯一的可用文件', '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' => '查询列表的页码。起始值为1。'."\n" .'默认值：1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '分页查询时设置的每页行数，最大值为100行。'."\n" .'默认值：10。', 'description' => '分页查询时设置的每页行数，取值范围1～100。'."\n" .'默认值：10', '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。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2021-10-30T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2021-10-31T06:00:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', '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' => '文件上传状态，取值范围：'."\n" .'1. Created'."\n" .'2. Doing'."\n" .'3. Success：终态'."\n" .'4. Failed：终态', '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' => '文件ID', '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', ], ], ], ], ], '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' => '查询文件列表', ], 'UpdateFileInfo' => [ 'summary' => '更新一个文件的基本信息，如描述信息。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '215941', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '文件ID，对应唯一的文件。如f-xxx', 'description' => '文件ID，对应唯一的文件', 'type' => 'string', 'required' => true, 'example' => 'f-16713accddtgtj6340jgnclhwsg1813f718db2f7', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '文件描述信息', 'description' => '文件描述信息', 'type' => 'string', 'required' => true, 'example' => '测试使用', 'maxLength' => 255, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '更新文件基本信息', ], 'PushFile' => [ 'summary' => '推送一个文件到一个指定云应用服务实例。'."\n" .'属于异步操作，可通过ListFilePushStatuses接口查询推送进度。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '215938', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '文件ID', 'description' => '文件ID', 'type' => 'string', 'required' => true, 'example' => 'f-1671accd4dafdag3er256cvgewt13f7141db2f7', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '推送文件', ], 'ListFilePushStatuses' => [ 'summary' => '查询文件的云应用服务实例推送状态信息列表，支持分页查询。', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '215940', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '文件ID，对应唯一的文件。如f-xxx', 'description' => '文件ID，对应唯一的文件', 'type' => 'string', 'required' => false, 'example' => 'f-1671accd4dafdag3er256cvgewt13f7141db2f7', ], ], [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云渲染实例ID，用于查询指定实例上安装的云应用', 'description' => '云应用服务实例ID，用于查询指定实例上安装的文件', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'FileName', 'in' => 'query', 'schema' => [ 'title' => '文件名', 'description' => '文件名', 'type' => 'string', 'required' => false, 'example' => 'myfile', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '查询列表的页码。起始值为1。'."\n" .'默认值：1。', 'description' => '查询列表的页码。起始值为1。'."\n" .'默认值：1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '分页查询时设置的每页行数，最大值为100行。'."\n" .'默认值：10。', 'description' => '分页查询时设置的每页行数，取值范围1～100。'."\n" .'默认值：10。', '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。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2025-06-17T12:16:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为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' => [ 'title' => 'Id of the request', 'description' => '请求ID', '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' => '文件推送状态，取值范围：'."\n" .'1. Created'."\n" .'2. Doing'."\n" .'3. Success：终态'."\n" .'4. Failed：终态', 'type' => 'string', 'example' => 'Success', ], 'PushTime' => [ 'title' => '预推开始时间', 'description' => '预推开始时间', 'type' => 'string', 'example' => '2024-03-26T16:32:20+08:00', ], 'RenderingInstanceId' => [ 'title' => '云渲染实例ID', 'description' => '云应用服务实例ID', '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' => '文件ID', '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', ], ], ], ], ], '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' => '查询文件推送状态信息列表', ], 'DeleteFile' => [ 'summary' => '删除一个文件对象。'."\n" .'文件在上传/预推中时，不允许删除。文件删除后，所有相关的推送记录将失效，可重新推送同名文件。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '215939', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], ], 'parameters' => [ [ 'name' => 'FileId', 'in' => 'query', 'schema' => [ 'title' => '文件ID，对应唯一的文件。如f-xxx', 'description' => '文件ID，对应唯一的文件', 'type' => 'string', 'required' => true, 'example' => 'f-167131acd45omat771813f7141d28db2f7', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '删除文件', ], 'CreateRenderingInstanceGateway' => [ 'summary' => '创建自定义网关。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '247654', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => true, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'GatewayInstanceId', 'in' => 'query', 'schema' => [ 'description' => '自定义网关实例ID。', 'type' => 'string', 'required' => true, 'example' => 'render-xxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '创建自定义网关', 'description' => '> 模板ID和模板类型至少指定一个。', ], 'ListRenderingInstanceGateway' => [ 'summary' => '查询自定义网关。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '247655', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'GatewayInstanceId', 'in' => 'query', 'schema' => [ 'description' => '网关实例ID。', 'type' => 'string', 'required' => false, 'example' => 'render-xxx', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '查询列表的页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页查询时设置的每页行数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '10', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2025-05-18T02:20:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为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' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'GatewayConfigurationInfos' => [ 'description' => '自定义网关信息列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GatewayInstanceId' => [ 'description' => '自定义网关实例ID。', 'type' => 'string', 'example' => 'render-xxx', ], 'Status' => [ 'description' => '自定义网关状态，取值范围：'."\n" .'1. 中间态：creating, deleting, '."\n" .'2. 终态：available, failed', 'type' => 'string', 'example' => 'available', ], 'RenderingInstanceId' => [ 'description' => '云应用服务实例ID。', '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', ], ], ], ], ], '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' => '查询自定义网关', 'description' => '>模板ID和模板类型至少指定一个。', ], 'DeleteRenderingInstanceGateway' => [ 'summary' => '删除自定义网关。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '247658', 'abilityTreeNodes' => [ 'FEATUREvs8VD2LG', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '删除自定义网关', 'description' => '> 需先停止上级平台再删除。', ], 'CreateRenderingProject' => [ 'summary' => '创建一个新的云应用服务项目，并设置会话等相关属性。', 'path' => '/', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvsGPC7NJ', ], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'query', 'schema' => [ 'title' => '自定义项目名，将作为项目的唯一标记。'."\n" .'默认取值规范：'."\n" .'1. 长度1-128'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首、尾字符必须为字母或数字', 'description' => '自定义项目名，将作为项目的唯一标记。'."\n" .'默认取值规范：'."\n" .'1. 长度1-128'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首、尾字符必须为字母或数字', 'type' => 'string', 'required' => true, 'example' => 'du_merchant_d', 'maxLength' => 128, 'minLength' => 1, ], ], [ 'name' => 'SessionAttribs', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '会话属性', 'description' => '会话属性', 'type' => 'object', 'properties' => [ 'StartMode' => [ 'title' => '会话启动云应用服务的模式，取值范围，'."\n" .'1. Async：异步'."\n" .'2. Sync：同步', 'description' => '会话启动云应用服务的模式，取值范围，'."\n" .'1. Async：异步'."\n" .'2. Sync：同步', 'type' => 'string', 'required' => false, 'example' => 'Async', 'enum' => [ 'Async', 'Sync', ], ], ], 'required' => false, ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '项目描述信息，0-255', 'description' => '项目描述信息，0-255', 'type' => 'string', 'required' => false, 'example' => '项目概述', 'maxLength' => 255, ], ], ], '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', ], 'ProjectId' => [ 'description' => '项目ID。您可以调用ListRenderingProjects查看项目的ID。', 'type' => 'string', 'example' => 'project-b93ea81de76f48609eed3cd420f0399f', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"ProjectId\\": \\"project-b93ea81de76f48609eed3cd420f0399f\\"\\n}","type":"json"}]', 'title' => ' 创建项目', ], 'ListRenderingProjects' => [ 'summary' => '分页查询用户下的云应用服务项目基本信息列表。', 'description' => '## 请求说明'."\n" .'- 该接口用于分页查询指定用户下的渲染项目基本信息列表。'."\n" .'- 可通过 `ProjectId` 和 `ProjectName` 进行过滤查询。'."\n", 'path' => '/', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvsGPC7NJ', ], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', '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' => '页码，起始值为1', '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。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2024-09-29T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2024-10-03T02:18:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID', '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' => '项目ID', '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', ], ], ], ], ], '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' => '查询项目列表', ], 'UpdateRenderingProject' => [ 'summary' => '更新一个项目的属性信息', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvsGPC7NJ', ], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', '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' => '自定义项目名，将作为项目的唯一标记。'."\n" .'默认取值规范：'."\n" .'1. 长度1-128'."\n" .'2. 小写字母、数字、下划线\'_\'、中划线\'-\'、点分段\'.\''."\n" .'3. 首、尾字符必须为字母或数字'."\n" .'ProjectName/SessionAttribs/Description 至少一项非空', 'type' => 'string', 'required' => false, 'example' => 'idata_content', ], ], [ 'name' => 'SessionAttribs', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '会话属性', 'description' => '会话属性', 'type' => 'object', 'properties' => [ 'StartMode' => [ 'title' => '会话启动云应用服务的模式，取值范围，'."\n" .'1. Async：异步'."\n" .'2. Sync：同步', 'description' => '会话启动云应用服务的模式，取值范围，'."\n" .'1. Async：异步'."\n" .'2. Sync：同步', 'type' => 'string', 'required' => false, 'example' => 'Async', 'enum' => [ 'Async', 'Sync', ], ], ], 'required' => false, ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'title' => '项目描述', 'description' => '项目描述', 'type' => 'string', 'required' => false, 'example' => '目录1', 'maxLength' => 255, ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '更新项目信息', ], 'AssociateRenderingProjectInstances' => [ 'summary' => '云应用服务实例与项目进行关联。', 'description' => '## 请求说明'."\n" .'- 该接口用于将满足特定条件的实例与指定项目进行关联。'."\n", 'path' => '/', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvsGPC7NJ', ], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', ], ], [ 'name' => 'RenderingInstanceIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '云应用服务实例ID列表', 'type' => 'array', 'items' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-4523e7b93ca246febd10cd12347d70c0', ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '', 'description' => '请求ID。', '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' => '云应用服务实例ID与关联结果描述信息', 'type' => 'object', 'properties' => [ 'RenderingInstanceId' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-5130e2feb23f442fb9456a3d977f03d4', ], 'Message' => [ 'title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'SUCCESS', ], ], ], ], 'FailedInstances' => [ 'description' => '关联失败的实例列表', 'type' => 'array', 'items' => [ 'description' => '云应用服务实例ID与关联失败信息', 'type' => 'object', 'properties' => [ 'RenderingInstanceId' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-b45f28650ffe4591bf4c5c95996a428c', ], 'Message' => [ 'title' => '失败原因', 'description' => '失败原因', 'type' => 'string', 'example' => 'invalid id', ], ], ], ], ], ], ], ], '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' => '项目增加实例关联', ], 'ListRenderingProjectInstances' => [ 'summary' => '分页查询项目关联的云应用服务实例信息列表。', 'description' => '## 请求说明'."\n" .'- 该接口支持通过多种筛选条件（如状态、实例ID等）来查询指定项目下的云应用服务实例。'."\n", 'path' => '/', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvsGPC7NJ', ], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', ], ], [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'State', 'in' => 'query', 'schema' => [ 'title' => '云应用服务实例业务调度状态，取值范围，'."\n" .'1. Idle：空闲'."\n" .'2. Locked：锁定中'."\n" .'3. InUse：使用中', 'description' => '项目实例状态，取值范围，'."\n" .'1. Idle：空闲'."\n" .'2. Locked：锁定中'."\n" .'3. InUse：使用中', 'type' => 'string', 'required' => false, 'example' => 'Idle', 'enum' => [ 'Idle', 'Locked', 'InUse', ], ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '页码，起始值为1', 'description' => '页码，起始值为1', '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。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2024-11-27T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2024-11-30T02:18:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID', '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', ], ], ], ], ], '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' => '查询项目的实例关联信息', ], 'GetRenderingProjectInstanceStateMetrics' => [ 'summary' => '查询一个项目满足特定条件的项目实例各状态数据量统计值。', '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' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', ], ], ], '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' => '项目实例状态统计信息列表', 'type' => 'array', 'items' => [ 'description' => '项目实例状态统计信息', 'type' => 'object', 'properties' => [ 'State' => [ 'title' => '项目实例状态', 'description' => '项目实例状态', 'type' => 'string', 'example' => 'Idle', ], 'Count' => [ 'title' => '实例数量', 'description' => '实例数量', 'type' => 'string', 'example' => '10', ], ], ], ], ], ], ], ], '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' => '查询项目实例状态统计信息', ], 'DisassociateRenderingProjectInstances' => [ 'summary' => '云应用服务实例与项目解除关联关系。', 'path' => '/', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvsGPC7NJ', ], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', ], ], [ 'name' => 'RenderingInstanceIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '云应用服务实例ID列表', 'type' => 'array', 'items' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-a371588064324c57b7b0133a96cbd17a', ], 'required' => true, ], ], ], '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' => '解除关联成功的实例列表', 'type' => 'array', 'items' => [ 'description' => '解除关联成功的实例ID与结果描述信息', 'type' => 'object', 'properties' => [ 'RenderingInstanceId' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-e6cf423c787e4e43b460a788da254fe3', ], 'Message' => [ 'title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'success', ], ], ], ], 'FailedInstances' => [ 'description' => '解除关联失败的实例列表', 'type' => 'array', 'items' => [ 'description' => '解除关联失败的实例ID与失败描述信息', 'type' => 'object', 'properties' => [ 'RenderingInstanceId' => [ 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-421cd2a1125947c19fcd5c7dd2c7d31e', ], 'Message' => [ 'title' => '失败原因', 'description' => '失败原因', 'type' => 'string', 'example' => '会话中', ], ], ], ], 'SuccessInstanceCount' => [ 'title' => '成功的云应用服务实例量', 'description' => '成功的云应用服务实例量', 'type' => 'string', 'example' => '5', ], 'FailedInstanceCount' => [ 'title' => '失败的云应用服务实例量', 'description' => '失败的云应用服务实例量', 'type' => 'string', 'example' => '0', ], ], ], ], ], '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' => '项目解除实例关联', ], 'DeleteRenderingProject' => [ 'summary' => '删除一个云应用服务项目，有在线会话等业务调度数据的项目不允许删除。', 'path' => '', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvsGPC7NJ', ], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', ], ], ], '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', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '删除项目', ], 'StartRenderingSession' => [ 'summary' => '为请求端（ClientId）调度一个空闲云应用服务实例，并完成服务启动。'."\n" .'如果请求端（ClientId）启动请求发起成功后重复发起启动请求，若已关联会话处于启动暂停（SessionStartSuspended）状态，则重启会话；若会话为其他状态，则直接返回会话信息。', 'path' => '/', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvsGPC7NJ', ], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', ], ], [ 'name' => 'ClientId', 'in' => 'query', 'schema' => [ 'title' => '终端客户的唯一ID', 'description' => '终端客户的唯一ID', 'type' => 'string', 'required' => true, 'example' => '04c30850-1d91-4da1-b811-66d0ee94af7d', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '云应用ID', 'description' => '云应用ID', 'type' => 'string', 'required' => false, 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', ], ], [ 'name' => 'ClientParams', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '终端客户的参数信息', 'description' => '终端客户的参数信息', 'type' => 'object', 'properties' => [ 'ClientIp' => [ 'title' => '终端客户Ip，将默认用于位置就近实例调度', 'description' => '终端客户Ip，将默认用于位置就近实例调度', 'type' => 'string', 'required' => false, 'example' => '106.11.43.1', ], ], 'required' => false, ], ], [ 'name' => 'PatchId', 'in' => 'query', 'schema' => [ 'title' => '云应用补丁包ID。'."\n" .'1. 默认启动AppId稳定版本（未设置稳定Patch版本时，默认为原始版本）'."\n" .'2. 输入origin时，启动原始版本', 'description' => '云应用补丁包ID。'."\n" .'1. 默认启动AppId稳定版本（未设置稳定Patch版本时，默认为原始版本）'."\n" .'2. 输入origin时，启动原始版本', 'type' => 'string', 'required' => false, 'example' => 'patch-03fa76e8e13a49b63456b063dgh309b4', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'SessionId' => [ 'title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => 'session-i205217481741918129226', ], 'Hostname' => [ 'title' => '实例hostname,默认为出口Eip', 'description' => '实例hostname,默认为访问Eip', 'type' => 'string', 'example' => 'cn-xxx.ecr.aliyuncs.com', ], 'PortMappings' => [ 'title' => '端口映射信息', 'description' => '端口映射信息', 'type' => 'array', 'items' => [ 'description' => '端口映射信息', 'type' => 'object', 'properties' => [ 'ExternalPort' => [ 'title' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'description' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'type' => 'string', 'example' => '10013/10020', ], 'InternalPort' => [ 'title' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'description' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', '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', ], ], ], 'IsRepeatedRequest' => [ 'title' => '是否是重复请求', 'description' => '是否是重复请求', 'type' => 'boolean', 'example' => 'false', ], 'RenderingInstanceId' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], ], ], ], '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' => '启动会话', ], 'ListRenderingSessions' => [ 'summary' => '分页查询指定条件下的云应用服务会话列表。', 'description' => '## 请求说明'."\n" .'- 该接口支持通过多种参数组合来过滤和分页查询用户的渲染会话列表。'."\n" .'- `SessionId` 和 `ClientId` 参数至少需要提供一个，但两者都不是必选的。如果同时提供了两个参数，则将根据这两个参数进行更精确的匹配。'."\n", 'path' => '/', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvsGPC7NJ', ], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', ], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => [ 'title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'required' => false, 'example' => 'session-i205217481741918129226', ], ], [ 'name' => 'ClientId', 'in' => 'query', 'schema' => [ 'title' => '终端客户的唯一ID', 'description' => '终端客户的唯一ID', 'type' => 'string', 'required' => false, 'example' => 'ae7990f4-203d-494b-a5ea-e0babe9fa13d', ], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => [ 'title' => '云应用ID', 'description' => '云应用ID', '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' => '会话状态，取值范围，'."\n" .'1. SessionStarting：会话启动中'."\n" .'2. SessionStartSuspended：会话启动暂停，重新发起start可重试'."\n" .'3. SessionStarted：会话已启动/使用中'."\n" .'4. SessionStartFailed：会话启动失败'."\n" .'5. SessionAbnormal：会话启动成功后，出现状态异常'."\n" .'6. SessionStopping：会话停止中'."\n" .'7. SessionStopFailed：会话停止失败', 'type' => 'string', 'required' => false, 'example' => 'SessionStarting', 'enum' => [ 'SessionStarting', 'SessionStartSuspended', 'SessionStarted', 'SessionAbnormal', 'SessionStartFailed', 'SessionStopping', 'SessionStopFailed', ], ], ], [ 'name' => 'RenderingInstanceId', 'in' => 'query', 'schema' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'required' => false, 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '页码，起始值为1', 'description' => '页码，起始值为1', '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。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2025-03-25T02:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'description' => '时间区间筛选参数。按照ISO8601标准表示，并需要使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2025-03-31T22:20:00Z', ], ], [ 'name' => 'PatchId', 'in' => 'query', 'schema' => [ 'title' => '云应用补丁包ID。'."\n" .'1. 输入origin时，仅过滤启动了App原始版本的会话', 'description' => '云应用补丁包ID。'."\n" .'1. 输入origin时，仅过滤启动了App原始版本的会话', 'type' => 'string', 'required' => false, 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Sessions' => [ 'title' => '会话列表', 'description' => '会话列表', 'type' => 'array', 'items' => [ 'description' => '会话信息', 'type' => 'object', 'properties' => [ 'AppId' => [ 'title' => '云应用ID', 'description' => '云应用ID', 'type' => 'string', 'example' => 'cap-4e1a6a425495458ba78693b8ac6600ea', ], 'RenderingInstanceId' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-a10722fb84b243f6ba02a89a2e5c838d', ], 'StartTime' => [ 'title' => '启动时间', 'description' => '启动时间', 'type' => 'string', 'example' => '2024-07-04T01:23:00Z', ], 'ClientId' => [ 'title' => '终端客户端ID', 'description' => '终端客户端ID', 'type' => 'string', 'example' => 'fd6b2134-7954-4754-8915-5fb8b0469622', ], 'PatchId' => [ 'title' => '云应用补丁包ID。空值表示为原始版本', 'description' => '云应用补丁包ID。空值表示为原始版本', 'type' => 'string', 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', ], 'SessionId' => [ 'title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => 'session-i205217481741918129226', ], ], ], ], 'TotalCount' => [ 'title' => '匹配的会话总数', 'description' => '匹配的会话总数', 'type' => 'integer', 'format' => 'int64', 'example' => '8', ], ], ], ], ], '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' => '查询会话列表', ], 'DescribeRenderingSession' => [ 'summary' => '查询会话的详情信息，包含会话当前状态、网络访问IP/端口、云应用服务实例位置等信息。', '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' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', ], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => [ 'title' => '会话ID。SessionId/ClientId至少必选一项', 'description' => '会话ID。SessionId/ClientId至少必选一项', 'type' => 'string', 'required' => false, 'example' => 'session-i205217481741918129226', ], ], [ 'name' => 'ClientId', 'in' => 'query', 'schema' => [ 'title' => '终端客户的唯一ID。SessionId/ClientId至少必选一项', 'description' => '终端客户的唯一ID。SessionId/ClientId至少必选一项', 'type' => 'string', 'required' => false, 'example' => 'd27c89d6-4fe3-4855-a89c-ea721c708b0b', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'SessionId' => [ 'title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => 'session-i205217481741918129226', ], 'ClientId' => [ 'title' => '终端客户端ID', 'description' => '终端客户端ID', 'type' => 'string', 'example' => 'c91263a0-f9ac-45bd-bbe9-6e293ad32d91', ], 'AppId' => [ 'title' => '云应用ID', 'description' => '云应用ID', 'type' => 'string', 'example' => 'cap-b06b26edfhytbn b94a75ae1a79efc90eb', ], 'StartTime' => [ 'title' => '启动时间', 'description' => '启动时间', 'type' => 'string', 'example' => '2025-05-18T02:20:00Z', ], 'Hostname' => [ 'title' => '云应用服务实例域名/IP。默认该域名/IP相关信息将自动传递给边缘实例。', 'description' => '实例hostname，默认为访问Eip', 'type' => 'string', 'example' => '111.45.29.96', ], 'Isp' => [ 'title' => '运营商编码，取值范围：'."\n" .'1. cmcc'."\n" .'2. unicom'."\n" .'3. telecom', 'description' => '运营商编码，取值范围：'."\n" .'1. cmcc'."\n" .'2. unicom'."\n" .'3. telecom', 'type' => 'string', 'example' => 'telecom', ], 'PortMappings' => [ 'title' => '端口映射信息', 'description' => '端口映射信息', 'type' => 'array', 'items' => [ 'description' => '端口映射信息', 'type' => 'object', 'properties' => [ 'ExternalPort' => [ 'title' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'description' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'type' => 'string', 'example' => '10013/10020', ], 'InternalPort' => [ 'title' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'description' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'type' => 'string', 'example' => '49008/49015', ], ], ], ], 'StateInfo' => [ 'title' => '业务调度状态信息', 'description' => '会话状态信息', 'type' => 'object', 'properties' => [ 'State' => [ 'title' => '业务调度状态', 'description' => '会话状态，取值范围，'."\n" .'1. SessionStarting：会话启动中'."\n" .'2. SessionStartSuspended：会话启动暂停，重新发起start可重试'."\n" .'3. SessionStarted：会话已启动/使用中'."\n" .'4. SessionStartFailed：会话启动失败'."\n" .'5. SessionAbnormal：会话启动成功后，出现状态异常'."\n" .'6. SessionStopping：会话停止中'."\n" .'7. SessionStopFailed：会话停止失败', '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' => '云应用服务实例位置信息', 'type' => 'object', 'properties' => [ 'ProvinceCode' => [ 'title' => '云应用服务实例所属省份码', 'description' => '云应用服务实例所属省份码', 'type' => 'string', 'example' => '310000', ], ], ], 'AdditionalIngresses' => [ 'title' => '其他可选的入口网络信息', 'description' => '其他可选的入口网络信息', 'type' => 'array', 'items' => [ 'description' => '可选的入口网络信息', 'type' => 'object', 'properties' => [ 'PortMappings' => [ 'title' => '端口映射列表', 'description' => '端口映射列表', 'type' => 'array', 'items' => [ 'description' => '端口映射信息', 'type' => 'object', 'properties' => [ 'ExternalPort' => [ 'title' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'description' => '外网端口或端口段，如22。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'type' => 'string', 'example' => '11060/11079', ], 'InternalPort' => [ 'title' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'description' => '内网端口或端口段，端口与外网端口一一对应。若为端口段，以正斜线（/）隔开起始端口，例如 10/20。', 'type' => 'string', 'example' => '11060/11079', ], ], ], ], 'Isp' => [ 'title' => '运营商编码，取值范围：'."\n" .'1. cmcc'."\n" .'2. unicom'."\n" .'3. telecom', 'description' => '运营商编码，取值范围：'."\n" .'1. cmcc'."\n" .'2. unicom'."\n" .'3. telecom', 'type' => 'string', 'example' => 'unicom', ], 'Hostname' => [ 'title' => '云应用服务实例域名/IP', 'description' => '云应用服务实例域名/IP', 'type' => 'string', 'example' => '111.45.29.96', ], ], ], ], 'RenderingInstanceId' => [ 'title' => '云应用服务实例ID', 'description' => '云应用服务实例ID', 'type' => 'string', 'example' => 'render-9f8c57355d224ad7beaf95e145f22111', ], 'PatchId' => [ 'title' => '云应用补丁包ID。空值表示为原始版本', 'description' => '云应用补丁包ID。空值表示为原始版本', 'type' => 'string', 'example' => 'patch-03fa76e8e13a49b6a966b063d9d309b4', ], ], ], ], ], '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' => '查询会话信息', ], 'StopRenderingSession' => [ 'summary' => '关闭指定的云应用服务会话并回收相关实例资源。', 'description' => '## 请求说明'."\n", 'path' => '/', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREvsGPC7NJ', ], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', 'schema' => [ 'title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'required' => true, 'example' => 'project-422bc38dfgh5eb44149f135ef76304f63b', ], ], [ 'name' => 'SessionId', 'in' => 'query', 'schema' => [ 'title' => '会话ID。SessionId/ClientId至少必选一项', 'description' => '会话ID。SessionId/ClientId至少必选一项', 'type' => 'string', 'required' => false, 'example' => 'session-i205217481741918129226', ], ], [ 'name' => 'ClientId', 'in' => 'query', 'schema' => [ 'title' => '终端客户的唯一ID。SessionId/ClientId至少必选一项', 'description' => '终端客户的唯一ID。SessionId/ClientId至少必选一项', 'type' => 'string', 'required' => false, 'example' => '04c30850-1d91-4da1-b811-66d0ee94af7d', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求 ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '关闭会话', ], 'DescribeAccountStat' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '主账号ID。', 'type' => 'string', 'required' => false, 'example' => '1165*****601', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TemplateNum' => [ 'description' => '当前模板数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'GroupLimit' => [ 'description' => '最大设备空间数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'RequestId' => [ 'description' => '请求ID。', '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' => '1165*****601', ], ], ], ], ], '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' => '查询账号状态', 'summary' => '查询某个账号在指定地域下的所有资源信息。', ], 'DescribeVsUserResourcePackage' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], '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', ], ], ], ], ], ], ], ], ], ], 'responseDemo' => '', ], 'OpenVsService' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OrderId' => [ 'description' => '订单ID。', 'type' => 'string', 'example' => '150275784', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"150275784\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '开通服务', 'summary' => '开通服务。', ], 'CreateGroup' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '空间名称', 'type' => 'string', 'required' => true, 'example' => '我的视频监控', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '空间描述', 'type' => 'string', 'required' => false, 'example' => '我的视频监控', ], ], [ 'name' => 'App', 'in' => 'query', 'schema' => [ 'description' => '空间使用的应用名称，默认取值：live', 'type' => 'string', 'required' => false, 'example' => 'live', ], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => '空间所属区域，即服务中心', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], [ 'name' => 'InProtocol', 'in' => 'query', 'schema' => [ 'description' => '空间使用的接入协议，取值：'."\n" .'- gb28181'."\n" .'- rtmp', 'type' => 'string', 'required' => true, 'example' => 'rtmp', ], ], [ 'name' => 'OutProtocol', 'in' => 'query', 'schema' => [ 'description' => '空间使用的播放协议，多值用逗号分隔，取值：'."\n" .'- flv'."\n" .'- hls'."\n" .'- rtmp', 'type' => 'string', 'required' => false, 'example' => 'flv,rtmp', ], ], [ 'name' => 'PushDomain', 'in' => 'query', 'schema' => [ 'description' => '空间使用的推流域名', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'PlayDomain', 'in' => 'query', 'schema' => [ 'description' => '空间使用的播流域名', 'type' => 'string', 'required' => false, 'example' => 'demo.aliyundoc.com', ], ], [ 'name' => 'LazyPull', 'in' => 'query', 'schema' => [ 'description' => '是否启用按需拉流。取值：'."\n" .'- false（默认）'."\n" .'- true', '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' => [ 'GbId' => [ 'description' => '空间关联的国标Id。（仅适用于国标接入的空间）', 'type' => 'string', 'example' => '31000000****00000001', ], 'GbIp' => [ 'description' => '空间关联的国标信令网关服务器地址。（仅适用于国标接入的空间）', 'type' => 'string', 'example' => '10.10.10.10', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'GbPort' => [ 'description' => '空间提供的国标信令服务器端口。（仅适用于国标接入的空间）', 'type' => 'integer', 'format' => 'int64', 'example' => '5060', ], 'Id' => [ 'description' => '空间Id', 'type' => 'string', 'example' => '33763****77224964-cn-qingdao', ], ], ], ], ], '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' => '创建业务空间', 'summary' => '创建新业务空间。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteGroup' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '空间Id', 'type' => 'string', 'required' => true, 'example' => '33763950751395843', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => 'Request Id', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '删除业务空间', 'summary' => '删除业务空间。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyGroup' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '空间ID。', 'type' => 'string', 'required' => true, 'example' => '32388487739092994-cn-qingdao', ], ], [ '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' => '空间使用的接入协议。取值：'."\n" .'- gb28181'."\n" .'- rtmp', 'type' => 'string', 'required' => false, 'example' => 'gb28181', ], ], [ 'name' => 'OutProtocol', 'in' => 'query', 'schema' => [ 'description' => '空间使用的播放协议，多值用逗号分隔。取值：'."\n" .'- flv'."\n" .'- hls'."\n" .'- rtmp', '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' => '空间使用的推流域名。（仅限于rtmp接入的空间）', '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' => '是否启用按需拉流。取值：'."\n" .'- false（默认）'."\n" .'- true', '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' => '空间ID。', 'type' => 'string', 'example' => '32388487739092994-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"32388487739092994-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '修改业务空间', 'summary' => '修改空间信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGroup' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '空间ID。', 'type' => 'string', 'required' => true, 'example' => '337639*****224964-cn-qingdao', ], ], [ 'name' => 'IncludeStats', 'in' => 'query', 'schema' => [ 'description' => '是否返回空间设备统计信息，默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ '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' => '请求ID。', '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' => '空间使用的接入协议，取值范围：'."\n" .'- gb28181'."\n" .'- rtmp', 'type' => 'string', 'example' => 'gb28181', ], 'OutProtocol' => [ 'description' => '空间使用的播放协议，取值范围：'."\n" .'- flv'."\n" .'- hls'."\n" .'- rtmp'."\n" .'> 支持多个，用英文逗号（,）分隔。', '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' => '空间关联的国标信令服务器端口。'."\n" .'> 仅适用于使用国标协议接入的空间。', 'type' => 'integer', 'format' => 'int64', 'example' => '5060', ], 'GbId' => [ 'description' => '空间关联的国标ID。'."\n" .'> 仅适用于使用国标协议接入的空间。', 'type' => 'string', 'example' => '3100000*****0000001', ], 'GbIp' => [ 'description' => '空间关联的国标信令服务器IP地址。'."\n" .'> 仅适用于使用国标协议接入的空间。', 'type' => 'string', 'example' => '10.10.10.10', ], 'AliasId' => [ 'description' => '空间ID别名。', 'type' => 'string', 'example' => '337639*****24964-cn-qingdao', ], 'Id' => [ 'description' => '空间ID。', 'type' => 'string', 'example' => '337639****224964-cn-qingdao', ], 'GbTcpPorts' => [ 'description' => '空间提供的国标信令服务器TCP端口。'."\n" .'> 仅适用于使用国标协议接入的空间。', 'type' => 'array', 'items' => [ 'description' => '空间提供的国标信令服务器TCP端口。'."\n" .'> 仅适用于使用国标协议接入的空间。', 'type' => 'string', 'example' => '[6060, 6160]', ], ], 'GbUdpPorts' => [ 'description' => '空间提供的国标信令服务器UDP端口。'."\n" .'> 仅适用于使用国标协议接入的空间。', 'type' => 'array', 'items' => [ 'description' => '空间提供的国标信令服务器UDP端口。'."\n" .'> 仅适用于使用国标协议接入的空间。', 'type' => 'string', 'example' => '['."\n" .' 5060,'."\n" .' 5160'."\n" .']', ], ], 'Stats' => [ 'description' => '空间内设备的统计信息。', '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', ], ], ], ], ], ], ], '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":""}]', 'title' => '查询业务空间', 'summary' => '获取空间信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeGroups' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '空间ID。', 'type' => 'string', 'required' => false, 'example' => '33763950877224964-cn-qingdao', ], ], [ 'name' => 'Name', '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' => '空间使用的接入协议。取值范围：'."\n" .'- gb28181'."\n" .'- rtmp', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'rtmp' => 'rtmp', 'gb28181' => 'gb28181', ], 'example' => 'rtmp', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '空间状态。取值范围：'."\n" .'- on（已启用）'."\n" .'- off（已停用）', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'off' => '已停用', 'on' => '已启用', ], 'example' => 'on', ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => '按字段排序。取值范围：'."\n" .'- Id（默认）', 'type' => 'string', 'required' => false, 'example' => 'Id', ], ], [ 'name' => 'SortDirection', 'in' => 'query', 'schema' => [ 'description' => '排序方式。取值范围：'."\n" .'- asc（升序）（默认值）'."\n" .'- desc（降序）', 'type' => 'string', 'required' => false, 'example' => 'asc', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几页。默认：1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'IncludeStats', 'in' => 'query', 'schema' => [ 'description' => '是否返回空间设备统计信息。默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => '第几个分页。', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'PageSize' => [ 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'TotalCount' => [ 'description' => '空间总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '200', ], 'PageCount' => [ 'description' => '分页总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'Groups' => [ 'description' => '空间列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '空间状态。取值范围：'."\n" .'- on（已启用）'."\n" .'- off（已停用）', 'type' => 'string', 'example' => 'on', ], 'LazyPull' => [ 'description' => '是否启用按需拉流。', 'type' => 'boolean', 'example' => 'false', ], 'PlayDomain' => [ 'description' => '空间使用的播流域名。', 'type' => 'string', 'example' => 'demo.aliyundoc.com', ], 'GbPort' => [ 'description' => '空监关联的国标信令服务器端口。'."\n" ."\n" .'> 仅适用于使用国标协议接入的空间。', 'type' => 'integer', 'format' => 'int64', 'example' => '5060', ], 'Callback' => [ 'description' => '空间内设备状态更新时的回调。', 'type' => 'string', 'example' => 'http://example.com/callback', ], 'GbId' => [ 'description' => '空间提供的国标ID。'."\n" ."\n" .'> 仅适用于使用国标协议接入的空间。', 'type' => 'string', 'example' => '31000000000000000001', ], 'GbIp' => [ 'description' => '空间提供的国标信令服务器地址。'."\n" ."\n" .'> 仅适用于使用国标协议接入的空间。', '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' => '空间ID别名。', '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' => '空间ID。', 'type' => 'string', 'example' => '33763950877224964-cn-qingdao', ], 'GbTcpPorts' => [ 'type' => 'array', 'items' => [ 'description' => '空间提供的国标信令服务器TCP端口。'."\n" ."\n" .'> 仅适用于使用国标协议接入的空间。', 'type' => 'string', 'example' => '[6060,6160]', ], ], 'GbUdpPorts' => [ 'type' => 'array', 'items' => [ 'description' => '空间提供的国标信令服务器UDP端口。'."\n" ."\n" .'> 仅适用于使用国标协议接入的空间。', 'type' => 'string', 'example' => '[5060,5160]', ], ], 'Stats' => [ 'description' => '空间设备统计信息。', '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', ], ], ], ], ], ], ], ], ], ], '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":""}]', 'title' => '查询空间列表', 'summary' => '查询空间列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateDevice' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '设备名称。', 'type' => 'string', 'required' => false, 'example' => 'xxx路口摄像头', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '设备描述。', 'type' => 'string', 'required' => false, 'example' => 'xxx路口摄像头', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => '设备所属空间ID。', 'type' => 'string', 'required' => true, 'example' => '348*****174-cn-qingdao', ], ], [ 'name' => 'ParentId', 'in' => 'query', 'schema' => [ 'description' => '上级设备ID，比如：摄像头所属的平台ID。', 'type' => 'string', 'required' => false, 'example' => '399*****774-cn-qingdao', ], ], [ 'name' => 'DirectoryId', 'in' => 'query', 'schema' => [ 'description' => '设备所属目录ID。', 'type' => 'string', 'required' => false, 'example' => '399*****488-cn-qingdao', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '设备类型。取值范围：'."\n" .'- ipc（摄像头）'."\n" .'- platform（平台）'."\n" .'- ied（智能设备）', 'type' => 'string', 'required' => true, 'example' => 'ipc', ], ], [ 'name' => 'AutoStart', 'in' => 'query', 'schema' => [ 'description' => '是否自动启动流，默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'GbId', 'in' => 'query', 'schema' => [ 'description' => '设备国标ID。'."\n" .'> 仅适用于国标协议。', 'type' => 'string', 'required' => false, 'example' => '31000000****00000002', ], ], [ 'name' => 'Ip', 'in' => 'query', 'schema' => [ 'description' => '设备IP。', 'type' => 'string', 'required' => false, 'example' => '10.10.10.10', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => '设备端口。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8080', ], ], [ 'name' => 'Url', 'in' => 'query', 'schema' => [ 'description' => '设备上的流URL。', 'type' => 'string', 'required' => false, 'example' => 'rtmp://xxx/xxx', ], ], [ 'name' => 'Username', 'in' => 'query', 'schema' => [ 'description' => '设备用户名。', 'type' => 'string', 'required' => false, 'example' => 'admin', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '设备密码。', 'type' => 'string', 'required' => false, 'example' => 'admin', ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => '设备厂商。', 'type' => 'string', 'required' => false, 'example' => '公司A', ], ], [ 'name' => 'Dsn', 'in' => 'query', 'schema' => [ 'description' => '设备序列号。', 'type' => 'string', 'required' => false, 'example' => '7D0*****4C0', ], ], [ 'name' => 'Longitude', 'in' => 'query', 'schema' => [ 'description' => '设备经度。', 'type' => 'string', 'required' => false, 'example' => '45.00', ], ], [ 'name' => 'Latitude', 'in' => 'query', 'schema' => [ 'description' => '设备维度。', 'type' => 'string', 'required' => false, 'example' => '119.20', ], ], [ 'name' => 'AutoPos', 'in' => 'query', 'schema' => [ 'description' => '是否启用设备位置订阅，默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'PosInterval', 'in' => 'query', 'schema' => [ 'description' => '位置订阅周期，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', ], ], [ 'name' => 'AlarmMethod', 'in' => 'query', 'schema' => [ 'description' => '订阅的国标报警方式。取值范围：'."\n" .'- 0（全部）'."\n" .'- 5（视频报警）'."\n" .'- 7（其他报警）'."\n" ."\n" .'> - 空值表示不订阅。'."\n" .'> - 支持多个，用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => [ 'description' => '设备其他参数，格式为JSON序列化的字符串。', 'type' => 'string', 'required' => false, 'example' => '{}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '添加设备', 'summary' => '添加新的设备。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteDevice' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '3238848****092996', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '删除设备', 'summary' => '删除空间下的设备。', ], 'BatchDeleteDevices' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID，多值用逗号分隔。', 'type' => 'string', 'required' => true, 'example' => '32388****39092996', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID。', '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' => '设备ID。', 'type' => 'string', 'example' => '323884****9092996', ], ], ], ], ], ], ], ], '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' => '批量删除设备', 'summary' => '批量删除设备。', ], 'ModifyDevice' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '设备名称。', 'type' => 'string', 'required' => false, 'example' => 'xxx路口摄像头', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '设备描述。', 'type' => 'string', 'required' => false, 'example' => 'xxx路口摄像头', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => '空间ID。', 'type' => 'string', 'required' => false, 'example' => '348*****174-cn-qingdao', ], ], [ 'name' => 'ParentId', 'in' => 'query', 'schema' => [ 'description' => '父设备ID。', 'type' => 'string', 'required' => false, 'example' => '399*****774-cn-qingdao', ], ], [ 'name' => 'DirectoryId', 'in' => 'query', 'schema' => [ 'description' => '设备所属目录ID。', 'type' => 'string', 'required' => false, 'example' => '399*****488-cn-qingdao', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '设备类型。取值范围：'."\n" .'- ipc（摄像头）'."\n" .'- platform（平台）'."\n" .'- ied（智能设备）', 'type' => 'string', 'required' => false, 'example' => 'ipc', ], ], [ 'name' => 'AutoStart', 'in' => 'query', 'schema' => [ 'description' => '是否自动启动流，默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'GbId', 'in' => 'query', 'schema' => [ 'description' => '设备国标ID。'."\n" .'> 仅适用于国标协议。', 'type' => 'string', 'required' => false, 'example' => '3100000****000000002', ], ], [ 'name' => 'Ip', 'in' => 'query', 'schema' => [ 'description' => '设备IP地址。', 'type' => 'string', 'required' => false, 'example' => '10.10.10.10', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => '设备端口。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8080', ], ], [ 'name' => 'Url', 'in' => 'query', 'schema' => [ 'description' => '设备上的流URL。', 'type' => 'string', 'required' => false, 'example' => 'rtmp://xxx/xxx', ], ], [ 'name' => 'Username', 'in' => 'query', 'schema' => [ 'description' => '设备用户名。', 'type' => 'string', 'required' => false, 'example' => 'admin', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '设备密码。', 'type' => 'string', 'required' => false, 'example' => 'admin', ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => '设备厂商。', 'type' => 'string', 'required' => false, 'example' => '公司A', ], ], [ 'name' => 'Longitude', 'in' => 'query', 'schema' => [ 'description' => '设备经度。', 'type' => 'string', 'required' => false, 'example' => '45.00', ], ], [ 'name' => 'Latitude', 'in' => 'query', 'schema' => [ 'description' => '设备维度。', 'type' => 'string', 'required' => false, 'example' => '119.20', ], ], [ 'name' => 'AutoPos', 'in' => 'query', 'schema' => [ 'description' => '是否启用设备位置订阅，默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'PosInterval', 'in' => 'query', 'schema' => [ 'description' => '位置订阅周期，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', ], ], [ 'name' => 'AlarmMethod', 'in' => 'query', 'schema' => [ 'description' => '订阅的国标报警方式。取值范围：'."\n" .'- 0（全部）'."\n" .'- 5（视频报警）'."\n" .'- 7（其他报警）'."\n" .'> - 空值表示不订阅。'."\n" .'> - 支持多个，用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => '0', ], ], [ 'name' => 'Params', 'in' => 'query', 'schema' => [ 'description' => '设备其他参数，格式为JSON序列化的字符串。', 'type' => 'string', 'required' => false, 'example' => '{}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '修改设备', 'summary' => '修改设备信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDevice' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '3238848****092996-cn-qingdao', ], ], [ 'name' => 'IncludeStats', 'in' => 'query', 'schema' => [ 'description' => '是否返回流统计信息，默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'IncludeDirectory', 'in' => 'query', 'schema' => [ 'description' => '是否返回目录信息，默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '设备类型。取值范围：'."\n" .'- ipc（摄像头）'."\n" .'- platform（平台）'."\n" .'- ied（智能设备）', 'type' => 'string', 'example' => 'ipc', ], 'Status' => [ 'description' => '设备状态。取值范围：'."\n" .'- on（在线）'."\n" .'- off（离线）'."\n" .'- failed（锁定）'."\n" .'- new（未注册）', 'type' => 'string', 'example' => 'on', ], 'AlarmMethod' => [ 'description' => '订阅的国标报警方式。取值范围：'."\n" .'- 0（全部）'."\n" .'- 5（视频报警）'."\n" .'- 7（其他报警）'."\n" .'> - 空值表示不订阅。'."\n" .'> - 支持多个，用英文逗号（,）分隔。', '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' => '上级设备ID，比如：摄像头所属的平台ID。', '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' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Description' => [ 'description' => '设备描述。', 'type' => 'string', 'example' => 'xxx路口摄像头', ], 'Enabled' => [ 'description' => '设备是否启用。', 'type' => 'boolean', 'example' => 'true', ], 'Name' => [ 'description' => '设备名称。', 'type' => 'string', 'example' => 'xxx路口摄像头', ], 'ChannelSyncTime' => [ 'description' => '通道同步时间。', 'type' => 'string', 'example' => '2019-02-28T17:01:17Z', ], 'CreatedTime' => [ 'description' => '设备创建时间。', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', ], 'DirectoryId' => [ 'description' => '目录ID。', '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' => '设备IP。', 'type' => 'string', 'example' => '10.10.10.10', ], 'Url' => [ 'description' => '设备上的流URL。', 'type' => 'string', 'example' => 'rtmp://xxx/xxx', ], 'AutoStart' => [ 'description' => '是否自动启动流。', 'type' => 'boolean', 'example' => 'false', ], 'Vendor' => [ 'description' => '设备厂商。', 'type' => 'string', 'example' => '公司A', ], 'GbId' => [ 'description' => '设备国标ID。'."\n" .'> 仅适用于国标协议。', 'type' => 'string', 'example' => '31000000****00000002', ], 'GroupId' => [ 'description' => '设备所属空间ID。', 'type' => 'string', 'example' => '3238848****092994-cn-qingdao', ], 'Longitude' => [ 'description' => '设备经度。', 'type' => 'string', 'example' => '45.00', ], 'Latitude' => [ 'description' => '设备维度。', 'type' => 'string', 'example' => '119.20', ], 'Id' => [ 'description' => '设备ID。', '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' => '上级目录ID。', 'type' => 'string', 'example' => '3238848****092995-cn-qingdao', ], 'Description' => [ 'description' => '目录描述。', 'type' => 'string', 'example' => '目录1', ], 'GroupId' => [ 'description' => '目录所属空间ID。', 'type' => 'string', 'example' => '3238848****092994-cn-qingdao', ], 'Name' => [ 'description' => '目录名称。', 'type' => 'string', 'example' => '目录1', ], 'CreatedTime' => [ 'description' => '目录创建时间。', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', ], 'Id' => [ 'description' => '目录ID。', 'type' => 'string', 'example' => '3238848****092994-cn-qingdao', ], ], ], ], ], ], ], '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":""}]', 'title' => '查询设备', 'summary' => '查询设备信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDevices' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。'."\n" .'> 支持多个，用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '设备名称。'."\n" .'> 支持多个，用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => '摄像头A', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '按设备类型查询。取值范围：'."\n" .'- ipc（摄像头）'."\n" .'- platform（平台）'."\n" .'- ied（智能设备）', 'type' => 'string', 'required' => false, 'example' => 'ipc', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => '按设备所属空间ID查询。', 'type' => 'string', 'required' => false, 'example' => '348*****174-cn-qingdao', ], ], [ 'name' => 'ParentId', 'in' => 'query', 'schema' => [ 'description' => '按设备所属上级设备ID查询。', 'type' => 'string', 'required' => false, 'example' => '399*****774-cn-qingdao', ], ], [ 'name' => 'DirectoryId', 'in' => 'query', 'schema' => [ 'description' => '按设备所属目录ID查询。', 'type' => 'string', 'required' => false, 'example' => '399*****488-cn-qingdao', ], ], [ 'name' => 'GbId', 'in' => 'query', 'schema' => [ 'description' => '按设备国标ID查询。', 'type' => 'string', 'required' => false, 'example' => '310000000****0000002', ], ], [ 'name' => 'Dsn', 'in' => 'query', 'schema' => [ 'description' => '设备序列号，唯一标识。', 'type' => 'string', 'required' => false, 'example' => '7D0*****4C0', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '按设备状态查询。', 'type' => 'string', 'required' => false, 'example' => 'on', ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => '按设备厂商查询。', 'type' => 'string', 'required' => false, 'example' => '8yd*****qem', ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => '按给定字段排序。取值：'."\n" .'> id（默认）', 'type' => 'string', 'required' => false, 'example' => 'id', ], ], [ 'name' => 'SortDirection', 'in' => 'query', 'schema' => [ 'description' => '排序方式。取值范围：'."\n" .'- asc（升序）（默认）'."\n" .'- desc（降序）', 'type' => 'string', 'required' => false, 'example' => 'asc', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页大小，默认值：20。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几个分页，默认值：1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'IncludeStats', 'in' => 'query', 'schema' => [ 'description' => '是否返回流统计信息，默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'IncludeDirectory', 'in' => 'query', 'schema' => [ 'description' => '是否返回目录信息，默认值：false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => '第几个分页。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'RequestId' => [ 'description' => '请求ID。', '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' => '设备类型。取值范围：'."\n" .'- ipc（摄像头）'."\n" .'- platform（平台）'."\n" .'- ied（智能设备）', 'type' => 'string', 'example' => 'ipc', ], 'Status' => [ 'description' => '设备状态。取值范围：'."\n" .'- on（在线）'."\n" .'- off（离线）'."\n" .'- failed（锁定）'."\n" .'- new（未注册）', 'type' => 'string', 'example' => 'on', ], 'AlarmMethod' => [ 'description' => '订阅的国标报警方式。取值范围：'."\n" .'- 0（全部）'."\n" .'- 5（视频报警）'."\n" .'- 7（其他报警）'."\n" .'> - 空值表示不订阅。'."\n" .'> - 支持多个，用英文逗号（,）分隔。', 'type' => 'string', 'example' => '0', ], 'Dsn' => [ 'description' => '设备序列号。'."\n" .'> 仅适用于AUVSP、ODCAP协议。', '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' => '上级设备ID，比如：摄像头所属的平台ID。', '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' => 'xxx路口摄像头', ], 'Enabled' => [ 'description' => '是否启用设备。', 'type' => 'boolean', 'example' => 'true', ], 'Name' => [ 'description' => '设备名称。', 'type' => 'string', 'example' => 'xxx路口摄像头', ], 'ChannelSyncTime' => [ 'description' => '通道同步时间。', 'type' => 'string', 'example' => '2019-02-28T17:01:17Z', ], 'CreatedTime' => [ 'description' => '设备创建时间。', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', ], 'DirectoryId' => [ 'description' => '目录ID。', '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' => '设备IP。', 'type' => 'string', 'example' => '10.10.10.10', ], 'Url' => [ 'description' => '设备上的流URL。', 'type' => 'string', 'example' => 'rtmp://xxx/xxx', ], 'AutoStart' => [ 'description' => '是否自动启动流。', 'type' => 'boolean', 'example' => 'false', ], 'Vendor' => [ 'description' => '设备厂商。', 'type' => 'string', 'example' => '公司A', ], 'GbId' => [ 'description' => '设备国标ID。'."\n" .'> 仅适用于国标协议。', 'type' => 'string', 'example' => '310000000****0000002', ], 'GroupId' => [ 'description' => '设备所属空间ID。', 'type' => 'string', 'example' => '348*****174-cn-qingdao', ], 'Longitude' => [ 'description' => '设备经度。', 'type' => 'string', 'example' => '45.00', ], 'Latitude' => [ 'description' => '设备维度。', 'type' => 'string', 'example' => '119.20', ], 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'Username' => [ 'description' => '设备用户名。', 'type' => 'string', 'example' => 'admin', ], 'Stats' => [ 'description' => '设备流统计信息。', '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', ], ], ], 'Directory' => [ 'description' => '目录信息。', 'type' => 'object', 'properties' => [ 'ParentId' => [ 'description' => '上级目录ID。', 'type' => 'string', 'example' => '399*****774-cn-qingdao', ], 'Description' => [ 'description' => '目录描述。', 'type' => 'string', 'example' => '目录1', ], 'GroupId' => [ 'description' => '目录所属空间ID。', 'type' => 'string', 'example' => '348*****174-cn-qingdao', ], 'Name' => [ 'description' => '目录名称。', 'type' => 'string', 'example' => '目录1', ], 'CreatedTime' => [ 'description' => '目录创建时间。', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', ], 'Id' => [ 'description' => '目录ID。', 'type' => 'string', 'example' => '399*****488-cn-qingdao', ], ], ], ], ], ], ], ], ], ], '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":""}]', 'title' => '查询设备列表', 'summary' => '查询设备列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SyncCatalogs' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '3238****739092996-cn-shenzhen', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '3238****739092996-cn-shenzhen', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '同步平台通道', 'summary' => '同步平台通道信息。', ], 'UnlockDevice' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID', 'type' => 'string', 'required' => true, 'example' => '323884****9092996', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID', 'type' => 'string', 'example' => '323884****9092996', ], 'RequestId' => [ 'description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"323884****9092996\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '解锁设备', 'summary' => '解锁设备。', ], 'StartDevice' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '323884****9092996', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '323884****9092996', ], 'RequestId' => [ 'description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"323884****9092996\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '启动设备', 'summary' => '启动设备拉流，会启动设备上的所有流。', 'description' => '目前每个设备仅支持单路流，效果等同于StartStream。', ], 'StopDevice' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '流重启触发时间。', 'type' => 'string', 'required' => false, 'example' => '2021-12-10T10:00:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'RequestId' => [ 'description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '停止设备', 'summary' => '停止设备拉流，会停止设备上的所有流。', 'description' => '停止设备拉流，会停止设备上的所有流。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'BatchStartDevices' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID，多值用逗号分隔。', 'type' => 'string', 'required' => true, 'example' => '32388487****92996-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Results' => [ 'description' => '结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', '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' => '流ID。', 'type' => 'string', 'example' => '3238848****092997-cn-qingdao', ], ], ], ], ], ], ], ], ], ], ], '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' => '批量启动设备', 'summary' => '批量启动设备拉流。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'BatchStopDevices' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID，多值用逗号分隔。', 'type' => 'string', 'required' => true, 'example' => '32388487****92996', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '流重启触发时间。', 'type' => 'string', 'required' => false, 'example' => '2021-10-14T23:00:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Results' => [ 'description' => '结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', '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' => '流ID。', 'type' => 'string', 'example' => '323884****9092997', ], ], ], ], ], ], ], ], ], ], ], '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' => '批量停止设备', 'summary' => '批量停止设备拉流。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateDeviceAlarm' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '通道ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12', ], ], [ 'name' => 'ObjectType', 'in' => 'query', 'schema' => [ 'description' => '媒体对象类型。取值：'."\n" .'- 0（无）'."\n" .'- 1（JPEG图片）'."\n" .'- 2（视频）'."\n" .'- 3（GIF图片）', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', ], ], [ 'name' => 'Alarm', 'in' => 'query', 'schema' => [ 'description' => '告警类型。取值：'."\n" ."\n" .'- 0（其他）'."\n" .'- 1（运动检测告警）'."\n" .'- 2（智能告警）'."\n" .'- 3（开关量告警）'."\n" .'- 4（视频丢失告警）', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], [ 'name' => 'SubAlarm', 'in' => 'query', 'schema' => [ 'description' => '告警子类型。', 'type' => 'integer', 'format' => 'int32', 'required' => true, ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '起始时间点。（单位：毫秒）', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1632121707000', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间点。（单位：毫秒）', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1632314789000', ], ], [ 'name' => 'Expire', 'in' => 'query', 'schema' => [ 'description' => '媒体上传URL的过期时间。（单位：秒，默认60秒）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Url' => [ 'description' => '媒体上传的URL，可使用PUT上传。', 'type' => 'string', 'example' => 'rtmp://demo.aliyundoc.com/live/310101*****7542007?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e', ], 'AlarmId' => [ 'description' => '告警ID。', 'type' => 'string', 'example' => '0hyNgTdgv2D000195842', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '76E11E6A-4441-51C9-AF60-D354362257A7', ], 'Expire' => [ 'description' => 'URL的过期时长。（单位：秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '3600', ], 'AlarmDelay' => [ 'description' => '下次相同告警的最小间隔。（单位：秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '60', ], ], ], ], ], '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' => '创建设备告警', 'summary' => '上报设备告警。', ], 'ModifyDeviceAlarm' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => [ 'description' => '通道ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', ], ], [ 'name' => 'AlarmId', 'in' => 'query', 'schema' => [ 'description' => '告警ID。', 'type' => 'string', 'required' => true, 'example' => '0dGo7jLwwf1000296232', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '告警状态。取值：'."\n" ."\n" .'- 1（上传完成）'."\n" .'- 2（上传失败）'."\n" .'- 3（一般错误）', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '修改设备报警', 'summary' => '更新设备告警状态。', ], 'ModifyDeviceCapture' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'Image', 'in' => 'query', 'schema' => [ 'description' => '抓图控制。取值：'."\n" .'- 0（关闭）'."\n" .'- 1（开启）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], [ 'name' => 'Video', 'in' => 'query', 'schema' => [ 'description' => '视频录制控制。取值：'."\n" .'- 0（关闭）'."\n" .'- 1（开启短录制）'."\n" .'- 2（开启长录制）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '修改设备捕获', 'summary' => '修改设备图传配置。', ], 'ModifyDeviceChannels' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'Dsn', 'in' => 'query', 'schema' => [ 'description' => '设备序列号。', 'type' => 'string', 'required' => false, 'example' => '210235C3GN32090008286cf17e130d', ], ], [ 'name' => 'DeviceStatus', 'in' => 'query', 'schema' => [ 'description' => '设备状态。取值：'."\n" .'- on（在线）'."\n" .'- off（离线）', 'type' => 'string', 'required' => false, 'example' => 'on', ], ], [ 'name' => 'Channels', 'in' => 'query', 'schema' => [ 'description' => 'Channel数组，JSON格式字符串。', 'type' => 'string', 'required' => true, 'example' => '[{"ChannelId":12333,"Name":"测试","DeviceStatus":"on"}]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '8F4D95B6-EB19-5245-AD77-95EDA83E53B7', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F4D95B6-EB19-5245-AD77-95EDA83E53B7\\"\\n}","type":"json"}]', 'title' => '修改设备通道', 'summary' => '更新设备通道列表。', 'requestParamsDescription' => '### Channel类型'."\n" ."\n" .'| 参数 | 类型 | 必要 | 描述 |'."\n" .'|-------------|------|-----|------|'."\n" .'|ChannelId |Long |是|通道ID。|'."\n" .'|Name |String|否|通道名称。|'."\n" .'|DeviceStatus |String|否|设备状态。取值范围：

• on（在线）
• off（离线）

|'."\n" .'|Params |String|否|设备其他参数，JSON格式字符串。|', ], 'DescribeDeviceChannels' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '按设备ID查询', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页大小，默认为20', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几个分页，默认为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => '第几个分页', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '分页大小', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'RequestId' => [ 'description' => '该条任务请求ID。', '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' => '国标ID', 'type' => 'string', 'example' => '3100000****000000002', ], 'Params' => [ 'description' => '设备其它配置。', 'type' => 'string', 'example' => '{}', ], 'DeviceId' => [ 'description' => '设备ID', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'ChannelId' => [ 'description' => '通道ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '0', ], 'DeviceStatus' => [ 'description' => '设备状态', 'type' => 'string', 'example' => 'on', ], 'Name' => [ 'description' => '通道名称', 'type' => 'string', 'example' => '通道1', ], 'StreamId' => [ 'description' => '流ID', 'type' => 'string', 'example' => '323*****997-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '查询设备通道列表', 'summary' => '查询设备通道列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeDeviceGateway' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '24611****70597051-cn-beijing', ], ], [ 'name' => 'ClientIp', 'in' => 'query', 'schema' => [ 'description' => '客户端的IP地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.0.1', ], ], [ 'name' => 'Expire', 'in' => 'query', 'schema' => [ 'description' => '过期时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', ], ], ], 'responses' => [ 200 => [ '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' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Port' => [ 'description' => '端口号。', 'type' => 'integer', 'format' => 'int64', 'example' => '8080', ], 'Protocol' => [ 'description' => '设备注册协议。', 'type' => 'string', 'example' => 'gb28181', ], ], ], ], ], '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"}]', 'title' => '查询设备网关', 'summary' => '查询设备网关。', ], 'DescribeDeviceURL' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'Stream', 'in' => 'query', 'schema' => [ 'description' => '流名。', 'type' => 'string', 'required' => true, 'example' => 'live001', ], ], [ 'name' => 'OutProtocol', 'in' => 'query', 'schema' => [ 'description' => '流协议。取值：'."\n" .'- rtmp'."\n" .'- flv'."\n" .'- hls'."\n" .'> 模式为推流时，仅支持rtmp', 'type' => 'string', 'required' => true, 'example' => 'rtmp', ], ], [ 'name' => 'Mode', 'in' => 'query', 'schema' => [ 'description' => '流模式。取值：'."\n" .'- play（播放）'."\n" .'- push（推流）', 'type' => 'string', 'required' => false, 'example' => 'push', 'default' => 'play', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'live', ], ], [ 'name' => 'Auth', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => false, 'default' => 'true', ], ], [ 'name' => 'Expire', 'in' => 'query', 'schema' => [ 'description' => '鉴权有效时长，单位：秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Url' => [ 'description' => '流的URL。', 'type' => 'string', 'example' => 'rtmp://demo.aliyundoc.com/live/live001?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'ExpireTime' => [ 'description' => 'URL过期时间点。 '."\n" .'unix时间戳，单位：秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1639130258', ], ], ], ], ], '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' => '查询设备URL', 'summary' => '查询设备流的URL信息。', ], 'DescribePurchasedDevice' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '3614*****66212-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '设备类型。取值：'."\n" .'- ipc（摄像头）'."\n" .'- platform（平台）'."\n" .'- ied（智能设备）', 'type' => 'string', 'example' => 'ipc', ], 'SubType' => [ 'description' => '设备子类型。取值：'."\n" .'- bullet（枪机）'."\n" .'- dome（球机）'."\n" .'- ptz（PTZ）', 'type' => 'string', 'example' => 'dome', ], 'Vendor' => [ 'description' => '设备厂商。', 'type' => 'string', 'example' => '8yd*****qem', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Description' => [ 'description' => '设备描述。', 'type' => 'string', 'example' => 'xxx路口摄像头', ], 'RegisterCode' => [ 'description' => '设备注册码。', 'type' => 'string', 'example' => '12345*****67890', ], 'GroupId' => [ 'description' => '空间ID。', 'type' => 'string', 'example' => '348*****174-cn-qingdao', ], 'GroupName' => [ 'description' => '空间名称。', 'type' => 'string', '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' => '设备ID。', 'type' => 'string', 'example' => '33763****77224964-cn-qingdao', ], 'OrderId' => [ 'description' => '订单ID。', 'type' => 'string', 'example' => '2117*****0447', ], ], ], ], ], '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"}]', 'title' => '查询已购买设备', 'summary' => '查询已购买设备信息。', ], 'DescribePurchasedDevices' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '按设备ID查询。', 'type' => 'string', 'required' => false, 'example' => '4070*****1132-cn-qingdao', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '按设备名称查询。', 'type' => 'string', 'required' => false, 'example' => 'xxx路口摄像头', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '按设备类型查询。取值：'."\n" .'- ipc（摄像头）'."\n" .'- platform（平台）'."\n" .'- ied（智能设备）', 'type' => 'string', 'required' => false, 'example' => 'ipc', ], ], [ 'name' => 'SubType', 'in' => 'query', 'schema' => [ 'description' => '按设备子类型查询。取值：'."\n" .'- bullet（枪机）'."\n" .'- dome（球机）'."\n" .'- ptz（PTZ）', 'type' => 'string', 'required' => false, 'example' => 'dome', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => '按设备所属空间ID查询。', 'type' => 'string', 'required' => false, 'example' => '348*****174-cn-qingdao', ], ], [ 'name' => 'Vendor', 'in' => 'query', 'schema' => [ 'description' => '按设备厂商查询。', 'type' => 'string', 'required' => false, 'example' => '公司A', ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => '按给定字段排序。取值：'."\n" .'- id（默认）', 'type' => 'string', 'required' => false, 'example' => 'id', ], ], [ 'name' => 'SortDirection', 'in' => 'query', 'schema' => [ 'description' => '排序方式，默认升序。取值：'."\n" .'- asc（升序）'."\n" .'- desc（降序）', 'type' => 'string', 'required' => false, 'example' => 'asc', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页大小，默认为20。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几个分页，默认为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => '第几个分页。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'RequestId' => [ 'description' => '请求ID。', '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' => '按设备类型查询。取值：'."\n" .'- ipc（摄像头）'."\n" .'- platform（平台）'."\n" .'- ied（智能设备）', 'type' => 'string', 'example' => 'ipc', ], 'SubType' => [ 'description' => '按设备子类型查询。取值：'."\n" .'- bullet（枪机）'."\n" .'- dome（球机）'."\n" .'- ptz（PTZ）', 'type' => 'string', 'example' => 'dome', ], 'Vendor' => [ 'description' => '设备厂商。', 'type' => 'string', 'example' => '公司A', ], 'Description' => [ 'description' => '设备描述。', 'type' => 'string', 'example' => 'xxx路口摄像头', ], 'RegisterCode' => [ 'description' => '设备注册码。', 'type' => 'string', 'example' => '1234*****67890', ], 'GroupId' => [ 'description' => '设备所属空间ID。', 'type' => 'string', 'example' => '348*****174-cn-qingdao', ], 'GroupName' => [ 'description' => '空间名称。', 'type' => 'string', 'example' => '测试空间', ], 'Region' => [ 'description' => '空间所属区域，即服务中心。', 'type' => 'string', 'example' => 'cn-qingdao', ], 'Name' => [ 'description' => '设备名称。', 'type' => 'string', 'example' => 'xxx路口摄像头', ], 'CreatedTime' => [ 'description' => '设备创建时间。', 'type' => 'string', 'example' => '2019-02-28T17:00:17Z', ], 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'OrderId' => [ 'description' => '订单ID。', 'type' => 'string', 'example' => '2117*****0447', ], ], ], ], ], ], ], ], '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' => '查询已购买设备列表', 'summary' => '查询已购买设备列表。', ], 'BindPurchasedDevice' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => '空间所属区域。', 'type' => 'string', 'required' => true, 'example' => 'cn-qingdao', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => '空间ID。', 'type' => 'string', 'required' => true, 'example' => '3484*****8732174-cn-qingdao', ], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '3939*****6580539-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '绑定已购买设备', 'summary' => '绑定已购买设备至空间。', ], 'UnbindPurchasedDevice' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '3939*****6580539-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '解绑已购买设备', 'summary' => '从空间解绑已购买设备。', ], 'BatchBindPurchasedDevices' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => '地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-qingdao', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => '设备分组id', 'type' => 'string', 'required' => true, 'example' => '348*****174-cn-qingdao', ], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID。', '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' => '空间ID。', 'type' => 'string', 'example' => '238*****380-cn-qingdao', ], 'DeviceId' => [ 'description' => '设备ID', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'Region' => [ 'description' => '地域。', 'type' => 'string', 'example' => 'cn-qingdao', ], ], ], ], ], ], ], ], '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' => '批量绑定购买设备', 'summary' => '批量绑定购买设备。', ], 'BatchUnbindDirectories' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DirectoryId', 'in' => 'query', 'schema' => [ 'description' => '目录ID。', 'type' => 'string', 'required' => true, 'example' => '399*****488-cn-qingdao', ], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '设备ID，多值用逗号分隔', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '64DB7F34-11A8-45DC-A421-40ACF446282C', ], 'Results' => [ 'description' => '结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '绑定的错误信息。'."\n" .'> 仅在出错时存在。', 'type' => 'string', 'example' => 'An error occurred while processing your request.', ], 'DirectoryId' => [ 'description' => '目录ID。', 'type' => 'string', 'example' => '399*****488-cn-qingdao', ], 'DeviceId' => [ 'description' => '目录ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '从目录内批量解绑多个设备', 'summary' => '从目录内批量解绑多个设备。', ], 'BatchUnbindPurchasedDevices' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '设备ID，多值用逗号分隔', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Results' => [ 'description' => '结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '错误信息。'."\n" .'> 仅当出错时存在。', 'type' => 'string', 'example' => 'some error', ], 'DeviceId' => [ 'description' => '设备ID', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '批量解绑已购买设备', 'summary' => '从空间批量解绑多个已购设备。', ], 'StartStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID。', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => 'NVR历史流，开始时间点（Unix时间戳，单位：秒）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1589336385', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => 'NVR历史流，结束时间点（Unix时间戳，单位：秒）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1599336385', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Name' => [ 'description' => '流名。', 'type' => 'string', 'example' => '31000000000000000002', ], 'Id' => [ 'description' => '流ID。', 'type' => 'string', 'example' => '323*****997-cn-qingdao', ], ], ], ], ], '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":""}]', 'title' => '启动流', 'summary' => '启动流。', ], 'StopStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID。', 'type' => 'string', 'required' => true, 'example' => '32388487****92997-cn-qingdao', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '流名称。', 'type' => 'string', 'required' => false, 'example' => '31000000*****0000002', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '流重启触发时间。', 'type' => 'string', 'required' => false, 'example' => '2021-12-12T10:00:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '流ID。', 'type' => 'string', 'example' => '32388487****92997-cn-qingdao', ], 'RequestId' => [ 'description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '停止流', 'summary' => '停止流。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'BatchStartStreams' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID，多值用逗号分隔。', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Results' => [ 'description' => '结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '流的错误信息。'."\n" .'>仅在流出错时存在。', 'type' => 'string', 'example' => 'stream not found', ], 'Name' => [ 'description' => '流名称。', 'type' => 'string', 'example' => '31000000*****0000002', ], 'Id' => [ 'description' => '流ID。', 'type' => 'string', 'example' => '323*****997-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '批量启动流', 'summary' => '批量启动流。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'BatchStopStreams' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID，多值用逗号分隔。', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '停流触发时间，支持延迟停流。', 'type' => 'string', 'required' => false, 'example' => '2021-12-10T10:00:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Results' => [ 'description' => '结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '流的错误信息。'."\n" .'> 仅在流出错时存在。', 'type' => 'string', 'example' => 'stream not found', ], 'Name' => [ 'description' => '流名称。', 'type' => 'string', 'example' => '3100000*****00000002', ], 'Id' => [ 'description' => '流ID。', 'type' => 'string', 'example' => '323*****997-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '批量停止流', 'summary' => '批量停止流。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID。', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '流状态。取值：'."\n" .'- on（在线）'."\n" .'- off（离线）', 'type' => 'string', 'example' => 'on', ], 'PlayDomain' => [ 'description' => '流所属播流域名。', 'type' => 'string', 'example' => 'example.aliyundoc.com', ], 'Protocol' => [ 'description' => '流协议。', 'type' => 'string', 'example' => 'gb28181', ], 'DeviceId' => [ 'description' => '流所属的设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'Height' => [ 'description' => '视频流分辨率高度。', 'type' => 'integer', 'format' => 'int32', 'example' => '720', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'GroupId' => [ 'description' => '流所属的空间ID。', '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' => '流ID。', 'type' => 'string', 'example' => '323*****997-cn-qingdao', ], ], ], ], ], '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' => '查询流详情', 'summary' => '查询流信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeStreams' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID。'."\n" .'> 支持多个，用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => '323*****997-cn-qingdao', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => '按空间ID查询。', 'type' => 'string', 'required' => false, 'example' => '348*****174-cn-qingdao', ], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '按设备ID查询。', 'type' => 'string', 'required' => false, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'ParentId', 'in' => 'query', 'schema' => [ 'description' => '流所在设备的父设备ID。', 'type' => 'string', 'required' => false, 'example' => '399*****774-cn-qingdao', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '按名称查询。'."\n" .'> 支持多个，用英文逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => '3100000*****00000002', ], ], [ 'name' => 'Domain', 'in' => 'query', 'schema' => [ 'description' => '按域名查询。', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'App', 'in' => 'query', 'schema' => [ 'description' => '按应用查询。', 'type' => 'string', 'required' => false, 'example' => 'live', ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => '按给定字段排序，取值范围：'."\n" .'- Id（默认）'."\n" .'- GroupId'."\n" .'- Name'."\n" .'- DeviceId'."\n" .'- Protocol'."\n" .'> 不支持填入多个字段。', 'type' => 'string', 'required' => false, 'example' => 'Id', ], ], [ 'name' => 'SortDirection', 'in' => 'query', 'schema' => [ 'description' => '排序方式。取值范围：'."\n" .'- asc（升序）（默认）'."\n" .'- desc（降序）', 'type' => 'string', 'required' => false, 'example' => 'asc', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页大小，默认值：20。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几个分页，默认值：1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => '第几个分页。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'TotalCount' => [ 'description' => '流总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'PageCount' => [ 'description' => '分页总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'Streams' => [ 'description' => '流列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '流状态。取值范围：'."\n" .'- on（在线）'."\n" .'- off（离线）', 'type' => 'string', 'example' => 'on', ], 'PlayDomain' => [ 'description' => '流所属播流域名。', 'type' => 'string', 'example' => 'demo.aliyundoc.com', ], 'Protocol' => [ 'description' => '流协议。', 'type' => 'string', 'example' => 'gb28181', ], 'DeviceId' => [ 'description' => '流所属的设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'Height' => [ 'description' => '视频流分辨率高度。', 'type' => 'integer', 'format' => 'int32', 'example' => '720', ], 'GroupId' => [ 'description' => '流所属的空间ID。', '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' => '流ID。', 'type' => 'string', 'example' => '323*****997-cn-qingdao', ], ], ], ], ], ], ], ], '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":""}]', 'title' => '查询流列表', 'summary' => '查询流的列表信息，支持通过流的ID，名称，空间ID，设备ID等过滤筛选。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeStreamURL' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID。', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '流类型，默认live。取值：'."\n" .'- live（直播流）'."\n" .'- vod（点播流，例如NVR上的历史流）', 'type' => 'string', 'required' => false, 'example' => 'live', 'default' => 'live', ], ], [ 'name' => 'OutProtocol', 'in' => 'query', 'schema' => [ 'description' => '流播放协议。取值：'."\n" .'- rtmp'."\n" .'- flv'."\n" .'- hls', 'type' => 'string', 'required' => true, 'example' => 'rtmp', ], ], [ 'name' => 'Auth', 'in' => 'query', 'schema' => [ 'description' => '是否需要生成签名URL。取值：'."\n" .'- true'."\n" .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true', ], ], [ 'name' => 'AuthKey', 'in' => 'query', 'schema' => [ 'description' => '播放域名关联的主key，用于生成鉴权URL。'."\n" ."\n" .'> 通过 [DescribeVsDomainConfigs](https://next.api.aliyun.com/document/vs/2018-12-12/DescribeVsDomainConfigs) 接口查询对应的AuthKey信息', 'type' => 'string', 'required' => false, 'example' => 'ocs*****ace', ], ], [ 'name' => 'Expire', 'in' => 'query', 'schema' => [ 'description' => 'URL的过期时长，单位：秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '开始时间，适用于vod流类型。 '."\n" .'unix时间戳，单位：秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1571639499', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间，适用于vod流类型。 '."\n" .'unix时间戳，单位：秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1571649499', ], ], [ 'name' => 'Transcode', 'in' => 'query', 'schema' => [ 'description' => '转码规则名称（需要先绑定转码模板）。', 'type' => 'string', 'required' => false, 'example' => 'sd', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Url' => [ 'description' => '流的URL。', 'type' => 'string', 'example' => 'rtmp://demo.aliyundoc.com/live/310101*****7542007?auth_key=1639130258-0-0-b2b04fe85ece6*****a6b1a42bc7e', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'ExpireTime' => [ 'description' => 'URL过期时间点。 '."\n" .'unix时间戳，单位：秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1557977029', ], ], ], ], ], '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' => '获取流URL', 'summary' => '获取流URL信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeVodStreamURL' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Url', 'in' => 'query', 'schema' => [ 'description' => '点播视频的文件URL', 'type' => 'string', 'required' => true, 'example' => 'http://xxx/xxx.mp4', ], ], [ 'name' => 'TxId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Url' => [ 'description' => '流播放URL', 'type' => 'string', 'example' => 'rtsp://domain/live/stream?sign=xxxxxx', ], 'OutProtocol' => [ 'description' => '流播放协议', 'type' => 'string', 'example' => 'rtsp', ], 'RequestId' => [ 'description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Port' => [ 'description' => '流播放端口', 'type' => 'integer', 'format' => 'int64', 'example' => '8080', ], 'TxId' => [ 'type' => 'string', ], ], ], ], ], '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"}]', 'title' => '获取vod流URL', 'summary' => '获取点播流的URL信息。', ], 'DescribeStreamVodList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID。', 'type' => 'string', 'required' => true, 'example' => '18526049*****219118918-cn-beijing', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '点播记录开始时间点（uinx时间戳，单位：秒）', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1639077653', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '点播记录结束时间点（uinx时间戳，单位：秒）', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1634873413', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Records' => [ 'description' => '点播记录列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => '点播记录结束时间点（uinx时间戳，单位：秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1634873413', ], 'StartTime' => [ 'description' => '点播记录开始时间点（uinx时间戳，单位：秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1639077653', ], ], ], ], ], ], ], ], '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' => '获取流视频点播列表', 'summary' => '获取流点播记录列表，例如来自NVR的历史流列表。', ], 'ForbidVsStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的加速域名', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => '应用名称', 'type' => 'string', 'required' => true, 'example' => 'xxxApp', ], ], [ 'name' => 'StreamName', 'in' => 'query', 'schema' => [ 'description' => '流名称', 'type' => 'string', 'required' => true, 'example' => 'xxxStream', ], ], [ 'name' => 'LiveStreamType', 'in' => 'query', 'schema' => [ 'description' => '目前仅支持”publisher”', 'type' => 'string', 'required' => true, 'example' => 'publisher', 'enum' => [ 'publisher', ], ], ], [ 'name' => 'Oneshot', 'in' => 'query', 'schema' => [ 'description' => '是否只断流不加入黑名单，取值：yes，表示只断流不加黑名单', 'type' => 'string', 'required' => false, 'example' => 'yes', 'enum' => [ 'yes', 'no', ], ], ], [ 'name' => 'ControlStreamAction', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'forbid', 'enum' => [ 'forbid', ], ], ], [ 'name' => 'ResumeTime', 'in' => 'query', 'schema' => [ 'description' => '恢复流的时间 UTC时间格式', 'type' => 'string', 'required' => false, 'example' => '2015-12-01T17:37:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID', 'type' => 'string', 'example' => '119F7639-4646-51A4-B6C1-300D391C0104', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"119F7639-4646-51A4-B6C1-300D391C0104\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '禁止某条流的推送', 'summary' => '禁止某条流的推送，可以预设某个时刻将流恢复。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '#特殊错误码 '."\n" .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" .'| :----- | :----- | :----- | :----- |'."\n" .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误 |'."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名 |'."\n" .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名 |'."\n" .'| InvalidResumeTime.Malformed | Specified parameter ResumeTime is not valid. | 400 | 结束时间错误 |'."\n" .'| QuotaExceeded.Blacklist | Exceed max blacklist count limit | 400 | 黑名单条数超出上限，默认1000条 |'."\n" .'| ConfigAlreadyExists | Config has already exist. | 400 | 配置已存在 |', ], 'ResumeVsStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的加速域名。', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'xxxxApp', ], ], [ 'name' => 'StreamName', 'in' => 'query', 'schema' => [ 'description' => '流名称。', 'type' => 'string', 'required' => true, 'example' => 'xxxxStream', ], ], [ 'name' => 'LiveStreamType', 'in' => 'query', 'schema' => [ 'description' => '流类型。'."\n" .'> 目前仅支持：publisher', 'type' => 'string', 'required' => true, 'example' => 'publisher', 'enum' => [ 'publisher', ], ], ], [ 'name' => 'ControlStreamAction', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'resume', 'enum' => [ 'resume', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664 ', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\\\t\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '恢复某条流的推送', 'summary' => '恢复某条流的推送。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '#特殊错误码 '."\n" .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" .'| :----- | :----- | :----- | :----- |'."\n" .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 |'."\n" .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名。 |', ], 'BatchForbidVsStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的加速域名。', 'type' => 'string', 'required' => true, 'example' => 'example.com', ], ], [ 'name' => 'Channel', 'in' => 'query', 'schema' => [ 'description' => '流名称。'."\n" .'> - 格式为：AppName/StreamName。'."\n" .'> - 支持多个，用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => 'live/stream1,live/stream2', ], ], [ 'name' => 'LiveStreamType', 'in' => 'query', 'schema' => [ 'description' => '用于指定主播推流还是客户端拉流。取值范围：'."\n" .'- publisher（主播推送）'."\n" ."\n" .'> 目前仅支持：publisher。', 'type' => 'string', 'required' => true, 'example' => 'publisher', 'enum' => [ 'publisher', ], ], ], [ 'name' => 'Oneshot', 'in' => 'query', 'schema' => [ 'description' => '是否只断流不加入黑名单。取值范围：'."\n" .'- yes（是）'."\n" .'- no（否）', 'type' => 'string', 'required' => false, 'example' => 'yes', 'enum' => [ 'yes', 'no', ], ], ], [ 'name' => 'ControlStreamAction', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'forbid', 'enum' => [ 'forbid', ], ], ], [ 'name' => 'ResumeTime', 'in' => 'query', 'schema' => [ 'description' => '恢复流的时间。'."\n" .'> UTC时间格式，例如：2015-12-01T17:37:00Z', 'type' => 'string', 'required' => false, 'example' => '2015-12-01T17:37:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'B058D71B-76EA-5DF6-ACAF-A617C1E7937F', ], 'ForbidResult' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ForbidResultInfo' => [ 'description' => '断流结果。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Result' => [ 'description' => '操作结果。取值范围：'."\n" .'- success（成功）'."\n" .'- fail（失败）', 'type' => 'string', 'example' => 'success', ], 'Count' => [ 'description' => '成功或者失败的路数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Detail' => [ 'description' => '错误原因。取值范围：'."\n" .'- ok（成功）'."\n" .'- exceed-limit（黑名单条数超限）'."\n" .'- internal-error（内部错误）', 'type' => 'string', 'example' => 'ok', ], 'Channels' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Channel' => [ 'description' => '流名称列表。', 'type' => 'array', 'items' => [ 'description' => '流名称。'."\n" .'> - 格式为：AppName/StreamName。'."\n" .'> - 支持多个，用英文逗号（,）分隔。', 'type' => 'string', 'example' => 'live/stream1,live/stream2', ], ], ], ], ], ], ], ], ], ], ], ], ], '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' => '批量禁止VS流', 'summary' => '禁止某条流的推送，可以预设某个时刻将流恢复。', 'extraInfo' => '## 特殊错误码'."\n" .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" .'|------------|--------|---------|------|'."\n" .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 | '."\n" .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名。 |'."\n" .'| InvalidResumeTime.Malformed | Specified parameter ResumeTime is not valid. | 400 | 结束时间错误。 | '."\n" .'| QuotaExceeded.Blacklist | Exceed max blacklist count limit|400|黑名单条数超出上限，默认10000条。|'."\n" .'| ConfigAlreadyExists | Config has already exist.|400|配置已存在。|', ], 'BatchResumeVsStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的加速域名', 'type' => 'string', 'required' => true, 'example' => 'example.com', ], ], [ 'name' => 'Channel', 'in' => 'query', 'schema' => [ 'description' => '流名称，格式为AppName/StreamName, 多个用,隔开', 'type' => 'string', 'required' => true, 'example' => 'live/stream1', ], ], [ 'name' => 'LiveStreamType', 'in' => 'query', 'schema' => [ 'description' => '用于指定主播推流还是客户端拉流, 目前支持“publisher”（主播推送）', 'type' => 'string', 'required' => true, 'example' => 'publisher', 'enum' => [ 'publisher', ], ], ], [ 'name' => 'ControlStreamAction', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'resume', 'enum' => [ 'resume', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'ResumeResult' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ResumeResultInfo' => [ 'description' => '恢复任务结果。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Result' => [ 'description' => '操作结果，取值success/fail, 表示成功/失败', 'type' => 'string', 'example' => 'success', ], 'Count' => [ 'description' => '成功或者失败的路数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Detail' => [ 'description' => '错误原因, 取值ok/internal-error,表示成功/内部错误', 'type' => 'string', 'example' => 'ok', ], 'Channels' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Channel' => [ 'description' => '流列表，格式为AppName/StreamName', 'type' => 'array', 'items' => [ 'description' => '流列表，格式为AppName/StreamName', 'type' => 'string', 'example' => 'live/stream1', ], ], ], ], ], ], ], ], ], ], ], ], ], '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' => '批量恢复某条监控流的推送', 'summary' => '恢复某条流的推送。', 'extraInfo' => '## 特殊错误码'."\n" .'| 错误代码 | 描述 | HTTP 状态码 | 语义 |'."\n" .'|------------|--------|---------|------|'."\n" .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误 |'."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名 | '."\n" .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名 |', ], 'CreateStreamSnapshot' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID。', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', ], ], [ 'name' => 'Location', 'in' => 'query', 'schema' => [ 'description' => '截图方式。取值范围：'."\n" .'- center（云端截图）（默认）'."\n" .'- device（设备截图）', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'center' => '云端截图', 'device' => '设备截图', ], 'example' => 'device', 'default' => 'center', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'OssObject' => [ 'description' => '截图文件的Object。', 'type' => 'string', 'example' => 'photos/live/340200*****100049/ondemand-1639126601767.jpg', ], 'RequestId' => [ 'description' => '请求ID。', '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' => '截图文件的URL。', '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' => '截图文件的Bucket。', 'type' => 'string', 'example' => 'examplebucket', ], 'Format' => [ 'description' => '图片格式。', 'type' => 'string', 'example' => 'jpg', ], 'OssEndpoint' => [ 'description' => '截图文件的OSS Endpoint。', 'type' => 'string', 'example' => 'oss-cn-qingdao.aliyuncs.com', ], 'Id' => [ 'description' => '流ID。', 'type' => 'string', 'example' => '323*****997-cn-qingdao', ], ], ], ], ], '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":""}]', 'title' => '触发按需截图', 'summary' => '对指定流，按需创建新的截图。', 'description' => '> 需要预先在绑定的截图模板中启用按需截图功能。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SetVsStreamsNotifyUrlConfig' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的加速域名。', 'type' => 'string', 'required' => true, 'example' => 'example.com', ], ], [ 'name' => 'NotifyUrl', 'in' => 'query', 'schema' => [ 'description' => '设置直播流信息推送到的URL地址。'."\n" .'> 必须以 http:// 或者 https:// 开头。', 'type' => 'string', 'required' => true, 'example' => 'http://xxx.com/xx', ], ], [ 'name' => 'AuthType', 'in' => 'query', 'schema' => [ 'description' => '鉴权类型，取值范围：'."\n" .'- **no_auth**（关闭）'."\n" .'- **type_a**（A方式）'."\n" .'- **type_b**（B方式）'."\n" .'- **type_c**（C方式）', 'type' => 'string', 'required' => false, 'example' => 'type_a', ], ], [ 'name' => 'AuthKey', 'in' => 'query', 'schema' => [ 'description' => '播放域名关联的主Key，用于生成鉴权URL。'."\n" .'> 通过 [DescribeVsDomainConfigs](https://help.aliyun.com/document_detail/464513.html) 接口查询对应的AuthKey信息。', 'type' => 'string', 'required' => false, 'example' => 'ocs*****ace', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '设置 VS 流通知 URL 配置', 'summary' => '设置推流回调配置。', 'extraInfo' => '## 特殊错误码'."\n" .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" .'|------------|--------|---------|------|'."\n" .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 | '."\n" .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名。 |'."\n" .'| InvalidNotifyUrl.Malformed | Specified parameter NotifyUrl is not valid. | 400 | 不是一个合法的 HTTP 地址。 |'."\n" .'| InvalidNotifyUrl.Unsafe | Specified NotifyUrl is not safe. | 400 | 非安全的 NotifyUrl 值。 |', ], 'DeleteVsStreamsNotifyUrlConfig' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的加速域名。', 'type' => 'string', 'required' => true, 'example' => 'example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '4C747C97-7ECD-4C61-8A92-67AD806331FF', ], ], ], ], ], '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":""}]', 'title' => '删除推流回调配置', 'summary' => '删除推流回调配置。', 'extraInfo' => '## 特殊错误码'."\n" .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" .'|------------|--------|---------|------|'."\n" .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 | '."\n" .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名。 |', ], 'DescribeVsStreamsNotifyUrlConfig' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的加速域名。', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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' => 'https://example.com/callback', ], ], ], ], ], ], ], '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"}]', 'title' => '获取 VS 流通知 URL 配置', 'summary' => '查询推流回调配置。', 'extraInfo' => '## 特殊错误码'."\n" .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" .'|------------|--------|---------|------|'."\n" .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 | '."\n" .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名。 | '."\n" .'| InvalidConfig.NotFound| Config does not exist.| 404| 当前域名下未找到回调配置。|', ], 'AddVsPullStreamInfoConfig' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的加速域名。', 'type' => 'string', 'required' => true, 'example' => 'example.com', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => '应用名称。', 'type' => 'string', 'required' => true, 'example' => 'xxxApp', ], ], [ 'name' => 'StreamName', 'in' => 'query', 'schema' => [ 'description' => '流名称。', 'type' => 'string', 'required' => true, 'example' => 'xxxStream', ], ], [ 'name' => 'SourceUrl', 'in' => 'query', 'schema' => [ 'description' => '用户的直播流所在的源站。'."\n" .'> 支持多个，用英文分号（;）分隔。', 'type' => 'string', 'required' => true, 'example' => 'up.******.com.cn', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '拉流开始时间。'."\n" .'> UTC时间格式，StartTime和EndTime时间间隔在7天内。', 'type' => 'string', 'required' => false, 'example' => '2017-08-28T07:30:30Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '拉流结束时间。'."\n" .'> UTC时间格式，StartTime和EndTime时间间隔在7天内，且EndTime必须超过当前时间。', 'type' => 'string', 'required' => false, 'example' => '2017-08-28T09:30:30Z', ], ], [ 'name' => 'Always', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => [ 'yes', 'no', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '3CB843A9-DD34-4881-B8D6-B0D539D111E4', ], ], ], ], ], '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.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3CB843A9-DD34-4881-B8D6-B0D539D111E4\\"\\n}","type":"json"}]', 'title' => '添加拉流信息配置', 'summary' => '添加拉流配置信息。', 'extraInfo' => '## 特殊错误码'."\n" .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" .'|------------|--------|---------|------|'."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 | '."\n" .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名。 |'."\n" .'| Missing DomainName | DomainName is mandatory for this action. | 400 |缺少参数。 | '."\n" .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n" .'| InvalidStartTime.Malformed |Specified StartTime is malformed.| 400 | StartTime格式错误。 |'."\n" .'|InvalidEndTime.Malformed |Specified EndTime is malformed. | 400 | EndTime格式错误。 |'."\n" .'|InvalidEndTime.Missmatch |Specified end time does not math the specified start time or current time.| 400 | StartTime 和 EndTime 时间范围应在一周内，且EndTime超过当前时间。 |'."\n" .'| ConfigAlreadyExists | Config has already exist. | 400 | 配置数据已存在。| '."\n" .'| PullStreamOverLimit | Pull stream is over limit for this domainName. | 400 | 该域名拉流流量已超过流量限制。 |', ], 'DeleteVsPullStreamInfoConfig' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的拉流域名。', 'type' => 'string', 'required' => true, 'example' => 'example.com', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => '直播流所属应用名称。', 'type' => 'string', 'required' => true, 'example' => 'xxxApp', ], ], [ 'name' => 'StreamName', 'in' => 'query', 'schema' => [ 'description' => '直播流名。', 'type' => 'string', 'required' => true, 'example' => 'xxxStream', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '删除拉取流信息配置', 'summary' => '删除拉流信息。', 'extraInfo' => '## 特殊错误码'."\n" .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" .'|------------|--------|---------|------|'."\n" .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 | '."\n" .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名。 |', ], 'UpdateVsPullStreamInfoConfig' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的拉流域名。', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => '直播流所属应用名称。', 'type' => 'string', 'required' => true, 'example' => 'xxxApp', ], ], [ 'name' => 'StreamName', 'in' => 'query', 'schema' => [ 'description' => '直播流名。', 'type' => 'string', 'required' => true, 'example' => 'xxxStream', ], ], [ 'name' => 'SourceUrl', 'in' => 'query', 'schema' => [ 'description' => '用户的直播流所在的源站。'."\n" .'> 支持多个，用英文分号（;）分隔。', 'type' => 'string', 'required' => true, 'example' => 'up.xxx.com.cn', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '拉流开始时间。'."\n" .'> UTC时间格式，StartTime和EndTime时间间隔在7天内。', 'type' => 'string', 'required' => false, 'example' => '2021-12-10T10:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '拉流结束时间。'."\n" .'> UTC时间格式，StartTime和EndTime时间间隔在7天内，且EndTime必须超过当前时间。', 'type' => 'string', 'required' => false, 'example' => '2018-12-10T18:00:00Z', ], ], [ 'name' => 'Always', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => [ 'yes', 'no', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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.', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '更新拉流信息配置', 'summary' => '更新拉流信息，修改已经添加的拉流任务中的源站地址的开始时间和结束时间。', 'extraInfo' => '## 特殊错误码'."\n" .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" .'|------------|--------|---------|------|'."\n" .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 | '."\n" .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名。 |'."\n" .'| InvalidStartTime.Malformed | Specified StartTime is malformed. | 400 | 拉流开始时间格式错误。|'."\n" .'| InvalidEndTime.Malformed | Specified EndTime is malformed. | 400 | 拉流结束时间格式错误。|'."\n" .'| InvalidEndTime.Mismatch | StartTime is after EndTime. | 400 | 拉流起始时间晚于拉流结束时间。|'."\n" .'| Duration.Exceed | Duration between StartTime and EndTime is too long. | 400 | 查询时间范围过长。|', ], 'DescribeVsPullStreamInfoConfig' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的拉流域名。', 'type' => 'string', 'required' => true, 'example' => 'example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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', ], ], ], ], ], ], ], ], ], ], '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"}]', 'title' => '获取拉流信息配置', 'summary' => '查询域名下拉流配置信息。', 'extraInfo' => '## 特殊错误码'."\n" .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" .'|------------|--------|---------|------|'."\n" .'| Missing DomainName | DomainName is mandatory for this action. | 400 |缺少参数。 | '."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 |', ], 'StartTransferStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID。', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', ], ], [ 'name' => 'Url', 'in' => 'query', 'schema' => [ 'description' => '转推的目的地址', 'type' => 'string', 'required' => true, 'example' => 'example.com', ], ], [ 'name' => 'Transcode', 'in' => 'query', 'schema' => [ 'description' => '转码规则名称（需要先绑定转码模板）', 'type' => 'string', 'required' => false, 'example' => 'sd', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '启动传输流', 'summary' => '启动转推流到外部的地址。', ], 'StopTransferStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID。', 'type' => 'string', 'required' => true, 'example' => '323434****83423432', ], ], [ 'name' => 'Transcode', 'in' => 'query', 'schema' => [ 'description' => '转码规则名称（需要先绑定转码模板）', 'type' => 'string', 'required' => false, 'example' => 'sd', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '停止传输流', 'summary' => '停止流。', ], 'DescribeVsStreamsOnlineList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的加速域名。', 'type' => 'string', 'required' => true, 'example' => 'example.com', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'xxxApp', ], ], [ 'name' => 'StreamName', 'in' => 'query', 'schema' => [ 'description' => '流名称。', 'type' => 'string', 'required' => false, 'example' => 'xxxStream', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。默认值：3000。'."\n" ."\n" .'取值范围：[1,3000]', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '2000', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几个分页，默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'StreamType', 'in' => 'query', 'schema' => [ 'description' => '流类型。取值范围：'."\n" .'- all（所有流）（默认）'."\n" .'- raw（原始流）'."\n" .'- trans（转码流）', 'type' => 'string', 'required' => false, 'example' => 'all', 'enum' => [ 'all', 'raw', 'trans', ], ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '起始时间。'."\n" .'> 为UTC格式，例如：2016-06-29T19:00:00Z', 'type' => 'string', 'required' => false, 'example' => '2016-06-29T19:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间。'."\n" .'> - 为UTC格式，例如：2016-06-30T19:00:00Z'."\n" .'> - EndTime和StartTime之间的间隔不能超过30天。', 'type' => 'string', 'required' => false, 'example' => '2016-06-30T19:00:00Z', ], ], [ 'name' => 'QueryType', 'in' => 'query', 'schema' => [ 'description' => '指定是否模糊匹配流名称。取值范围：'."\n" .'- fuzzy（模糊匹配）'."\n" .'- strict（精准匹配）', 'type' => 'string', 'required' => false, 'example' => 'fuzzy', 'enum' => [ 'fuzzy', 'strict', ], ], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ 'description' => '排序方式。取值范围：'."\n" .'- stream_name_desc（按直播流名称倒序）'."\n" .'- stream_name_asc（按直播流名称升序）'."\n" .'- publish_time_desc（按推流时间倒序）'."\n" .'- publish_time_asc（按推流时间升序）（默认值）', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'publish_time_asc', 'enum' => [ 'stream_name_desc', 'stream_name_asc', 'stream_publish_time_desc', 'stream_publish_asc', ], ], ], ], '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' => '请求ID。', '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' => '开始推流时刻，UTC时间。', 'type' => 'string', 'example' => '2015-12-02T06:58:04Z', ], 'AppName' => [ 'description' => '流所属应用名称。', 'type' => 'string', 'example' => 'xxxApp', ], 'PublishType' => [ 'description' => '推流类型。取值范围：'."\n" .'- edge（边缘推流）'."\n" .'- center（中心推流）', 'type' => 'string', 'example' => 'edge', ], 'PublishUrl' => [ 'description' => '推流完整URL地址。', 'type' => 'string', 'example' => 'rtmp://example.com/xchen', ], 'Transcoded' => [ 'description' => '是否为转码流。取值范围：'."\n" .'- yes（是）'."\n" .'- no（否）', 'type' => 'string', 'example' => 'no', ], 'StreamName' => [ 'description' => '流名称。', 'type' => 'string', 'example' => 'testxchen_small', ], 'DomainName' => [ 'description' => '流所属加速域名。', 'type' => 'string', 'example' => 'example.com', ], 'TranscodeId' => [ 'description' => '转码模板ID。'."\n" .'> - 若转码过，会返回转码模板ID。'."\n" .'> - 对于原始流，返回当前AppName下配置的转码模板ID列表，用英文逗号（,）分隔。', 'type' => 'string', 'example' => '123', ], 'PublishDomain' => [ 'description' => '推流域名。', 'type' => 'string', 'example' => 'push.example.com', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', ], ], ], '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' => '查询所有正在推的流的信息', 'summary' => '查看指定域名下（或者指定域名下某个应用）的所有正在推的流的信息。', 'extraInfo' => '## 特殊错误码'."\n" .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" .'|------------|--------|---------|------|'."\n" .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 |'."\n" .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名。 |', ], 'DescribeVsStreamsPublishList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的域名。', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => [ 'description' => '直播流所属应用名称。', 'type' => 'string', 'required' => false, 'example' => 'xxxApp', ], ], [ 'name' => 'StreamName', 'in' => 'query', 'schema' => [ 'description' => '直播流名称。', 'type' => 'string', 'required' => false, 'example' => 'xxxStream', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '起始时间。'."\n" .'> UTC格式。例如：2016-06-29T19:00:00Z', 'type' => 'string', 'required' => true, 'example' => '2016-06-29T19:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间。'."\n" .'> - UTC格式。例如：2016-06-30T19:00:00Z'."\n" .'> - EndTime和StartTime之间的间隔不能超过30天。', 'type' => 'string', 'required' => true, 'example' => '2016-06-30T19:00:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页大小。默认值：3000。 '."\n" .'取值范围：[1,3000]', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000', 'default' => '2000', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '第几页。默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'StreamType', 'in' => 'query', 'schema' => [ 'description' => '流类型。取值范围：'."\n" .'- all（所有流）（默认）'."\n" .'- raw（原始流）'."\n" .'- trans（转码流）', 'type' => 'string', 'required' => false, 'example' => 'all', 'enum' => [ 'all', 'raw', 'trans', ], ], ], [ 'name' => 'QueryType', 'in' => 'query', 'schema' => [ 'description' => '指定是否模糊匹配流名称。取值范围：'."\n" .'- fuzzy（模糊匹配）'."\n" .'- strict（精准匹配）', 'type' => 'string', 'required' => false, 'example' => 'fuzzy', 'enum' => [ 'fuzzy', 'strict', ], ], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ 'description' => '排序方式。取值范围：'."\n" .'- stream_name_desc（按直播流名称倒序）'."\n" .'- stream_name_asc（按直播流名称升序）'."\n" .'- publish_time_desc（按推流时间倒序）'."\n" .'- publish_time_asc（按推流时间升序）（默认值）', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'publish_time_asc', 'enum' => [ 'stream_name_desc', 'stream_name_asc', 'publish_time_desc', 'publish_asc', ], ], ], ], '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' => '3000', ], 'RequestId' => [ 'description' => '请求ID。', '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' => 'CDN上行节点IP。', 'type' => 'string', 'example' => '192.168.0.1', ], 'PublishUrl' => [ 'description' => '推流完整URL地址。', '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' => '停止推流时刻。 格式为UTC时间。', 'type' => 'string', 'example' => '2016-06-29T19:00:00Z', ], 'TranscodeId' => [ 'description' => '转码模板ID。'."\n" .'> 若转码过，会返回转码模板ID。', 'type' => 'string', 'example' => '3888920****8138204-cn-qingdao', ], 'PublishDomain' => [ 'description' => '推流域名。', 'type' => 'string', 'example' => 'example.aliyundoc.com', ], 'AppName' => [ 'description' => '流所属应用名称。', 'type' => 'string', 'example' => 'xxxApp', ], 'PublishTime' => [ 'description' => '开始推流时刻。格式为UTC时间。', 'type' => 'string', 'example' => '2016-06-29T19:00:00Z', ], 'PublishType' => [ 'description' => '推流类型。取值范围：'."\n" .'- edge（边缘推流）'."\n" .'- center（中心推流）', 'type' => 'string', 'example' => 'center', ], 'Transcoded' => [ 'description' => '是否为转码流。取值范围：'."\n" .'- yes（是）'."\n" .'- no（否）', 'type' => 'string', 'example' => 'yes', ], 'ClientAddr' => [ 'description' => '主播IP。', 'type' => 'string', 'example' => '192.168.0.1', ], 'StreamUrl' => [ 'description' => '直播流的URL。', 'type' => 'string', 'example' => 'https://example.aliyundoc.com/xxxApp/3402000****320000001.m3u8', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidEndTime.Mismatch', 'errorMessage' => 'The specified EndTime is earlier than the StartTime.', ], ], ], '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":""}]', 'title' => '获取VS流推流记录', 'summary' => '获取某一时间段内某个域名（或域名下某应用或某个流）的推流记录。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '#特殊错误码 '."\n" .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" .'| :----- | :----- | :----- | :----- |'."\n" .'| InternalError | The request processing has failed due to some unknown error. | 500 | 后台发生未知错误。 |'."\n" .'| InvalidDomain.NotFound | The domain provided does not exist in our records. | 404 | 当前账户下未查到域名。 |'."\n" .'| IllegalOperation | Illegal domain operate is not permitted. | 403 | 不支持当前操作，如：非直播类域名。 |'."\n" .'| InvalidStartTime.Malformed | Specified parameter StartTime is not valid. | 400 | 开始时间错误。 |'."\n" .'| InvalidEndTime.Malformed | Specified parameter EndTime is not valid. | 400 | 结束时间错误。 |'."\n" .'| InvalidEndTime.Mismatch | Specified end time does not math the specified start time. | 400 | 结束时间与开始时间不匹配。 |', ], 'CreateTemplate' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '模板名称。', 'type' => 'string', 'required' => true, 'example' => '录制模板', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '模板描述。', 'type' => 'string', 'required' => false, 'example' => '录制模板', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '模板类型。取值：'."\n" .'- record（录制）'."\n" .'- snapshot（截图）'."\n" .'- transcode（转码）'."\n" .'- timeshift（时移）', 'type' => 'string', 'required' => true, 'example' => 'record', ], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => 'OSS所属区域，即服务中心。', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao', ], ], [ 'name' => 'OssBucket', 'in' => 'query', 'schema' => [ 'description' => 'OSS的Bucket。', 'type' => 'string', 'required' => false, 'example' => 'bucketname', ], ], [ 'name' => 'OssEndpoint', 'in' => 'query', 'schema' => [ 'description' => 'OSS的域名。', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-qingdao.aliyuncs.com', ], ], [ 'name' => 'OssFilePrefix', 'in' => 'query', 'schema' => [ 'description' => 'OSS文件前缀', 'type' => 'string', 'required' => false, 'example' => 'oss-prefix', ], ], [ 'name' => 'Trigger', 'in' => 'query', 'schema' => [ 'description' => '模板触发类型，默认auto。取值：'."\n" .'- auto（自动）'."\n" .'- ondemand（按需）', 'type' => 'string', 'required' => false, 'example' => 'auto', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => '操作周期，单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', ], ], [ 'name' => 'Retention', 'in' => 'query', 'schema' => [ 'description' => '时移保存周期，单位：天', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', ], ], [ 'name' => 'FileFormat', 'in' => 'query', 'schema' => [ 'description' => '存储文件格式，多值用逗号分隔。取值：'."\n" .'- mp4'."\n" .'- flv'."\n" .'- hls'."\n" .'> 青岛单元暂不支持flv、mp4录制', 'type' => 'string', 'required' => false, 'example' => 'hls', ], ], [ 'name' => 'JpgOverwrite', 'in' => 'query', 'schema' => [ 'description' => 'JPG的存储路径，用于覆盖截图。'."\n" .'- 目前仅支持生成jpg图片。'."\n" .'- 支持变量匹配，包含{AppName}、{StreamName}', 'type' => 'string', 'required' => false, 'example' => 'osspath/snapshot/{AppName}/{StreamName}.jpg', ], ], [ 'name' => 'JpgSequence', 'in' => 'query', 'schema' => [ 'description' => 'JPG的存储路径，用于序列截图。'."\n" .'- 目前仅支持生成jpg图片。'."\n" .'- 支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}'."\n" .'- {UnixTimestamp}、{Sequence}必填一个', 'type' => 'string', 'required' => false, 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', ], ], [ 'name' => 'JpgOnDemand', 'in' => 'query', 'schema' => [ 'description' => 'JPG的存储路径，用于按需截图。'."\n" .'- 目前仅支持生成jpg图片。'."\n" .'- 支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}'."\n" .'- {UnixTimestamp}、{Sequence}必填一个', 'type' => 'string', 'required' => false, 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg', ], ], [ 'name' => 'Mp4', 'in' => 'query', 'schema' => [ 'description' => 'MP4的存储路径。'."\n" .'- 路径中支持变量匹配，可选{AppName}、{StreamName}、{Sequence}、{EscapedStartTime}、{EscapedEndTime}'."\n" .'- 必须包含{EscapedStartTime}和{EscapedEndTime}', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', ], ], [ 'name' => 'Flv', 'in' => 'query', 'schema' => [ 'description' => 'FLV的存储路径。格式参考Mp4说明。', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', ], ], [ 'name' => 'HlsM3u8', 'in' => 'query', 'schema' => [ 'description' => 'HLS的存储路径，m3u8文件。格式参考Mp4说明。', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', ], ], [ 'name' => 'HlsTs', 'in' => 'query', 'schema' => [ 'description' => 'HLS的存储路径，ts文件。'."\n" .'- 路径中支持变量匹配，可选{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}'."\n" .'- 必须包含{UnixTimestamp}和{Sequence}变量', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}', ], ], [ 'name' => 'Callback', 'in' => 'query', 'schema' => [ 'description' => '模板执行后的回调。'."\n" ."\n" .'> 注： 按需触发的模板不支持回调参数。', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback', ], ], [ 'name' => 'TransConfigsJSON', 'in' => 'query', 'schema' => [ 'description' => '转码配置TransConfig类型的数组，JSON格式字符串', 'type' => 'string', 'required' => false, 'example' => '[{"Fps":25,"Gop":50,"Height":720,"VideoCodec":"h264","Width":1280,"Name":"sd","VideoBitrate":800}]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '模板ID。', 'type' => 'string', 'example' => '399*****735-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '创建模板', 'summary' => '创建新模板。', 'requestParamsDescription' => '## TransConfig类型'."\n" ."\n" .'|参数 |类型 |必要 |示例值 |描述|'."\n" .'| -----| ---- | ---- |----|---- |'."\n" .'|Name |String |是 |sd |转码规则名称。转码规则名称将作为转码流后缀，建议按使用习惯设置为sd，200k等易辨识后缀，只支持数字和字母。|'."\n" .'|VideoCodec |String |是 |h264 |视频编码取值：h264|'."\n" .'|VideoBitrate |Long |是 |800 |视频比特率，单位：kbps|'."\n" .'|Fps |Long |是 |25 |视频帧率，单位：fps|'."\n" .'|Gop |Long |是 |50 |视频Gop，单位：帧|'."\n" .'|Height |Long |是 |640 |视频高度|'."\n" .'|Width |Long |是 |1280 |视频宽度|', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteTemplate' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '删除模版', 'summary' => '删除模板。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyTemplate' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => '323*****998-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' => 'Region', 'in' => 'query', 'schema' => [ 'description' => 'OSS所属区域，即服务中心。', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao', ], ], [ 'name' => 'OssBucket', 'in' => 'query', 'schema' => [ 'description' => 'OSS的Bucket。', 'type' => 'string', 'required' => false, 'example' => 'bucketname', ], ], [ 'name' => 'OssEndpoint', 'in' => 'query', 'schema' => [ 'description' => 'OSS的域名。', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-qingdao.aliyuncs.com', ], ], [ 'name' => 'OssFilePrefix', 'in' => 'query', 'schema' => [ 'description' => 'OSS文件前缀', 'type' => 'string', 'required' => false, 'example' => 'oss-prefix', ], ], [ 'name' => 'Trigger', 'in' => 'query', 'schema' => [ 'description' => '模板触发类型，默认auto。取值：'."\n" .'- auto（自动）'."\n" .'- ondemand（按需）', 'type' => 'string', 'required' => false, 'example' => 'auto', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => '操作周期，单位秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', ], ], [ 'name' => 'Retention', 'in' => 'query', 'schema' => [ 'description' => '时移保存周期，单位：天', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', ], ], [ 'name' => 'FileFormat', 'in' => 'query', 'schema' => [ 'description' => '存储文件格式，多值用逗号分隔。取值：'."\n" .'- mp4'."\n" .'- flv'."\n" .'- hls'."\n" .'> 青岛单元暂不支持flv、mp4录制', 'type' => 'string', 'required' => false, 'example' => 'hls', ], ], [ 'name' => 'JpgOverwrite', 'in' => 'query', 'schema' => [ 'description' => 'JPG的存储路径，用于覆盖截图。'."\n" .'- 目前仅支持生成jpg图片。'."\n" .'- 支持变量匹配，包含{AppName}、{StreamName}', 'type' => 'string', 'required' => false, 'example' => 'osspath/snapshot/{AppName}/{StreamName}.jpg', ], ], [ 'name' => 'JpgSequence', 'in' => 'query', 'schema' => [ 'description' => 'JPG的存储路径，用于序列截图。'."\n" .'- 目前仅支持生成jpg图片。'."\n" .'- 支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}'."\n" .'- {UnixTimestamp}、{Sequence}必填一个', 'type' => 'string', 'required' => false, 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', ], ], [ 'name' => 'JpgOnDemand', 'in' => 'query', 'schema' => [ 'description' => 'JPG的存储路径，用于按需截图。'."\n" .'- 目前仅支持生成jpg图片。'."\n" .'- 支持变量匹配，包含{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}'."\n" .'- {UnixTimestamp}、{Sequence}必填一个', 'type' => 'string', 'required' => false, 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg', ], ], [ 'name' => 'Mp4', 'in' => 'query', 'schema' => [ 'description' => 'MP4的存储路径。'."\n" .'- 路径中支持变量匹配，可选{AppName}、{StreamName}、{Sequence}、{EscapedStartTime}、{EscapedEndTime}'."\n" .'- 必须包含{EscapedStartTime}和{EscapedEndTime}', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', ], ], [ 'name' => 'Flv', 'in' => 'query', 'schema' => [ 'description' => 'FLV的存储路径。格式参考Mp4说明。', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', ], ], [ 'name' => 'HlsM3u8', 'in' => 'query', 'schema' => [ 'description' => 'HLS的存储路径，m3u8文件。格式参考Mp4说明。', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', ], ], [ 'name' => 'HlsTs', 'in' => 'query', 'schema' => [ 'description' => 'HLS的存储路径，ts文件。'."\n" .'- 路径中支持变量匹配，可选{AppName}、{StreamName}、{UnixTimestamp}、{Sequence}'."\n" .'- 必须包含{UnixTimestamp}和{Sequence}变量', 'type' => 'string', 'required' => false, 'example' => 'osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}', ], ], [ 'name' => 'Callback', 'in' => 'query', 'schema' => [ 'description' => '模板执行后的回调。', 'type' => 'string', 'required' => false, 'example' => 'http://example.com/callback', ], ], [ 'name' => 'TransConfigsJSON', 'in' => 'query', 'schema' => [ 'description' => '转码配置TransConfig类型的数组，JSON格式字符串', 'type' => 'string', 'required' => false, 'example' => '[{"Fps":25,"Gop":50,"Height":720,"VideoCodec":"h264","Width":1280,"Name":"sd","VideoBitrate":800}]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '模板ID。', 'type' => 'string', 'example' => '323*****998-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Id\\": \\"323*****998-cn-qingdao\\",\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '修改模板', 'summary' => '修改模板信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeTemplate' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '模板类型。取值：'."\n" .'- record（录制）'."\n" .'- snapshot（截图）'."\n" .'- transcode（转码）'."\n" .'- timeshift（时移）', 'type' => 'string', 'example' => 'record', ], 'Trigger' => [ 'description' => '模板触发类型。取值：'."\n" .'- auto（自动）'."\n" .'- ondemand（按需）'."\n" .'> 仅限录制模板。', 'type' => 'string', 'example' => 'auto', ], 'HlsTs' => [ 'description' => 'HLS的存储路径，ts文件。'."\n" .'> 仅限录制模板。', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}', ], 'Mp4' => [ 'description' => 'MP4的存储路径。'."\n" .'> 仅限录制模板。', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', ], 'JpgOverwrite' => [ 'description' => 'JPG的存储路径，用于覆盖截图。'."\n" .'> 仅限截图模板。', 'type' => 'string', 'example' => 'osspath/snapshot/{AppName}/{StreamName}.jpg', ], 'Callback' => [ 'description' => '模板执行后的回调。', 'type' => 'string', 'example' => 'http://example.com/callback', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Description' => [ 'description' => '模板描述。', 'type' => 'string', 'example' => '录制模板', ], 'Region' => [ 'description' => 'OSS所属区域，即服务中心。', 'type' => 'string', 'example' => 'cn-qingdao', ], 'Retention' => [ 'description' => '时移保存周期，单位：天'."\n" .'> 仅限时移模板。', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'HlsM3u8' => [ 'description' => 'HLS的存储路径，m3u8文件。'."\n" .'> 仅限录制模板。', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', ], 'Name' => [ 'description' => '模板名称。', 'type' => 'string', 'example' => '录制模板', ], 'Flv' => [ 'description' => 'FLV的存储路径。'."\n" .'> 仅限录制模板。', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', ], 'CreatedTime' => [ 'description' => '模板创建时间。', 'type' => 'string', 'example' => '2020-12-10T10:00:00Z', ], 'OssEndpoint' => [ 'description' => 'OSS的域名。', 'type' => 'string', 'example' => 'oss-cn-qingdao.aliyuncs.com', ], 'OssFilePrefix' => [ 'description' => 'OSS文件前缀', 'type' => 'string', 'example' => 'oss-prefix', ], 'JpgOnDemand' => [ 'description' => 'JPG的存储路径，用于按需截图。'."\n" .'> 仅限截图模板。', 'type' => 'string', 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg', ], 'OssBucket' => [ 'description' => 'OSS的Bucket。', 'type' => 'string', 'example' => 'my_oss_bucket', ], 'FileFormat' => [ 'description' => '存储文件格式，多值用逗号分隔。取值：mp4,flv,hls,jpg', 'type' => 'string', 'example' => 'hls', ], 'JpgSequence' => [ 'description' => 'JPG的存储路径，用于序列截图。'."\n" .'> 仅限截图模板。', 'type' => 'string', 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', ], 'Interval' => [ 'description' => '操作周期，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3600', ], 'Id' => [ 'description' => '模板ID。', 'type' => 'string', 'example' => '323*****998-cn-qingdao', ], 'TransConfigs' => [ 'description' => '转码配置列表。'."\n" .'> 仅限转码模板。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Gop' => [ 'description' => '视频Gop，单位：帧', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'Width' => [ 'description' => '视频宽度', 'type' => 'integer', 'format' => 'int64', 'example' => '1280', ], 'VideoBitrate' => [ 'description' => '视频比特率，单位：kbps', 'type' => 'integer', 'format' => 'int64', 'example' => '800', ], 'Height' => [ 'description' => '视频高度', 'type' => 'integer', 'format' => 'int64', 'example' => '720', ], 'VideoCodec' => [ 'description' => '视频编码', 'type' => 'string', 'example' => 'h264', ], 'Fps' => [ 'description' => '视频帧率，单位：fps', 'type' => 'integer', 'format' => 'int64', 'example' => '25', ], 'Name' => [ 'description' => '转码规则名称，转码规则名称将作为转码流后缀，建议按使用习惯设置为sd，200k等易辨识后缀，只支持数字和字母', 'type' => 'string', 'example' => 'sd', ], 'Id' => [ 'description' => '转码配置ID。', 'type' => 'string', 'example' => '399*****430-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '查询模板', 'summary' => '查询模板信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeTemplates' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '模板ID', 'type' => 'string', 'required' => false, 'example' => '323434****83423432', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '按模板类型查询。', 'type' => 'string', 'required' => false, 'example' => 'record', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '按绑定的实例ID查询。', 'type' => 'string', 'required' => false, 'example' => '323*****998-cn-qingdao', ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => '按给定字段排序，默认按ID排序。', 'type' => 'string', 'required' => false, 'example' => 'id', ], ], [ 'name' => 'SortDirection', 'in' => 'query', 'schema' => [ 'description' => '排序方式，默认升序。取值：'."\n" .'- asc（升序）'."\n" .'- desc（降序）', 'type' => 'string', 'required' => false, 'example' => 'asc', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页大小，默认为20。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几个分页，默认为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => '第几个分页。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'RequestId' => [ 'description' => '请求ID。', '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' => '模板类型。取值：'."\n" .'- record（录制）'."\n" .'- snapshot（截图）'."\n" .'- transcode（转码）'."\n" .'- timeshift（时移）', 'type' => 'string', 'example' => 'record', ], 'Trigger' => [ 'description' => '模板触发类型。取值：'."\n" .'- auto（自动）'."\n" .'- ondemand（按需）'."\n" .'> 仅限录制模板。', 'type' => 'string', 'example' => 'auto', ], 'OssFilePrefix' => [ 'description' => 'OSS文件前缀。', 'type' => 'string', 'example' => 'my_prefix', ], 'HlsTs' => [ 'description' => 'HLS的存储路径，ts文件。'."\n" .'> 仅限录制模板。', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}', ], 'Mp4' => [ 'description' => 'MP4的存储路径。'."\n" .'> 仅限录制模板。', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', ], 'JpgOnDemand' => [ 'description' => 'JPG的存储路径，用于按需截图。'."\n" .'> 仅限截图模板。', 'type' => 'string', 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg', ], 'OssBucket' => [ 'description' => 'OSS的Bucket。', 'type' => 'string', 'example' => 'my_oss_bucket', ], 'JpgSequence' => [ 'description' => 'JPG的存储路径，用于序列截图。'."\n" .'> 仅限截图模板。', 'type' => 'string', 'example' => 'osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg', ], 'JpgOverwrite' => [ 'description' => 'JPG的存储路径，用于覆盖截图。'."\n" .'> 仅限截图模板。', 'type' => 'string', 'example' => 'osspath/snapshot/{AppName}/{StreamName}.jpg', ], 'FileFormat' => [ 'description' => '存储文件格式，多值用逗号分隔。取值：mp4,flv,hls,jpg', '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' => 'OSS所属区域，即服务中心。', 'type' => 'string', 'example' => 'cn-qingdao', ], 'Retention' => [ 'description' => '时移保存周期，单位：天'."\n" .'> 仅限时移模板。', 'type' => 'integer', 'format' => 'int64', 'example' => '3', ], 'HlsM3u8' => [ 'description' => 'HLS的存储路径，m3u8文件。'."\n" .'> 仅限录制模板。', 'type' => 'string', 'example' => 'osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}', ], 'Flv' => [ 'description' => 'FLV的存储路径。'."\n" .'> 仅限录制模板。', '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' => 'OSS的域名。', 'type' => 'string', 'example' => 'oss-cn-qingdao.aliyuncs.com', ], 'Id' => [ 'description' => '模板ID。', 'type' => 'string', 'example' => '323*****998-cn-qingdao', ], 'TransConfigs' => [ 'description' => '转码配置列表。'."\n" .'> 仅限转码模板。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Gop' => [ 'description' => '视频Gop，单位：帧', 'type' => 'integer', 'format' => 'int64', 'example' => '50', ], 'Width' => [ 'description' => '视频宽度', 'type' => 'integer', 'format' => 'int64', 'example' => '1280', ], 'VideoBitrate' => [ 'description' => '视频比特率，单位：kbps', 'type' => 'integer', 'format' => 'int64', 'example' => '800', ], 'Height' => [ 'description' => '视频高度', 'type' => 'integer', 'format' => 'int64', 'example' => '720', ], 'VideoCodec' => [ 'description' => '视频编码', 'type' => 'string', 'example' => 'h264', ], 'Fps' => [ 'description' => '视频帧率，单位：fps', 'type' => 'integer', 'format' => 'int64', 'example' => '25', ], 'Name' => [ 'description' => '转码规则名称，转码规则名称将作为转码流后缀，建议按使用习惯设置为sd，200k等易辨识后缀，只支持数字和字母', 'type' => 'string', 'example' => 'sd', ], 'id' => [ 'description' => '转码配置ID。', 'type' => 'string', 'example' => '399788187729597430-cn-qingdao', ], ], ], ], ], ], ], ], ], ], ], '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' => '查询模板列表', 'summary' => '查询模板列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'BindTemplate' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', ], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => [ 'description' => '模板类型。取值：'."\n" .'- record（录制）'."\n" .'- snapshot（截图）', 'type' => 'string', 'required' => false, 'example' => 'record', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '323*****994-cn-qingdao', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => '实例类型。取值：'."\n" .'- group（空间）'."\n" .'- stream（流）', 'type' => 'string', 'required' => true, 'example' => 'group', ], ], [ 'name' => 'ApplyAll', 'in' => 'query', 'schema' => [ 'description' => '是否强制应用到范围内的所有流，默认false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Replace', 'in' => 'query', 'schema' => [ 'description' => '是否强制替换已有绑定，默认false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'InstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => '323*****994-cn-qingdao', ], 'InstanceType' => [ 'description' => '实例类型。', 'type' => 'string', 'example' => 'group', ], 'TemplateId' => [ 'description' => '模板ID。', 'type' => 'string', 'example' => '323*****998-cn-qingdao', ], ], ], ], ], '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' => '绑定模板到指定实例', 'summary' => '绑定模板到指定的实例，比如：绑定到空间和流的实例。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UnbindTemplate' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => '模板ID。', 'type' => 'string', 'required' => false, 'example' => '323*****998-cn-qingdao', ], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => [ 'description' => '模板类型。取值：'."\n" .'- record（录制）'."\n" .'- snapshot（截图）', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'record' => 'record', 'snapshot' => 'snapshot', ], 'example' => 'record', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '323*****994-cn-qingdao', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => '实例类型。取值：'."\n" .'- group（空间）'."\n" .'- stream（流）', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'stream' => 'stream', 'group' => 'group', ], 'example' => 'group', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TemplateType' => [ 'description' => '模板类型。', 'type' => 'string', 'example' => 'record', ], 'InstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => '323*****994-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'InstanceType' => [ 'description' => '实例类型。', 'type' => 'string', 'example' => 'group', ], 'TemplateId' => [ 'description' => '模板ID。', 'type' => 'string', 'example' => '323*****998-cn-qingdao', ], ], ], ], ], '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' => '解除绑定模板到指定的实例', 'summary' => '解除绑定模板到指定的实例，比如：解除绑定到空间和流的实例。', 'description' => '>模板ID和模板类型至少指定一个。', ], 'BatchBindTemplate' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID，多值用逗号分隔。', 'type' => 'string', 'required' => true, 'example' => '323*****994-cn-qingdao', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => '实例类型。取值：'."\n" .'- group（空间）'."\n" .'- stream（流）', 'type' => 'string', 'required' => true, 'example' => 'group', ], ], [ 'name' => 'ApplyAll', 'in' => 'query', 'schema' => [ 'description' => '是否强制应用到范围内的所有流，默认false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Replace', 'in' => 'query', 'schema' => [ 'description' => '是否强制替换已有绑定，默认false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Bindings' => [ 'description' => '结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '错误信息。'."\n" .'> 仅当操作出错时存在。', 'type' => 'string', 'example' => 'some error', ], 'InstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => '323*****994-cn-qingdao', ], 'InstanceType' => [ 'description' => '实例类型。', 'type' => 'string', 'example' => 'group', ], 'TemplateId' => [ 'description' => '模板ID。', 'type' => 'string', 'example' => '323*****998-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '批量绑定模板到多个实例', 'summary' => '绑定模板到指定的多个实例，比如：绑定到空间和流的实例。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'BatchUnbindTemplate' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => '模板ID，省略时解除实例上符合条件的所有绑定。', 'type' => 'string', 'required' => false, 'example' => '323*****998-cn-qingdao', ], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => [ 'description' => '模板类型。取值：'."\n" .'- record（录制）'."\n" .'- snapshot（截图）', 'type' => 'string', 'required' => false, 'example' => 'record', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID，多值用逗号分隔。', 'type' => 'string', 'required' => true, 'example' => '323*****994-cn-qingdao', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => '实例类型。取值：'."\n" .'- group（空间）'."\n" .'- stream（流）', 'type' => 'string', 'required' => true, 'example' => 'group', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Bindings' => [ 'description' => '结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '错误信息。'."\n" .'> 仅当操作出错时存在。', 'type' => 'string', 'example' => 'some error', ], 'InstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => '323*****994-cn-qingdao', ], 'InstanceType' => [ 'description' => '实例类型。', 'type' => 'string', 'example' => 'group', ], 'TemplateId' => [ 'description' => '模板ID。', 'type' => 'string', 'example' => '323*****998-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '批量解除绑定模板到指定的实例', 'summary' => '解除绑定模板到指定的多个实例，比如：解除绑定到空间和流的实例。', 'description' => '> 模板ID和模板类型至少指定一个。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'BatchBindTemplates' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => '323*****998-cn-qingdao', ], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => [ 'description' => '模板类型。取值：'."\n" .'- record（录制）'."\n" .'- snapshot（截图）', 'type' => 'string', 'required' => false, 'example' => 'timeshift', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '323*****994-cn-qingdao', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => '实例类型。取值：'."\n" .'- group（空间）'."\n" .'- stream（流）', 'type' => 'string', 'required' => true, 'example' => 'stream', ], ], [ 'name' => 'ApplyAll', 'in' => 'query', 'schema' => [ 'description' => '是否强制应用到范围内的所有流，默认false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Replace', 'in' => 'query', 'schema' => [ 'description' => '是否强制替换已有绑定，默认false。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '20D0DFCE-5DB7-5D83-BD82-8482F2327636', ], 'Results' => [ 'description' => '结果列表。', 'type' => 'array', 'items' => [ 'description' => 'Bindings', 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '错误信息。'."\n" ."\n" .'> 仅当操作出错时存在。'."\n", 'type' => 'string', 'example' => 'some error', ], 'InstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => '323*****994-cn-qingdao ', ], 'InstanceType' => [ 'description' => '实例类型。', 'type' => 'string', 'example' => 'group', ], 'TemplateId' => [ 'description' => '模板ID。', 'type' => 'string', 'example' => '323*****998-cn-qingdao ', ], ], ], ], ], ], ], ], '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' => '批量绑定模板', 'summary' => '批量绑定模板。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'BatchUnbindTemplates' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'description' => '模板ID。', 'type' => 'string', 'required' => false, 'example' => '323*****998-cn-qingdao', ], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => [ 'description' => '模板类型。取值：'."\n" .'- record（录制）'."\n" .'- snapshot（截图）', 'type' => 'string', 'required' => false, 'example' => 'record', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => '400941290881239938-cn-beijing', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => '实例类型。取值：'."\n" .'- group（空间）'."\n" .'- stream（流）', 'type' => 'string', 'required' => true, 'example' => 'stream', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '90B377DF-C874-5BBD-B957-42C4C06AFECE', ], 'Results' => [ 'description' => '结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '错误信息。'."\n" .'> 仅当操作出错时存在。', 'type' => 'string', 'example' => 'some error', ], 'TemplateType' => [ 'description' => '模板类型。', 'type' => 'string', 'example' => 'snapshot', ], 'InstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => '323*****994-cn-qingdao', ], 'InstanceType' => [ 'description' => '实例类型。', 'type' => 'string', 'example' => 'group', ], 'TemplateId' => [ 'description' => '模板ID。', 'type' => 'string', 'example' => '323*****998-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '批量解除绑定模板', 'summary' => '批量解除绑定模板。', ], 'StartRecordStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID。', 'type' => 'string', 'required' => false, 'example' => '323*****997-cn-qingdao', ], ], [ 'name' => 'PlayDomain', 'in' => 'query', 'schema' => [ 'description' => '流的播放域名。', 'type' => 'string', 'required' => false, 'example' => 'example.com', ], ], [ 'name' => 'App', 'in' => 'query', 'schema' => [ 'description' => '流的App名称。', 'type' => 'string', 'required' => false, 'example' => 'live', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '流名。', 'type' => 'string', 'required' => false, 'example' => '310000*****000002', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '启动按需录制', 'summary' => '对指定流启动按需录制。', 'description' => '> - 需要配合按需录制模板使用，请先在空间或者流上绑定按需录制模板。'."\n" .'> - 有两种方式可以指定某条流，一种是通过Id，另一种是通过PlayDomain/App/Name。', ], 'StopRecordStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '流ID。', 'type' => 'string', 'required' => false, 'example' => '323*****997-cn-qingdao', ], ], [ 'name' => 'PlayDomain', 'in' => 'query', 'schema' => [ 'description' => '流的播放域名。', 'type' => 'string', 'required' => false, 'example' => 'example.com', ], ], [ 'name' => 'App', 'in' => 'query', 'schema' => [ 'description' => '流的App名称。', 'type' => 'string', 'required' => false, 'example' => 'live', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '流名。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '停止按需录制', 'summary' => '对指定流停止按需录制。', 'description' => '> 有两种方式可以指定某条流，一种是通过Id，另一种是通过PlayDomain/App/Name。', ], 'DescribeRecords' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '按存储记录类型查询。取值范围：'."\n" .'- record（录制）'."\n" .'- snapshot（截图）', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'record' => 'record', 'snapshot' => 'snapshot', ], 'example' => 'record', ], ], [ 'name' => 'StreamId', 'in' => 'query', 'schema' => [ 'description' => '按流ID查询。', 'type' => 'string', 'required' => true, 'example' => '323*****997-cn-qingdao', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '按开始时间查询。', 'type' => 'string', 'required' => true, 'example' => '2021-11-22T00:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '按结束时间查询。', 'type' => 'string', 'required' => true, 'example' => '2021-11-24T00:00:00Z', ], ], [ 'name' => 'PrivateBucket', 'in' => 'query', 'schema' => [ 'description' => '是否使用私有Bucket。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => '按给定字段排序，取值范围：'."\n" .'- Id（默认）', 'type' => 'string', 'required' => false, 'example' => 'Id', ], ], [ 'name' => 'SortDirection', 'in' => 'query', 'schema' => [ 'description' => '排序方式。取值范围：'."\n" .'- asc（升序）（默认）'."\n" .'- desc（降序）', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'asc' => 'asc', 'desc' => 'desc', ], 'example' => 'asc', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页大小，默认值：20。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几个分页，默认值：1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => '第几个分页。'."\n" .'> 仅限录制查询。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'NextStartTime' => [ 'description' => '查询下个记录的开始时间。'."\n" .'> 仅限截图查询。', 'type' => 'string', 'example' => '2018-12-10T11:00:00Z', ], 'PageSize' => [ 'description' => '分页大小。'."\n" .'> 仅限录制查询。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'TotalCount' => [ 'description' => '存储记录总数。'."\n" .'> 仅限录制查询。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', ], 'PageCount' => [ 'description' => '分页总数。'."\n" .'> 仅限录制查询。', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], 'Records' => [ 'description' => '存储记录列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '存储记录类型。取值范围：'."\n" .'- record（录制）'."\n" .'- snapshot（截图）', 'type' => 'string', 'example' => 'record', ], 'Height' => [ 'description' => '高度。', 'type' => 'integer', 'format' => 'int64', 'example' => '1080', ], 'Url' => [ 'description' => '存储文件的URL。', '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' => '存储文件的Bucket。', 'type' => 'string', 'example' => 'my_oss_bucket', ], 'FileFormat' => [ 'description' => '存储文件格式。取值范围：'."\n" .'- mp4'."\n" .'- flv'."\n" .'- hls'."\n" .'- jpg', 'type' => 'string', 'example' => 'hls', ], 'StreamId' => [ 'description' => '流ID。', 'type' => 'string', 'example' => '323*****997-cn-qingdao', ], 'OssObject' => [ 'description' => '存储文件的Object。', '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' => '模板ID。', 'type' => 'string', 'example' => '388*****204-cn-qingdao', ], 'Id' => [ 'description' => '存储记录ID。'."\n" .'> 仅限录制查询。', 'type' => 'string', 'example' => '2be2a673-6033-4874-b6f2-f2bc0a1*****', ], 'OssEndpoint' => [ 'description' => 'OSS接入点。', 'type' => 'string', 'example' => 'oss-cn-qingdao.aliyuncs.com', ], ], ], ], ], ], ], ], '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":""}]', 'title' => '查询录制记录列表', 'summary' => '查询录制记录列表。', 'description' => '> 截图查询目前不支持分页，仅支持按迭代方式。使用返回结果里的extStartTime参数值，作为新请求的StartTime可请求下一页。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'SetVsDomainCertificate' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '指定证书所属加速域名。'."\n" ."\n" .'> 域名需要属于HTTPS加速类型。', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'SSLProtocol', 'in' => 'query', 'schema' => [ 'description' => 'HTTPS证书是否启用。取值：'."\n" ."\n" .'- **on**：启用。'."\n" .'- **off**（默认值）：不启用。', 'type' => 'string', 'required' => true, 'example' => 'on', ], ], [ 'name' => 'CertName', 'in' => 'query', 'schema' => [ 'description' => '证书名称。'."\n", 'type' => 'string', 'required' => false, 'example' => 'Cert-77****7', ], ], [ 'name' => 'CertType', 'in' => 'query', 'schema' => [ 'description' => '证书类型。'."\n" .'- upload（上传证书）'."\n" .'- cas（云盾证书）'."\n" .'- free（个人测试证书（免费版））', 'type' => 'string', 'required' => false, 'example' => 'free', 'enum' => [ 'free', 'cas', 'upload', ], ], ], [ 'name' => 'SSLPub', 'in' => 'query', 'schema' => [ 'description' => '安全证书内容，不启用证书则无需输入，配置证书请输入证书内容。', 'type' => 'string', 'required' => false, 'example' => '328uiuii28****82dsada81', ], ], [ 'name' => 'SSLPri', 'in' => 'query', 'schema' => [ 'description' => '私钥内容，不启用证书则无需输入，配置证书请输入私钥内容。', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxx', ], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => '地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-qingdao', ], ], [ 'name' => 'ForceSet', 'in' => 'query', 'schema' => [ 'description' => '设置为1时，忽略证书名称重复的校验，覆盖原有同名证书信息。'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '119F7639-4646-51A4-B6C1-300D391C0104', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"119F7639-4646-51A4-B6C1-300D391C0104\\"\\n}","type":"json"}]', 'title' => '设置域名证书信息', 'summary' => '设置某域名下证书功能是否启用。', 'extraInfo' => '# 特殊错误码'."\n" .'|ErrorCode错误码|Message错误信息|HTTP状态|语义|'."\n" .'|:-----|:-----|:-----|:-----|'."\n" .'|InvalidDomain.NotFound|The domain provided does not belong to you.|404|域名不存在或不属于当前用户。|'."\n" .'|IllegalOperation|Illegal domain operate is not permitted.|403|没有权限执行当前操作。|'."\n" .'|ServiceBusy|The specified Domain is configuring, please retry later.|403|域名正在配置中，请稍后再试。|'."\n" .'|InvalidDomain.Offline|The domain provided is offline.|400|域名已下线。|'."\n" .'|OperationDenied|Your CDN service is suspended.|403|该账号已经欠费，请充值。|'."\n" .'|InvalidSSLProtocol.ValueNotSupported|The specified value of parameter Enable is not supported.|400|SSLProtocol的值不合法。|'."\n" .'|SSLPub.MissingParameter|An input parameter SSLPub that is mandatory for processing the request is not supplied.|400|SSLPub参数缺失。|'."\n" .'|SSLPri.MissingParameter|An input parameter SSLPri that is mandatory for processing the request is not supplied.|400|SSLPri参数缺失。|'."\n" .'|InvalidCertificate|The Certificate you provided is malformed!|400|证书内容不合法。|'."\n" .'|InvalidSSLPri|The SSLPri you provided is malformed!|400|私钥内容不合法。|'."\n" .'|Certificate.MissMatch|The SSLPri does not math the specified Certificate!|400|证书和私钥不匹配。|'."\n" .'|InvalidCertificate.TooLong|The Certificate you provided is over the max length!|400|证书内容超过长度限制。|'."\n" .'|InvalidCertName.TooLong|The Certificate name you provided is over the max length 128!|400|证书名称不能超过128个字符。|'."\n" .'|SetDomainSSLPub.ParameterError|Parameters have error.|400|参数错误。|'."\n" .'|Certificate.StatusError|Certificate is not exist or its status is error.|400|证书不存在或证书状态错误。|'."\n" .'|DeleteFailed|Delete certificate is failed.|400|删除证书失败。|'."\n" .'|Certificate.NotFind|Not find the certificate info.|400|没有查到相应证书。|'."\n" .'|Certificate.Duplicated|The certificate name is duplicated.|400|证书名称重复。|'."\n" .'|Certificate.FormatError|The certificate format is error.|400|证书格式错误。|'."\n" .'|Certificate.StatusError|The certificate status is error.|400|证书状态错误。|'."\n" .'|Certificate.KeyNull|The SSLPri is not null.|400|私钥不能为空。|'."\n" .'|SSLPri.Malformed|The SSLPri format is error.|400|私钥格式错误。|'."\n" .'|Certificate.NotPermittedOff|Turn off certificate will change domain scheduling, please contact customer service.|400|关闭证书会影响该域名调度，请联系客户调整。|'."\n" .'|Certificate.SettedNotEffect|Certificate was successfully setted but does’t take effect for protecting current service, please contact customer service.|400|证书已经设置成功，但为保护当前服务还未生效，请联系客服处理。|', ], 'DescribeVsCertificateDetail' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'CertName', 'in' => 'query', 'schema' => [ 'description' => '证书名称', 'type' => 'string', 'required' => true, 'example' => 'cert-539xxxx', ], ], ], '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' => '证书id', 'type' => 'integer', 'format' => 'int64', 'example' => '63000000', ], 'RequestId' => [ 'description' => '本次操作请求ID', 'type' => 'string', 'example' => 'D94D0E1E-E71B-562D-8C18-969BB3653FBD', ], ], ], ], ], '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' => '获取证书详情', 'summary' => '获取证书详细信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeVsDomainCertificateInfo' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '域名', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'CertInfos' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'CertInfo' => [ 'description' => '证书信息。'."\n", 'type' => 'array', 'items' => [ 'description' => '证书信息。'."\n", 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '证书状态。'."\n" .' - **success**：已生效。'."\n" ."\n" .' - **checking**：检测域名是否在阿里云CDN。'."\n" ."\n" .' - **cname_error**：域名没有切到阿里云CDN。'."\n" ."\n" .' - **top_domain_cname_error**：顶级域名没有切到阿里云CDN。'."\n" ."\n" .' - **domain_invalid**：域名包含非法字符。'."\n" ."\n" .' - **unsupport_wildcard**：不支持泛域名。'."\n" ."\n" .' - **applying**：证书申请中。'."\n" ."\n" .' - **get_token_timeout**：证书申请超时。'."\n" ."\n" .' - **check_token_timeout**：校验超时。'."\n" ."\n" .' - **get_cert_timeout**：获取证书超时。'."\n" ."\n" .' - **failed**：证书申请失败。', 'type' => 'string', 'example' => 'success', ], 'CertLife' => [ 'description' => '证书时长单位。'."\n" ."\n" .'- **months**：月。'."\n" ."\n" .'- **years**：年。', 'type' => 'string', 'example' => 'months', ], 'CertExpireTime' => [ 'description' => '证书过期时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2018-06-03T22:03:39Z', ], 'SSLPub' => [ 'description' => '证书公钥。', 'type' => 'string', 'example' => 'asdadaxxxx', ], 'CertType' => [ 'description' => '证书类型。'."\n" ."\n" .'- **free**：个人测试证书（免费版）。'."\n" ."\n" .'- **cas**：云盾证书。'."\n" ."\n" .'- **upload**：自定义上传。', 'type' => 'string', 'example' => 'free', ], 'ServerCertificateStatus' => [ 'description' => 'https开启状态。'."\n" ."\n" .'- **on**：已开启。'."\n" .'- **off**：未开启。', 'type' => 'string', 'example' => 'on', ], 'CertDomainName' => [ 'description' => '证书匹配的域名。'."\n", 'type' => 'string', 'example' => 'example.com', ], 'CertName' => [ 'description' => '证书名称。', 'type' => 'string', 'example' => 'myname', ], 'CertOrg' => [ 'description' => '该证书签发的CA名称。', 'type' => 'string', 'example' => 'Let\'s Encrypt', ], 'DomainName' => [ 'description' => '加速域名。'."\n", 'type' => 'string', 'example' => 'example.com', ], ], ], ], ], ], ], ], ], ], '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"}]', 'title' => '获取指定加速域名证书信息', 'summary' => '获取指定加速域名证书信息。', ], 'DescribeVsCertificateList' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '域名', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '本次调用的请求id', 'type' => 'string', 'example' => '6E310519-E035-51AB-80D4-C1CBECD39EB5', ], 'CertificateListModel' => [ 'description' => '证书id', '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' => '证书id'."\n" ."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '6338888', ], 'Common' => [ 'description' => '证书中的CN属性，一般是一个域名。', 'type' => 'string', 'example' => 'example.aliyundoc.com', ], ], ], ], ], ], ], ], ], ], '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' => '获取证书列表', 'summary' => '获取域名证书列表信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribeVsDomainDetail' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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' => 'HTTPS证书是否启用。取值：'."\n" ."\n" .'- **on**：启用。'."\n" ."\n" .'- **off**（默认值）：不启用。', 'type' => 'string', 'example' => 'off', ], 'Region' => [ 'description' => '域名所在区域。', 'type' => 'string', 'example' => 'cn-qingdao', ], 'Scope' => [ 'description' => '加速区域。取值范围：'."\n" .'- **domestic**'."\n" .'- **overseas**'."\n" .'- **global**', 'type' => 'string', 'example' => 'domestic', ], 'Cname' => [ 'description' => '为视图计算域名生成的一个CNAME域名，需要在域名解析服务商处将域名CNAME解析到该域名。', 'type' => 'string', 'example' => 'example.aliyundoc.com.*****.com', ], 'DomainStatus' => [ 'description' => '视图计算加速域名运行状态。取值：'."\n" ."\n" .'- **online**：启用。'."\n" ."\n" .'- **offline**：停用。'."\n" ."\n" .'- **configuring**：配置中。', 'type' => 'string', 'example' => 'online', ], 'GmtModified' => [ 'description' => '最近修改时间。', 'type' => 'string', 'example' => '2021-07-19T10:27:23Z', ], 'DomainName' => [ 'description' => '视图计算域名名称。', 'type' => 'string', 'example' => 'example.aliyundoc.com', ], 'DomainType' => [ 'description' => '域名类型。'."\n" ."\n" .'> 固定值：vs', 'type' => 'string', 'example' => 'vs', ], ], ], ], ], ], ], '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":""}]', 'title' => '查询域名信息', 'summary' => '获取指定视图计算域名配置的基本信息。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => '# 特殊错误码'."\n" .'|ErrorCode错误码|Message错误信息|HTTP状态|语义|'."\n" .'|:-----|:-----|:-----|:-----|'."\n" .'|InvalidDomain.NotFound|The domain provided does not belong to you.|404|域名不存在或不属于当前用户。|'."\n" .'|ServiceBusy|The specified Domain is configuring, please retry again later.|403|域名正在配置中，请稍后再试。|', ], 'DescribeVsDomainConfigs' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '您的加速域名。', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'FunctionNames', 'in' => 'query', 'schema' => [ 'description' => '功能列表名称。'."\n" ."\n" .'> 支持多个，用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => 'path_based_ttl_set,oss_auth', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'D94D0E1E-E71B-562D-8C18-969BB3653FBD', ], 'DomainConfigs' => [ 'description' => '域名配置。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '状态。取值包括：'."\n" .'- success'."\n" .'- testing'."\n" .'- failed'."\n" .'- configuring', 'type' => 'string', 'example' => 'success', ], 'ConfigId' => [ 'description' => '配置ID。', 'type' => 'string', 'example' => '6295', ], 'FunctionName' => [ 'description' => 'function名称。', 'type' => 'string', 'example' => 'aliauth', ], 'FunctionArgs' => [ 'description' => '各个function。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ArgName' => [ 'description' => '配置名称。', 'type' => 'string', 'example' => 'auth_type', ], 'ArgValue' => [ 'description' => '配置值。', 'type' => 'string', 'example' => 'req_auth', ], ], ], ], ], ], ], ], ], ], ], '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":""}]', 'title' => '查询域名配置', 'summary' => '查询域名配置，一次可查询多个功能配置。', 'requestParamsDescription' => '### 功能说明'."\n" .'| 名称 | 参数 |'."\n" .'| ---- | ---- |'."\n" .'| referer_white_list_set | refer白名单。 |'."\n" .'| referer_black_list_set | refer黑名单。 |'."\n" .'| filetype_based_ttl_set | 文件过期时间设置。 |'."\n" .'| path_based_ttl_set | 目录过期时间设置。 |'."\n" .'| cc_defense | 防CC攻击。 |'."\n" .'| oss_auth | OSS鉴权Bucket。 |'."\n" .'| ip_black_list_set | IP黑名单。 |'."\n" .'| ip_white_list_set | IP白名单。 |'."\n" .'| error_page | 错误页面重定向。 |'."\n" .'| tesla | 页面优化加速。 |'."\n" .'| set_req_host_header | 修改回源自定义头。 |'."\n" .'| set_hashkey_args | 忽略URL参数。 |'."\n" .'| aliauth | 阿里鉴权。 |'."\n" .'| set_resp_header | 设置响应头（浏览器端可见）。 |'."\n" .'| video_seek | 视频切片拖拽开关。 |'."\n" .'| range | Range请求功能。 |'."\n" .'| gzip | 页面Gzip优化。 |'."\n" .'| https_force | 强制HTTPS跳转。 |'."\n" .'| http_force | 强制HTTP跳转。 |'."\n" .'| alilive | 视频直播配置。 |'."\n" .'| forward_scheme | 静态协议跟随回源。 |'."\n" .'| tmd_signature | 配置频次控制自定义规则。 |'."\n" .'| cdn_waf | WAF基础防护。 |', 'extraInfo' => '### 特殊错误码'."\n" .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" .'| ---- | ---- | ---- | ---- |'."\n" .'| InvalidFunctionName.ValueNotSupported | FunctionName %s is not supported. | 400 | 不支持的FunctionName %s（%s为具体功能名）。 |', ], 'BatchSetVsDomainConfigs' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DomainNames', 'in' => 'query', 'schema' => [ 'description' => '您的加速域名。'."\n" .'> 支持多个，用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'Functions', 'in' => 'query', 'schema' => [ 'description' => '功能列表。', 'type' => 'string', 'required' => true, 'example' => '[{“functionArgs”:[{“argName”:”domain_name”,”argValue”:”api.hellodtworld.com”}],”functionName”:”set_req_host_header”}]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '9BEC5E85-C76B-56EF-A922-860EFDB8B64B', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9BEC5E85-C76B-56EF-A922-860EFDB8B64B\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '批量配置域名', 'summary' => '域名批量配置。', 'requestParamsDescription' => '### Functions格式'."\n" ."\n" .'- [{“functionArgs”:[{“argName”:”domain_name”,”argValue”:”api.hellodtworld.com”}],”functionName”:”set_req_host_header”}]'."\n" ."\n" .'- 某些功能，如filetype_based_ttl_set，可以设置多条纪录，当需要更新其中某条纪录时，可通过该条纪录的configId来指定。[{“functionArgs”:[{“argName”:”file_type”,”argValue”:”jpg”},{“argName”:”ttl”,”argValue”:”18”},{“argName”:”weight”,”argValue”:”30”}],”functionName”:”filetype_based_ttl_set”,”configId”:5068995}]'."\n" ."\n" .'### 功能说明'."\n" .'所有参数值均按照字符串类型处理。'."\n" .'| 名称 | 参数 |'."\n" .'| ---- | ---- |'."\n" .'|referer_white_list_set：refer白名单|refer_domain_allow_list：白名单列表，多个逗号分隔；
allow_empty：是否允许空refer进入，取值范围：on/off|'."\n" .'|referer_black_list_set：refer黑名单|refer_domain_deny_list：黑名单列表，多个逗号分隔；
allow_empty：是否允许空refer进入，取值范围：on/off|'."\n" .'|filetype_based_ttl_set：文件过期时间设置|ttl：cache时间，单位：秒；
file_type：文件类型。支持多个，用（英文）逗号隔开，如：txt,jpg；
weight：权重。取值范围：1~199|'."\n" .'|path_based_ttl_set：目录过期时间设置|ttl：cache时间，单位：秒；
path：目录，必须以”/”开头；
weight：权重。取值范围：1~99|'."\n" .'|oss_auth：OSS鉴权Bucket|oss_bucket_id：用户bucket地址|'."\n" .'|ip_black_list_set：IP黑名单|ip_list：IP列表。多个用逗号（英文）隔开|'."\n" .'|ip_allow_list_set：IP白名单|ip_list：IP列表。多个用逗号（英文）隔开|'."\n" .'|ip_white_list_set：IP免拦截|ip_list：IP列表。多个用逗号（英文）隔开|'."\n" .'|error_page：错误页面重定向|error_code：错误码；
rewrite_page：重定向页面|'."\n" .'|set_req_host_header：修改回源自定义头|domain_name：回源Host头内容|'."\n" .'|set_hashkey_args：忽略URL参数|hashkey_args：保留参数的列表。多个用逗号（英文）分隔；
disable：disable等于on的时候表示忽略所有参数，off不忽略|'."\n" .'|aliauth：阿里鉴权|auth_type：鉴权类型，取值范围：”no_auth”，”type_a”，”type_b”，”type_c”；
auth_key1：鉴权key1；
auth_key2：鉴权key2；
ali_auth_delta：自定义鉴权缓冲时间|'."\n" .'|set_resp_header：设置响应头（浏览器端可见）| key：响应头，取值范围：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：响应头内容，删除填写null|'."\n" .'|https_force：强制HTTPS跳转|enable：功能开关，取值范围：on/off|'."\n" .'|http_force：强制HTTP跳转|enable：功能开关，取值范围：on/off|'."\n" .'|https_option：HTTPS基础参数|http2：http2开关，取值范围：on/off|'."\n" .'|l2_oss_key：L2 OSS回源私钥|private_oss_auth：是否开启私有OSS鉴权功能，取值范围：on/off|'."\n" .'|forward_scheme：静态协议跟随回源|enable：开关，取值范围：on/off；
scheme_origin：回源站协议，支持http、https和follow|'."\n" .'|green_manager 鉴黄功能|enable：是否开启鉴黄功能，取值范围：on/off|'."\n" .'|tmd_signature：配置频次控制自定义规则|name：规则名称，域名内不可重复；
path：可重复，需校验URI路径合法性；
pathType：匹配规则。0：前缀匹配，1：完全匹配；
interval：监测时长，单位秒，参数限制必须>=10；
count：单IP访问次数；
action：阻断类型。0：封禁，1：人机识别；
ttl：阻断时长，单位：秒；
|'."\n" .'|dynamic：全站加速相关配置|enable：开关（必填）。支持on/off；
static_route_type：静态加速文件后缀static_route_url：静态加速URI；
static_route_path：静态加速PATH；
dynamic_route_origin：回源路由scheme，支持http/https/follow；
|'."\n" .'|set_req_header：自定义回源HTTP头|key：回源头；
value：回源头内容|'."\n" .'|l2_oss_key：私有Bucket回源|private_oss_auth：私有Bucket回源开关，支持on/off|'."\n" .'|range：range回源|enable：开关，支持on/off/force|'."\n" .'|video_seek：视频拖拽播放|enable：开关，支持on/off|'."\n" .'|ali_remove_args：忽略URL参数（删除）|ali_remove_args：（必填）删除指定的参数，多个参数之间用空格隔开，剩余参数将作为hashkey中URL的args部分；
keep_oss_args：支持on/off。on表示回源保留所有参数，off表示与缓存hashkey的参数一致|'."\n" .'|https_tls_version：TLS协议版本|tls10：开启TLSv1.0。默认：on，支持on/off；
tls11：开启TLSv1.1。默认：on，支持on/off；
tls12：开启TLSv1.2。默认：on，支持on/off；
tls13：开启TLSv1.3。默认：off，支持on/off；
|'."\n" .'|HSTS：HSTS|enabled：开关（必填）。默认：off，支持on/off；
https_hsts_max_age：（必填）过期时间，单位：s，建议填写5184000s（60天）；
https_hsts_include_subdomains：HSTS头包含includeSubDomains参数，支持on/off。请谨慎开启，开启前，请确保该加速域名所有子域名都已开启HTTPS，否则会导致子域名自动跳转到HTTPS后无法访问|'."\n" .'|filetype_force_ttl_code：文件状态码过期时间设置|file_type：（必填）文件类型。支持多个，用逗号（英文）隔开，如：txt,jpg；
code_string：（必填）状态码。例：302=0，301=0，4xx=2|'."\n" .'|path_force_ttl_code：路径状态码过期时间设置|path：（必填）必须以/开头。举例：/image；
code_string：（必填）状态码。例：302=0，301=0，4xx=2|'."\n" .'|gzip：页面Gzip优化|enable：功能开关（必填）。支持on/off|'."\n" .'|tesla：页面优化加速|enable：功能开关（必填）。支持on/off|', 'extraInfo' => '### 特殊错误码'."\n" .'| 错误代码 | 描述 | HTTP状态码 | 语义 |'."\n" .'| ---- | ---- | ---- | ---- |'."\n" .'| InvalidFunctions.Malformed | Specified Functions is malformed. | 400 | 指定的 Functions 不合法。 |'."\n" .'| InvalidFunctionName.ValueNotSupported | FunctionName %s is not supported. | 400 | 不支持的FunctionName %s（%s为具体功能名）。 |'."\n" .'| InvalidArgName.ValueNotSupported | ArgName %s is not supported. | 400 | 不支持的ArgName %s（%s为具体参数名）。 |'."\n" .'| InvalidArgValue.Malformed | Specified ArgValue is malformed. | 400 | 指定的 ArgValue 不合法。 |', ], 'BatchDeleteVsDomainConfigs' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DomainNames', 'in' => 'query', 'schema' => [ 'description' => '您的加速域名，多个用英文半角逗号分隔', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'FunctionNames', 'in' => 'query', 'schema' => [ 'description' => '功能列表名称，多个用逗号分隔', 'type' => 'string', 'required' => true, 'example' => 'https_force', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '域名删除域名配置', 'summary' => '批量删除域名配置。', ], 'DescribeVsTopDomainsByFlow' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ
最小数据粒度为5分钟
不写默认读取当月数据', 'type' => 'string', 'required' => false, 'example' => '2021-12-12T10:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间需大于起始时间；日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => false, 'example' => '2018-12-10T18:00:00Z', ], ], [ 'name' => 'Limit', 'in' => 'query', 'schema' => [ 'description' => '域名获取数量限制，默认为20，取值支持1~100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '3', 'default' => '20', ], ], ], 'responses' => [ 200 => [ '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' => '本次操作请求ID', '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', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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' => '获取顶级域名', 'summary' => '获取用户按流量排名的域名'."\n" ."\n" .'不指定StartTime和EndTime时，默认读取当月的数据，同时支持按指定的起止时间查询，两者需要同时指定。'."\n" ."\n" .'* 最多可获取90天的数据。', ], 'SetPreset' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'PresetId', 'in' => 'query', 'schema' => [ 'description' => '预置位ID。 '."\n" .'取值：1~7', 'type' => 'string', 'required' => true, 'example' => '2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '30295DF1-1DC7-48BA-BE5A-D58E61EB2375', ], ], ], ], ], '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' => '设置预置位', 'summary' => '设置预置位。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'GotoPreset' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'PresetId', 'in' => 'query', 'schema' => [ 'description' => '预置位ID。', 'type' => 'string', 'required' => true, 'example' => '2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '30295DF1-1DC7-48BA-BE5A-D58E61EB2375', ], ], ], ], ], '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' => '移动至预置位', 'summary' => '移动至预置位。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeletePreset' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'PresetId', 'in' => 'query', 'schema' => [ 'description' => '预置位ID。', 'type' => 'string', 'required' => true, 'example' => '2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'F18FD685-B194-4489-9609-F80A9490A258', ], ], ], ], ], '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' => '删除预置位', 'summary' => '删除预置位。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DescribePresets' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '9FE0CA83-BFD3-4EBD-A429-FABB9B9AE772', ], 'Presets' => [ 'description' => '预置位列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => '预置位名称。', 'type' => 'string', 'example' => '预置位2', ], 'Id' => [ 'description' => '预置位ID。', 'type' => 'string', 'example' => '2', ], ], ], ], ], ], ], ], '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' => '查询预置位', 'summary' => '获取预置位列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'StopMove' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'Pan', 'in' => 'query', 'schema' => [ 'description' => '是否停止水平转动，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Tilt', 'in' => 'query', 'schema' => [ 'description' => '是否停止垂直转动，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Zoom', 'in' => 'query', 'schema' => [ 'description' => '是否停止缩放，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '停止转动镜头', 'summary' => '停止转动镜头，如水平、垂直、缩放等。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'StopAdjust' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'Iris', 'in' => 'query', 'schema' => [ 'description' => '是否停止调整光圈，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Focus', 'in' => 'query', 'schema' => [ 'description' => '是否停止调整变焦，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '停止调节镜头', 'summary' => '停止调节镜头，如光圈、变焦等。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ContinuousMove' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'Pan', 'in' => 'query', 'schema' => [ 'description' => '水平转动速度参数，正值表示向左水平转动。 '."\n" .'取值：-1.0~1.0', 'type' => 'string', 'required' => false, 'example' => '0.5', ], ], [ 'name' => 'Tilt', 'in' => 'query', 'schema' => [ 'description' => '垂直转动速度参数，正值表示向上水平转动。 '."\n" .'取值：-1.0~1.0', 'type' => 'string', 'required' => false, 'example' => '0.5', ], ], [ 'name' => 'Zoom', 'in' => 'query', 'schema' => [ 'description' => '缩放速度参数，正值表示放大。 '."\n" .'取值：-1.0~1.0', 'type' => 'string', 'required' => false, 'example' => '0.5', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '持续转动镜头', 'summary' => '持续转动镜头，如水平、垂直、缩放等。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ContinuousAdjust' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], [ 'name' => 'Iris', 'in' => 'query', 'schema' => [ 'description' => '光圈速度参数，正值表示光圈变大。 '."\n" .'取值：-1.0~1.0', 'type' => 'string', 'required' => false, 'example' => '0.5', ], ], [ 'name' => 'Focus', 'in' => 'query', 'schema' => [ 'description' => '变焦速度参数，正值表示焦距变远。 '."\n" .'取值：-1.0~1.0', 'type' => 'string', 'required' => false, 'example' => '0.5', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '持续调节镜头', 'summary' => '持续调节镜头，如光圈、变焦等。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateDirectory' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '目录名称。', 'type' => 'string', 'required' => true, 'example' => '目录1', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '目录描述。', 'type' => 'string', 'required' => false, 'example' => '目录1', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => '目录所属空间ID。', 'type' => 'string', 'required' => true, 'example' => '348*****174-cn-qingdao', ], ], [ 'name' => 'ParentId', 'in' => 'query', 'schema' => [ 'description' => '上级目录ID。'."\n" ."\n" .'> 创建设备空间时会默认创建空间对应的根目录，可通过 [DescribeDirectories](https://next.api.aliyun.com/document/vs/2018-12-12/DescribeDirectories) 接口查询对应根目录。', 'type' => 'string', 'required' => true, 'example' => '399*****774-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '目录ID。', 'type' => 'string', 'example' => '399*****488-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '创建目录', 'summary' => '创建新的目录。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'DeleteDirectory' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '目录ID。', 'type' => 'string', 'required' => true, 'example' => '348*****174-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '删除目录', 'summary' => '删除目录。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'ModifyDirectory' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '目录ID。', 'type' => 'string', 'required' => true, 'example' => '399*****488-cn-qingdao', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => [ 'description' => '目录名称。', 'type' => 'string', 'required' => false, 'example' => '目录2', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '目录描述。', 'type' => 'string', 'required' => false, 'example' => '目录2', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '目录ID。', 'type' => 'string', 'example' => '399*****488-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '修改目录', 'summary' => '修改目录信息。', ], 'DescribeDirectory' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '目录ID。', 'type' => 'string', 'required' => true, 'example' => '399*****488-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ParentId' => [ 'description' => '上级目录ID。', 'type' => 'string', 'example' => '399*****774-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Description' => [ 'description' => '目录描述。', 'type' => 'string', 'example' => '目录1', ], 'GroupId' => [ 'description' => '目录所属空间ID。', 'type' => 'string', 'example' => '348*****174-cn-qingdao', ], 'Name' => [ 'description' => '目录名称。', 'type' => 'string', 'example' => '目录1', ], 'CreatedTime' => [ 'description' => '目录创建时间。', 'type' => 'string', 'example' => '2021-09-10T10:00:00Z', ], 'Id' => [ 'description' => '目录ID。', 'type' => 'string', 'example' => '399*****488-cn-qingdao', ], ], ], ], ], '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' => '查询目录', 'summary' => '查询目录。', ], 'DescribeDirectories' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => '目录所属空间ID。', 'type' => 'string', 'required' => true, 'example' => '348*****174-cn-qingdao', ], ], [ 'name' => 'ParentId', 'in' => 'query', 'schema' => [ 'description' => '按上级目录ID查询。', 'type' => 'string', 'required' => false, 'example' => '399*****774-cn-qingdao', ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => '按给定字段排序，默认按ID排序。', 'type' => 'string', 'required' => false, 'example' => 'ID', ], ], [ 'name' => 'SortDirection', 'in' => 'query', 'schema' => [ 'description' => '排序方式，默认升序。取值：'."\n" .'- asc（升序）'."\n" .'- desc（降序）', 'type' => 'string', 'required' => false, 'example' => 'asc', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页大小，默认为20', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几个分页，默认为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'NoPagination', 'in' => 'query', 'schema' => [ 'description' => '是否禁用分页，默认false', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => '第几个分页。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'RequestId' => [ 'description' => '请求ID。', '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' => '上级目录ID。', 'type' => 'string', 'example' => '399*****774-cn-qingdao', ], 'Description' => [ 'description' => '目录描述。', 'type' => 'string', 'example' => '目录2', ], 'GroupId' => [ 'description' => '目录所属空间ID。', 'type' => 'string', 'example' => '348*****174-cn-qingdao', ], 'Name' => [ 'description' => '目录名称。', 'type' => 'string', 'example' => '目录2', ], 'CreatedTime' => [ 'description' => '目录创建时间。', 'type' => 'string', 'example' => '2021-09-10T10:00:00Z', ], 'Id' => [ 'description' => '目录ID。', 'type' => 'string', 'example' => '399*****488-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '查询目录列表', 'summary' => '查询目录列表。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'BindDirectory' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DirectoryId', 'in' => 'query', 'schema' => [ 'description' => '目录ID。', 'type' => 'string', 'required' => true, 'example' => '399*****488-cn-qingdao', ], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '3CB843A9-DD34-4881-B8D6-B0D539D111E4', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3CB843A9-DD34-4881-B8D6-B0D539D111E4\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '绑定设备到目录', 'summary' => '绑定设备至目录。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'UnbindDirectory' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DirectoryId', 'in' => 'query', 'schema' => [ 'description' => '目录ID。', 'type' => 'string', 'required' => true, 'example' => '3998**************9488-cn-qingdao', ], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '34871************3380-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '从目录里解绑设备', 'summary' => '从目录里解绑设备。', 'requestParamsDescription' => ' ', ], 'BatchBindDirectories' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'DirectoryId', 'in' => 'query', 'schema' => [ 'description' => '目录ID', 'type' => 'string', 'required' => true, 'example' => '399*****488-cn-qingdao', ], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '设备ID，多值用逗号分隔', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Results' => [ 'description' => '结果列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '绑定的错误信息。'."\n" .'> 仅在出错时存在。', 'type' => 'string', 'example' => 'An error occurred while processing your request.', ], 'DirectoryId' => [ 'description' => '目录ID', 'type' => 'string', 'example' => '399*****488-cn-qingdao', ], 'DeviceId' => [ 'description' => '设备ID', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '批量绑定设备到目录', 'summary' => '批量绑定多个设备到目录。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], 'CreateParentPlatform' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'create', ], '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', 'in' => 'query', 'schema' => [ 'description' => '上级平台协议。取值：'."\n" .'- gb28181(国标)', 'type' => 'string', 'required' => false, 'example' => 'gb28181', 'default' => 'gb28181', ], ], [ 'name' => 'GbId', 'in' => 'query', 'schema' => [ 'description' => '上级平台国标ID。', 'type' => 'string', 'required' => true, 'example' => '31000*****2170123451', ], ], [ 'name' => 'Ip', 'in' => 'query', 'schema' => [ 'description' => '上级平台SIP服务IP。', 'type' => 'string', 'required' => true, 'example' => '10.10.10.10', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => '上级平台SIP服务端口。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5060', ], ], [ 'name' => 'ClientAuth', 'in' => 'query', 'schema' => [ 'description' => '本地是否开启鉴权。取值：'."\n" .'- true（默认）'."\n" .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ClientUsername', 'in' => 'query', 'schema' => [ 'description' => '本地用户名。', 'type' => 'string', 'required' => false, 'example' => 'user01', ], ], [ 'name' => 'ClientPassword', 'in' => 'query', 'schema' => [ 'description' => '本地密码。', 'type' => 'string', 'required' => false, 'example' => 'admin123', ], ], [ 'name' => 'AutoStart', 'in' => 'query', 'schema' => [ 'description' => '是否自动启用。取值：'."\n" .'- false（默认）'."\n" .'- true', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '上级平台ID。', 'type' => 'string', 'example' => '359*****374-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '添加上级平台', 'summary' => '添加新的上级平台。', ], 'DeleteParentPlatform' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '上级平台ID。', 'type' => 'string', 'required' => true, 'example' => '359*****374-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '删除上级平台', 'summary' => '删除上级平台。', 'description' => '> 需先停止上级平台再删除。', ], 'ModifyParentPlatform' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '上级平台ID。', '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' => '上级平台国标ID。', 'type' => 'string', 'required' => false, 'example' => '31000*****2170123451', ], ], [ 'name' => 'Ip', 'in' => 'query', 'schema' => [ 'description' => '上级平台SIP服务IP。', 'type' => 'string', 'required' => false, 'example' => '10.10.10.10', ], ], [ 'name' => 'Port', 'in' => 'query', 'schema' => [ 'description' => '上级平台SIP服务端口。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5060', ], ], [ 'name' => 'ClientAuth', 'in' => 'query', 'schema' => [ 'description' => '本地是否开启鉴权。取值：'."\n" .'- true（默认）'."\n" .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ClientUsername', 'in' => 'query', 'schema' => [ 'description' => '本地用户名。', 'type' => 'string', 'required' => false, 'example' => 'user01', ], ], [ 'name' => 'ClientPassword', 'in' => 'query', 'schema' => [ 'description' => '本地密码。', 'type' => 'string', 'required' => false, 'example' => 'admin123', ], ], [ 'name' => 'AutoStart', 'in' => 'query', 'schema' => [ 'description' => '是否自动启用。取值：'."\n" .'- true'."\n" .'- false（默认）', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '上级平台ID。', 'type' => 'string', 'example' => '359*****374-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '修改上级平台', 'summary' => '修改上级平台信息。', ], 'DescribeParentPlatform' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '上级平台ID。', 'type' => 'string', 'required' => true, 'example' => '359*****374-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => '上级平台状态。取值：'."\n" .'- on（在线）'."\n" .'- off（离线）'."\n" .'- failed（失败）', 'type' => 'string', 'example' => 'on', ], 'ClientPort' => [ 'description' => '本地SIP服务端口。', 'type' => 'integer', 'format' => 'int64', 'example' => '5160', ], 'ClientGbId' => [ 'description' => '本地国标ID。', 'type' => 'string', 'example' => '31010*****317542006', ], 'Protocol' => [ 'description' => '上级平台协议。取值：'."\n" .'- gb28181（国标）', 'type' => 'string', 'example' => 'gb28181', ], 'Ip' => [ 'description' => '上级平台SIP服务IP。', 'type' => 'string', 'example' => '10.10.10.10', ], 'Port' => [ 'description' => '上级平台SIP服务端口。', 'type' => 'integer', 'format' => 'int64', 'example' => '5060', ], 'ClientPassword' => [ 'description' => '本地密码。', 'type' => 'string', 'example' => 'admin123', ], 'ClientUsername' => [ 'description' => '本地用户名。', 'type' => 'string', 'example' => 'user01', ], 'AutoStart' => [ 'description' => '是否自动启用。取值：'."\n" .'- false（默认）'."\n" .'- true', 'type' => 'boolean', 'example' => 'false', ], 'ClientAuth' => [ 'description' => '本地是否开启鉴权。取值：'."\n" .'- true（默认）'."\n" .'- false', 'type' => 'boolean', 'example' => 'true', ], 'GbId' => [ 'description' => '上级平台国标ID。', 'type' => 'string', 'example' => '31000*****2170123451', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Description' => [ 'description' => '上级平台描述。', 'type' => 'string', 'example' => '级联平台描述', ], 'ClientIp' => [ 'description' => '本地SIP服务IP。', 'type' => 'string', 'example' => '192.168.0.1', ], 'Name' => [ 'description' => '上级平台名称。', 'type' => 'string', 'example' => '国标级联平台测试', ], 'CreatedTime' => [ 'description' => '上级平台创建时间。', 'type' => 'string', 'example' => '2018-12-10T21:00:00Z', ], 'Id' => [ 'description' => '上级平台ID。', 'type' => 'string', 'example' => '359*****374-cn-qingdao', ], ], ], ], ], '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' => '查询上级平台', 'summary' => '查询上级平台信息。', ], 'DescribeParentPlatforms' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'GbId', 'in' => 'query', 'schema' => [ 'description' => '按上级平台国标ID查询。', 'type' => 'string', 'required' => false, 'example' => '31000*****2170123451', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '按上级平台状态查询。', 'type' => 'string', 'required' => false, 'example' => 'on', ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => '按给定字段排序，默认按id排序。', 'type' => 'string', 'required' => false, 'example' => 'id', ], ], [ 'name' => 'SortDirection', 'in' => 'query', 'schema' => [ 'description' => '排序方式，默认升序。取值：'."\n" .'- asc（升序）'."\n" .'- desc（降序）', 'type' => 'string', 'required' => false, 'example' => 'asc', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页大小，默认为20', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几个分页，默认为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => '第几个分页。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'RequestId' => [ 'description' => '请求ID。', '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' => '上级平台状态。取值：'."\n" .'- on（在线）'."\n" .'- off（离线）'."\n" .'- failed（失败）', 'type' => 'string', 'example' => 'on', ], 'ClientPort' => [ 'description' => '本地SIP服务端口。', 'type' => 'integer', 'format' => 'int64', 'example' => '5160', ], 'Protocol' => [ 'description' => '上级平台协议。取值：'."\n" .'- gb28181（国标）', 'type' => 'string', 'example' => 'gb28181', ], 'ClientGbId' => [ 'description' => '本地国标ID。', 'type' => 'string', 'example' => '31010*****317542006', ], 'Ip' => [ 'description' => '上级平台SIP服务IP。', 'type' => 'string', 'example' => '10.10.10.10', ], 'Port' => [ 'description' => '上级平台SIP服务端口。', 'type' => 'integer', 'format' => 'int64', 'example' => '5060', ], 'ClientUsername' => [ 'description' => '本地用户名。', 'type' => 'string', 'example' => 'user01', ], 'ClientPassword' => [ 'description' => '本地密码。', 'type' => 'string', 'example' => 'admin123', ], 'AutoStart' => [ 'description' => '是否自动启用。取值：'."\n" .'- false（默认）'."\n" .'- true', 'type' => 'boolean', 'example' => 'false', ], 'ClientAuth' => [ 'description' => '本地是否开启鉴权。取值：'."\n" .'- true（默认）'."\n" .'- false', 'type' => 'boolean', 'example' => 'true', ], 'GbId' => [ 'description' => '上级平台国标ID。', 'type' => 'string', 'example' => '31000*****2170123451', ], 'Description' => [ 'description' => '上级平台描述。', 'type' => 'string', 'example' => '国标级联平台描述', ], 'ClientIp' => [ 'description' => '本地SIP服务IP。', 'type' => 'string', 'example' => '192.168.0.1', ], 'Name' => [ 'description' => '上级平台名称。', 'type' => 'string', 'example' => '国标级联平台测试', ], 'CreatedTime' => [ 'description' => '上级平台创建时间。', 'type' => 'string', 'example' => '2018-12-10T21:00:00Z', ], 'Id' => [ 'description' => '上级平台ID。', 'type' => 'string', 'example' => '359*****374-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '查询上级平台列表', 'summary' => '查询上级平台列表。', ], 'DescribeParentPlatformDevices' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '按上级平台ID查询。', 'type' => 'string', 'required' => true, 'example' => '359*****374-cn-qingdao', ], ], [ 'name' => 'SortBy', 'in' => 'query', 'schema' => [ 'description' => '按给定字段排序，默认按id排序。', 'type' => 'string', 'required' => false, 'example' => 'id', ], ], [ 'name' => 'SortDirection', 'in' => 'query', 'schema' => [ 'description' => '排序方式，默认升序。取值：'."\n" .'- asc（升序）'."\n" .'- desc（降序）', 'type' => 'string', 'required' => false, 'example' => 'asc', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页大小，默认为20', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'description' => '第几个分页，默认为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNum' => [ 'description' => '第几个分页。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'PageSize' => [ 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'RequestId' => [ 'description' => '请求ID。', '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' => '上级设备ID。', 'type' => 'string', 'example' => '3614*****766212-cn-qingdao', ], 'GbId' => [ 'description' => '设备国标ID。', 'type' => 'string', 'example' => '310101*****7542007', ], 'GroupId' => [ 'description' => '设备所属空间ID。', 'type' => 'string', 'example' => '3484*****8732174-cn-qingdao', ], 'Name' => [ 'description' => '设备名称。', 'type' => 'string', 'example' => '测试设备1', ], 'Id' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '3487*****323380-cn-qingdao', ], ], ], ], ], ], ], ], '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":""}]', 'title' => '查询上级平台下的设备列表', 'summary' => '查询上级平台下的设备列表。', ], 'StartParentPlatform' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => [ 'description' => '上级平台ID。', 'type' => 'string', 'required' => true, 'example' => '359*****374-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Id' => [ 'description' => '上级平台ID。', 'type' => 'string', 'example' => '359*****374-cn-qingdao', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], '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' => '启动上级平台交互', 'summary' => '启动上级平台交互，如注册、保活等。', ], 'BindParentPlatformDevice' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'ParentPlatformId', 'in' => 'query', 'schema' => [ 'description' => '上级平台ID。', 'type' => 'string', 'required' => true, 'example' => '361*****212-cn-qingdao', ], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '绑定父平台设备', 'summary' => '绑定设备到上级平台推送。', ], 'BatchBindParentPlatformDevices' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'ParentPlatformId', 'in' => 'query', 'schema' => [ 'description' => '上级平台ID。', 'type' => 'string', 'required' => true, 'example' => '361*****212-cn-qingdao', ], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '设备ID，多值用逗号分隔', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Results' => [ 'description' => '结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '错误信息。'."\n" .'> 仅在出错时存在。', 'type' => 'string', 'example' => 'some error', ], 'ParentPlatformId' => [ 'description' => '上级平台ID。', 'type' => 'string', 'example' => '361*****212-cn-qingdao', ], 'DeviceId' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '批量绑定父平台设备', 'summary' => '批量绑定多个设备到上级平台推送。', ], 'UnbindParentPlatformDevice' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'ParentPlatformId', 'in' => 'query', 'schema' => [ 'description' => '上级平台ID。', 'type' => 'string', 'required' => true, 'example' => '361*****212-cn-qingdao', ], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\"\\n}","type":"json"}]', 'title' => '解除父平台绑定的设备', 'summary' => '从上级平台推送中解绑设备，不再推送。', ], 'BatchUnbindParentPlatformDevices' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'ParentPlatformId', 'in' => 'query', 'schema' => [ 'description' => '上级平台ID。', 'type' => 'string', 'required' => true, 'example' => '361*****212-cn-qingdao', ], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => [ 'description' => '设备ID，多值用逗号分隔', 'type' => 'string', 'required' => true, 'example' => '348*****380-cn-qingdao', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'Results' => [ 'description' => '结果列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '错误信息。'."\n" .'> 仅在出错时存在。', 'type' => 'string', 'example' => 'some error', ], 'ParentPlatformId' => [ 'description' => '上级平台ID。', 'type' => 'string', 'example' => '361*****212-cn-qingdao', ], 'DeviceId' => [ 'description' => '设备ID。', 'type' => 'string', 'example' => '348*****380-cn-qingdao', ], ], ], ], ], ], ], ], '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' => '批量解除父平台设备绑定', 'summary' => '从上级平台推送中批量解绑多个设备。', ], 'DescribeVsDomainPvData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ
最小数据粒度为1小时
不写默认读取过去24小时数据', 'type' => 'string', 'required' => false, 'example' => '2021-10-10T17:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间需大于起始时间；获日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => false, 'example' => '2021-10-15T15:59:59Z', ], ], ], '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' => '该条任务请求Id', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'DomainName' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'example' => 'example.aliyundoc.com', ], 'DataInterval' => [ 'description' => '每条记录的时间间隔，固定值1小时或1天。', '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', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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' => '获取域名PV数据', 'summary' => '获取域名PV数据。', ], 'DescribeVsDomainUvData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ
最小数据粒度为1小时
不写默认读取过去24小时数据', 'type' => 'string', 'required' => false, 'example' => '2021-10-12T10:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间需大于起始时间；获日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => false, 'example' => '2021-11-24T00:00:00Z', ], ], ], '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' => '本次操作请求ID', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], 'DomainName' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'example' => 'example.aliyundoc.com', ], 'DataInterval' => [ 'description' => '每条记录的时间间隔，以秒为单位，固定值1小时。', 'type' => 'string', 'example' => '3600', ], 'UvDataInterval' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'UsageData' => [ 'description' => '返回数据。', 'type' => 'array', 'items' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Value' => [ 'description' => '独立访客量（UV）。', 'type' => 'string', 'example' => '100', ], 'TimeStamp' => [ 'description' => '时间片起始时刻。', 'type' => 'string', 'example' => '2015-11-29T15:00:00Z', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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' => '获取 vs 域名 uv 数据', 'summary' => '获取 vs 域名 uv 数据 。', ], 'DescribeVsDomainPvUvData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '起始时间，UTC格式，例如：2016-06-29T19:00:00Z', 'type' => 'string', 'required' => false, 'example' => '2021-10-14T23:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间，UTC格式，例如：2016-06-30T19:00:00Z', 'type' => 'string', 'required' => false, 'example' => '2021-11-24T00:00:00Z', ], ], ], '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' => '本次操作请求ID', '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' => 'PV数据。', 'type' => 'string', 'example' => '100', ], 'TimeStamp' => [ 'description' => '时间片起始时刻。', 'type' => 'string', 'example' => '2021-10-14T23:00:00Z', ], 'UV' => [ 'description' => 'UV数据。', 'type' => 'string', 'example' => '100', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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' => '获取vs域名pv和uv数据', 'summary' => '获取vs域名pv和uv数据。', ], 'DescribeVsDomainRecordData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ
最小数据粒度为5分钟
不写默认读取过去24小时数据', 'type' => 'string', 'required' => false, 'example' => '2021-09-29T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间需大于起始时间；获日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-11-19T15:59:59Z', ], ], [ 'name' => 'Region', 'in' => 'query', 'schema' => [ 'description' => '区域信息', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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' => '获取 vs 域名记录数据', 'summary' => '获取 vs 域名记录数据。', ], 'DescribeVsDomainSnapshotData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ
最小数据粒度为5分钟
不写默认读取过去24小时数据', 'type' => 'string', 'required' => false, 'example' => '2021-10-05T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间需大于起始时间；获日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => false, 'example' => '2021-10-18T16:00:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID。', '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', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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' => '获取域名快照数据', 'summary' => '获取域名快照数据。', ], 'DescribeVsDomainRegionData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ
最小数据粒度为5分钟
不写默认读取过去24小时数据', 'type' => 'string', 'required' => false, 'example' => '2021-10-30T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间需大于起始时间；获日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => false, 'example' => '2021-10-31T15:59:59Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EndTime' => [ 'description' => '结束时间'."\n", 'type' => 'string', 'example' => '2021-10-31T15:59:59Z', ], 'StartTime' => [ 'description' => '开始时间'."\n", 'type' => 'string', 'example' => '2021-10-30T16:00:00Z', ], 'RequestId' => [ 'description' => '请求ID', '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' => '平均响应速度，单位：byte/秒', 'type' => 'string', 'example' => '154.3345765545624', ], 'AvgResponseTime' => [ 'description' => '平均响应时间，单位：毫秒。', 'type' => 'string', 'example' => '5183.666666666667', ], 'ReqErrRate' => [ 'description' => '请求错误率，例如返回90即为90%。', 'type' => 'string', 'example' => '0', ], 'AvgObjectSize' => [ 'description' => '响应平均大小。单位：byte。', 'type' => 'string', 'example' => '2888253.7875', ], 'Bps' => [ 'description' => '带宽。', 'type' => 'string', 'example' => '380.9614285714286', ], 'Qps' => [ 'description' => '每秒查询率。'."\n", 'type' => 'string', 'example' => '0.001746031746031746', ], 'RegionEname' => [ 'description' => '地区英文名称。', 'type' => 'string', 'example' => 'chongqing', ], 'Region' => [ 'description' => '地区信息。', 'type' => 'string', 'example' => '重庆市', ], 'Proportion' => [ 'description' => '访问占比数据。例如：返回90即为90% 。'."\n", 'type' => 'string', 'example' => '0.01155980271270037', ], 'BytesProportion' => [ 'description' => '总流量占比，例如返回90即为90%。', 'type' => 'string', 'example' => '0.003544181046236794', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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' => '获取域名区域数据', 'summary' => '获取域名区域数据。', ], 'DescribeVsDomainBpsData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '域名，若参数为空，默认返回所有加速域名合并后数据
可输入需要查询的加速域名
支持批量域名查询，多个域名用逗号（半角）分隔', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ
最小数据粒度为5分钟
不写默认读取过去24小时数据', 'type' => 'string', 'required' => false, 'example' => '2021-12-26T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间需大于起始时间；获日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => false, 'example' => '2021-10-02T02:30:48Z', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => '查询数据的时间粒度，支持300, 3600和86400秒。不传和传的值不支持时，使用默认值300秒'."\n", 'type' => 'string', 'required' => false, 'example' => '300', 'enum' => [ '300', '3600', '86400', ], ], ], [ 'name' => 'IspNameEn', 'in' => 'query', 'schema' => [ 'description' => '运营商英文名，通过DescribeCdnRegionAndIsp接口获得，不传为所有运营商'."\n", 'type' => 'string', 'required' => false, 'example' => 'unicom', ], ], [ 'name' => 'LocationNameEn', 'in' => 'query', 'schema' => [ 'description' => '区域英文名，通过DescribeCdnRegionAndIsp接口获得，不传为所有区域'."\n", 'type' => 'string', 'required' => false, 'example' => 'guangdong', ], ], ], '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' => '本次操作请求ID', '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' => '每个时间间隔的网络带宽数据。'."\n", 'type' => 'array', 'items' => [ 'description' => '每个时间间隔的网络带宽数据。', 'type' => 'object', 'properties' => [ 'BpsValue' => [ 'description' => 'bps数据值，单位：bit/second', 'type' => 'string', 'example' => '1000', ], 'TimeStamp' => [ 'description' => '时间片起始时刻。', 'type' => 'string', 'example' => '2015-12-10T20:00:00Z', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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' => '查询域名网络带宽监控数据', 'summary' => '查询域名网络带宽监控数据。', ], 'DescribeVsDomainReqBpsData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ
最小数据粒度为5分钟
不写默认读取过去24小时数据', 'type' => 'string', 'required' => false, 'example' => '2022-01-15T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间需大于起始时间；获日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => false, 'example' => '2021-10-16T07:00:46Z', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => '查询数据的时间粒度，支持300, 3600和86400秒。不传和传的值不支持时，使用默认值300秒'."\n", 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 300 => '300', 3600 => '3600', 86400 => '86400', ], 'example' => '300', ], ], [ 'name' => 'IspNameEn', 'in' => 'query', 'schema' => [ 'description' => '运营商英文名。通过DescribeCdnRegionAndIsp接口获得，不传该参数代表查询所有运营商。', 'type' => 'string', 'required' => false, 'example' => 'telecom', ], ], [ 'name' => 'LocationNameEn', 'in' => 'query', 'schema' => [ 'description' => '区域英文名。通过DescribeCdnRegionAndIsp接口获得，不传该参数代表查询所有区域。', 'type' => 'string', 'required' => false, 'example' => 'beijing', ], ], ], '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' => '请求ID。', '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' => 'bps数据值，单位：bit/second'."\n", 'type' => 'string', 'example' => '1000', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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' => '获取域名网络请求监控数据', 'summary' => '获取域名网络请求监控数据。', ], 'DescribeVsDomainTrafficData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ
最小数据粒度为5分钟
不写默认读取过去24小时数据', 'type' => 'string', 'required' => false, 'example' => '2021-08-18T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间需大于起始时间；获日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => false, 'example' => '2021-09-21T02:50:42Z', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => '查询数据的时间粒度，支持300, 3600和86400秒。不传和传的值不支持时，使用默认值300秒', 'type' => 'string', 'required' => false, 'example' => '3600', ], ], [ 'name' => 'IspNameEn', 'in' => 'query', 'schema' => [ 'description' => '运营商英文名。通过DescribeCdnRegionAndIsp接口获得，不传该参数代表查询所有运营商。', 'type' => 'string', 'required' => false, 'example' => 'telecom', ], ], [ 'name' => 'LocationNameEn', 'in' => 'query', 'schema' => [ 'description' => '区域英文名。通过DescribeCdnRegionAndIsp接口获得，不传该参数代表查询所有区域。', 'type' => 'string', 'required' => false, 'example' => 'beijing', ], ], ], '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' => '该条任务请求ID。', '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' => '流量数据值。单位：Byte。', 'type' => 'string', 'example' => '100', ], 'TimeStamp' => [ 'description' => '时间片起始时刻。', 'type' => 'string', 'example' => '2021-09-20T07:10:42Z', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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' => '获取域名流量数据', 'summary' => '获取域名流量数据。', ], 'DescribeVsDomainReqTrafficData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'required' => false, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '获取数据起始时间点，日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ
最小数据粒度为5分钟
不写默认读取过去24小时数据', 'type' => 'string', 'required' => false, 'example' => '2021-09-30T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '结束时间需大于起始时间；获日期格式按照ISO8601表示法，并使用UTC时间。
格式为：YYYY-MM-DDThh:mm:ssZ', 'type' => 'string', 'required' => false, 'example' => '2021-10-13T10:00:41Z', ], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => '查询数据的时间粒度。单位：秒。取值：'."\n" .'- **300**（默认值）。'."\n" .'- **3600**。'."\n" .'- **86400**。'."\n" ."\n" .'> 不传或传值不支持时，使用默认值**300**秒。', 'type' => 'string', 'required' => false, 'example' => '3600', ], ], [ 'name' => 'IspNameEn', 'in' => 'query', 'schema' => [ 'description' => '运营商英文名。通过DescribeCdnRegionAndIsp接口获得，不传该参数代表查询所有运营商。', 'type' => 'string', 'required' => false, 'example' => 'unicom', ], ], [ 'name' => 'LocationNameEn', 'in' => 'query', 'schema' => [ 'description' => '区域英文名。通过DescribeCdnRegionAndIsp接口获得，不传该参数代表查询所有区域。', 'type' => 'string', 'required' => false, 'example' => 'shanghai', ], ], ], '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' => '请求ID。', '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', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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' => '获取 vs 域名请求流量数据', 'summary' => '获取 vs 域名请求流量数据。', ], 'DescribeVsDevicesData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [], 'parameters' => [ [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => '按空间ID查询。'."\n", 'type' => 'string', 'required' => false, 'example' => '348*****174-cn-qingdao', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '获取数据的起始时间。 '."\n" .'> - 日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ'."\n" .'> - 最小数据粒度为5分钟。'."\n" .'> - 不填的话，默认读取过去 24 小时数据。', 'type' => 'string', 'required' => false, 'example' => '2022-01-04T16:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '获取数据的结束时间，需要大于起始时间。'."\n" ."\n" .'> - 日期格式按照ISO8601表示法，并使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ'."\n" .'> - 最小数据粒度为5分钟。'."\n" .'> - 不填的话，默认读取过去 24 小时数据。', 'type' => 'string', 'required' => false, 'example' => '2022-01-30T16:00:00Z', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', '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', ], ], ], ], ], ], ], ], ], ], '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.', ], ], ], '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' => '获取接入设备用量数据', 'summary' => '获取接入设备用量数据。', 'description' => '不指定 StartTime 和 EndTime 时，默认读取过去24小时的数据，同时支持按指定的起止时间查询，两者需要同时指定。'."\n" .'最大查询范围 31 天。'."\n" ."\n" .'* 支持批量域名查询，多个域名用英文逗号（,）分隔。'."\n" .'* 最多可获取最近 90 天的数据。'."\n" .'* 时间粒度为小时。', ], 'DescribeVsUpPeakPublishStreamData' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '拉流开始时间，UTC格式, StartTime和EndTime时间间隔在30天内', 'type' => 'string', 'required' => true, 'example' => '2017-12-10T20:00:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '拉流结束时间，UTC格式, StartTime和EndTime时间间隔在30天内,且EndTime超过当前时间', 'type' => 'string', 'required' => true, 'example' => '2017-12-10T21:00:00Z', ], ], [ 'name' => 'DomainSwitch', 'in' => 'query', 'schema' => [ 'description' => '域名统计开关，取值：on或者off；on：开启域名统计级别，off：用户级别数据。默认统计用户级别数据', 'type' => 'string', 'required' => false, 'example' => 'on', 'enum' => [ 'on', 'off', ], ], ], [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '输入域名，查域名粒度数据', 'type' => 'string', 'required' => false, 'example' => 'example.com', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '该条任务请求ID', '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' => '统计数据属性名称。当DomainSwitch取值为on时，显示用户直播域名；为off或者不传值是显示用户Id。', 'type' => 'string', 'example' => 'example.com', ], 'PeakTime' => [ 'description' => '每日峰值并发推流数的峰值时刻', 'type' => 'string', 'example' => '1522252320000', ], 'PublishStreamNum' => [ 'description' => '每日峰值并发推流数', 'type' => 'integer', 'format' => 'int32', 'example' => '31', ], ], ], ], ], ], ], ], ], ], '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' => '查询用户每日上行并发推流数峰值', 'summary' => '查询用户的每日上行并发推流数峰值。', ], 'VerifyVsDomainOwner' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], [ 'name' => 'VerifyType', 'in' => 'query', 'schema' => [ 'description' => '校验方式，取值：'."\n" ."\n" .'- **dnsCheck**：DNS验证。'."\n" .'- **fileCheck**：文件验证。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'fileCheck' => '文件验证', 'dnsCheck' => 'DNS验证', ], 'example' => 'dnsCheck', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Content' => [ 'description' => '校验内容。'."\n" ."\n" .'> '."\n" .'调用成功不返回该参数，调用失败返回校验内容。', 'type' => 'string', 'example' => 'verify_dffeb6610035dcb77b413a59c32c****'."\n", ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Content\\": \\"verify_dffeb6610035dcb77b413a59c32c****\\\\n\\"\\n}","type":"json"}]', ], 'DescribeVsVerifyContent' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => '视图计算域名名称', 'type' => 'string', 'required' => true, 'example' => 'example.aliyundoc.com', ], ], ], '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' => '请求ID。', 'type' => 'string', 'example' => 'BEA5625F-8FCF-48F4-851B-CA63946DA664', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEA5625F-8FCF-48F4-851B-CA63946DA664\\",\\n \\"Content\\": \\"verify_dffeb6610035dcb77b413a59c3*****\\"\\n}","type":"json"}]', ], 'StartPublishStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'PublishUrl', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'type' => 'integer', 'format' => 'int64', ], 'Message' => [ 'type' => 'integer', 'format' => 'int64', ], 'RequestId' => [ 'type' => 'string', ], ], ], ], ], 'errorCodes' => [], ], 'DescribePublishStreamStatus' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'type' => 'integer', 'format' => 'int64', ], 'Message' => [ 'type' => 'integer', 'format' => 'int64', ], 'RequestId' => [ 'type' => 'string', ], ], ], ], ], 'errorCodes' => [], 'responseDemo' => '', ], 'StopPublishStream' => [ 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => [ 'type' => 'integer', 'format' => 'int64', ], 'Message' => [ 'type' => 'integer', 'format' => 'int64', ], 'RequestId' => [ 'type' => 'string', ], ], ], ], ], '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', ], ], ];