API Category
Last updated: 2025-10-30 21:47:47
API Category
Last updated: 2025-10-30 21:47:47
Live Pad APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateLivePadTemplate | create live pad template | 20 |
| CreateLivePadRule | create live pad rule | 20 |
| StartLivePadStream | StartLivePadStream | 20 |
| StopLivePadStream | StopLivePadStream | 20 |
LVB Transcoding APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DeleteLiveTranscodeRule | Deletes a transcoding rule | 200 |
| DeleteLiveTranscodeTemplate | Deletes a transcoding template | 200 |
| DescribeLiveTranscodeRules | Gets the list of transcoding rules | 500 |
| DescribeLiveTranscodeTemplate | Gets a single transcoding template | 500 |
| DescribeLiveTranscodeTemplates | Gets the list of transcoding templates | 500 |
| CreateLiveTranscodeTemplate | Creating a transcoding template | 200 |
| ModifyLiveTranscodeTemplate | Modifies the transcoding template configuration | 200 |
| CreateLiveTranscodeRule | Creates a transcoding rule | 200 |
Delayed Playback Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeLiveDelayInfoList | Gets the list of delayed playbacks. | 500 |
| ResumeDelayLiveStream | Cancels the live streaming delay | 200 |
| AddDelayLiveStream | Sets a live streaming delay | 200 |
Domain Name Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| AddLiveDomain | Adds domain name | 100 |
| AuthenticateDomainOwner | Verifies the ownership of a domain | 20 |
| DeleteLiveDomain | Deletes domain name | 100 |
| DescribeLiveDomain | Queries domain name information | 500 |
| DescribeLiveDomains | Queries domain name list | 200 |
| EnableLiveDomain | Enables domain name | 100 |
| ForbidLiveDomain | Disables domain name | 100 |
| ModifyLivePlayDomain | Modifies playback domain name | 200 |
Watermark Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| AddLiveWatermark | Adds watermark | 100 |
| CreateLiveWatermarkRule | Creates watermarking rule | 200 |
| DeleteLiveWatermark | Delete watermark | 100 |
| DeleteLiveWatermarkRule | Deletes watermarking rule | 200 |
| DescribeLiveWatermark | Gets the information of a single watermark | 500 |
| DescribeLiveWatermarkRules | Gets the watermarking rule list | 500 |
| DescribeLiveWatermarks | Queries watermark list | 500 |
| UpdateLiveWatermark | Updates watermark | 100 |
Certificate Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeLiveCert | Gets certificate information | 500 |
| DescribeLiveCerts | Gets certificate information list | 500 |
| DescribeLiveDomainCert | Gets domain name certificate information | 500 |
| DescribeLiveDomainCertBindings | Querying domains bound with certificates | 20 |
| ModifyLiveDomainCertBindings | Binding a certificate to multiple playback domains | 20 |
| UnBindLiveDomainCert | Unbinds domain name certificate | 200 |
Live Stream Mix APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CancelCommonMixStream | Cancels general stream mix | 100 |
| CreateCommonMixStream | Creates general stream mix | 200 |
Stream Pulling APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DeleteLivePullStreamTask | Deletes a stream pulling task | 50 |
| DescribeLivePullStreamTasks | Queries stream pulling tasks | 30 |
| RestartLivePullStreamTask | RestartLivePullStreamTask | 20 |
| CreateLivePullStreamTask | Creates a stream pulling task | 50 |
| ModifyLivePullStreamTask | Modifies a stream pulling task | 20 |
Recording Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateLiveRecord | Creates recording task (disused; please use the new API) | 500 |
| CreateLiveRecordRule | Creates a recording rule | 200 |
| CreateLiveRecordTemplate | Creates a recording template | 200 |
| CreateRecordTask | Creates recording task (new) | 20 |
| DeleteLiveRecord | Deletes recording task (disused; please use the new API) | 200 |
| DeleteLiveRecordRule | Deletes a recording rule | 200 |
| DeleteLiveRecordTemplate | Deletes a recording template. | 200 |
| DeleteRecordTask | Deletes recording task (new) | 20 |
| DescribeLiveRecordRules | Gets the list of recording rules | 500 |
| DescribeLiveRecordTemplate | Gets a single recording template | 500 |
| DescribeLiveRecordTemplates | Gets the list of recording templates | 500 |
| DescribeRecordTask | CreateRecordTask (New) | 20 |
| ModifyLiveRecordTemplate | Modifies a recording template | 200 |
| StopLiveRecord | Terminates recording task (disused; please use the new API) | 200 |
| StopRecordTask | Terminates recording task (API) | 20 |
Time Shifting APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateLiveTimeShiftRule | Creates a time shifting rule | 20 |
| CreateLiveTimeShiftTemplate | Creates a time shifting template | 20 |
| DeleteLiveTimeShiftRule | Deletes a time shifting rule | 20 |
| DeleteLiveTimeShiftTemplate | Deletes a time shifting template | 20 |
| DescribeLiveTimeShiftRules | Queries time shifting rules | 20 |
| DescribeLiveTimeShiftTemplates | Queries time shifting templates | 20 |
| DescribeTimeShiftRecordDetail | Queries time shifting details | 20 |
| DescribeTimeShiftStreamList | Queries time shifted streams | 20 |
| ModifyLiveTimeShiftTemplate | Modifies a standby stream template | 20 |
LVB Callback APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateLiveCallbackRule | Creates callback rule | 200 |
| CreateLiveCallbackTemplate | Creates callback template | 200 |
| DeleteLiveCallbackRule | Deletes callback rule | 200 |
| DeleteLiveCallbackTemplate | Deletes callback template | 200 |
| DescribeLiveCallbackRules | Gets callback rule list | 500 |
| DescribeLiveCallbackTemplate | Gets a callback template | 500 |
| DescribeLiveCallbackTemplates | Gets callback template list | 500 |
| ModifyLiveCallbackTemplate | Modifies callback template | 200 |
Screencapturing and Porn Detection APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| CreateLiveSnapshotRule | Creates screencapturing rule | 200 |
| CreateLiveSnapshotTemplate | Creates screencapturing template | 200 |
| CreateScreenshotTask | Creates a screencapturing task | 20 |
| DeleteLiveSnapshotRule | Deletes screencapturing rule | 200 |
| DeleteLiveSnapshotTemplate | Deletes screencapturing template | 200 |
| DescribeLiveSnapshotRules | Gets screencapturing rule list | 500 |
| DescribeLiveSnapshotTemplate | Gets single screencapturing template | 500 |
| DescribeLiveSnapshotTemplates | Gets screencapturing template list | 500 |
| ModifyLiveSnapshotTemplate | Modifies screencapturing template configuration | 200 |
Authentication Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeLiveDomainReferer | Queries referer allowlist/blocklist configuration of a live streaming domain name | 20 |
| DescribeLivePlayAuthKey | Queries the playback authentication key | 500 |
| DescribeLivePushAuthKey | Queries the push authentication key | 500 |
| ModifyLiveDomainReferer | Configures referer allowlist/blocklist of a live streaming domain name | 20 |
| ModifyLivePlayAuthKey | Modifies the playback authentication key | 100 |
| ModifyLivePushAuthKey | Modifies the push authentication key | 200 |
Monitoring Data Query APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeAllStreamPlayInfoList | Gets the playback data of all streams at a specified time point | 20 |
| DescribeGroupProIspPlayInfoList | Queries downstream playback data by district and ISP | 200 |
| DescribeHttpStatusInfoList | Queries the details of each playback HTTP status code | 200 |
| DescribeLiveStreamPushInfoList | Gets the push data of live streams | 500 |
| DescribePlayErrorCodeDetailInfoList | Queries the real-time data of each playback HTTP error code | 100 |
| DescribePlayErrorCodeSumInfoList | Queries the aggregated data of playback HTTP error codes | 200 |
| DescribeProvinceIspPlayInfoList | Queries the playback information by ISP and district | 200 |
| DescribeStreamDayPlayInfoList | Queries the traffic data of all streams | 500 |
| DescribeStreamPlayInfoList | Queries the playback information list of stream | 500 |
| DescribeStreamPushInfoList | Gets the push data of a stream | 40 |
| DescribeTopClientIpSumInfoList | Queries the information of top n client IPs in certain period of time | 100 |
| DescribeVisitTopSumInfoList | Queries the information of top n domain names or stream IDs in certain period of time | 100 |
| DescribeLiveTranscodeDetailInfo | Queries LVB transcoding statistics | 200 |
Billing Data Query APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeDeliverBandwidthList | Queries the billable bandwidth of live stream relaying | 20 |
| DescribeLiveTimeShiftBillInfoList | Queries time shift billing data | 20 |
| DescribeLiveTranscodeTotalInfo | Queries total usage of the transcoding service | 200 |
| DescribeScreenShotSheetNumList | Queries the number of screenshots | 100 |
| DescribeTranscodeTaskNum | Queries the number of transcoding tasks | 20 |
| DescribeUploadStreamNums | Queries the number of LVB upstream channels. | 20 |
| DescribeConcurrentRecordStreamNum | Queries the number of concurrent recording channels | 200 |
| DescribeBillBandwidthAndFluxList | Queries the data of billable bandwidth and traffic | 100 |
Live Stream Management APIs
| API Name | Feature | Frequency Limit (maximum requests per second) |
|---|---|---|
| DescribeLiveForbidStreamList | Gets the list of forbidden streams. | 100 |
| DescribeLiveStreamEventList | Queries streaming events. | 300 |
| DescribeLiveStreamOnlineList | Queries live streams. | 100 |
| DescribeLiveStreamPublishedList | Queries the list of pushed streams. | 300 |
| DropLiveStream | Pauses a live stream | 100 |
| ResumeLiveStream | Resumes a live stream. | 100 |
| DescribeLiveStreamState | Queries stream status. | 300 |
| ForbidLiveStream | Forbids a live stream. | 200 |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback