ForbidLiveStream

Last updated: 2019-06-25 22:24:44

PDF

## 1. API Description

API request domain name: live.tencentcloudapi.com.

This API prohibits a specified upstream. You can preset a time at which the stream resumes.

Default API request rate limit: 200 requests/second.

2. Request Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter; the name of this API: ForbidLiveStream
Version Yes String Common parameter; the version of this API: 2018-08-01
Region No String Common parameter; optional for this API
AppName Yes String Application name
DomainName Yes String Your acceleration domain name
StreamName Yes String Stream name
ResumeTime No String Time to resume the stream In UTC format, for example: 2018-11-29T19:00:00Z.
Note: The duration of forbidding can be up to 90 days (90 days by default).

3. Return Parameters

Parameter name Type Description
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Sample

Request Sample

Input Sample Code

https://live.tencentcloudapi.com/?Action=ForbidLiveStream
&DomainName=5000.livepush.myqcloud.com
&AppName=live
&StreamName=stream1
&ResumeTime=2018-11-24T12:00:00Z
&<Common request parameter>

Output Sample Code

{
  "Response": {
    "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
  }
}

5. Developer Resources

API Explorer

API Explorer is a tool that provides ease of use in requesting APIs, authenticating identities, generating SDK and exploring APIs in Tencent Cloud environment.

6. Error Codes

The following error codes are API business logic-related. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error
InternalError.CallOtherSvrError Error calling internal service.
InternalError.ConfigNotExist The configuration does not exist.
InternalError.GetBizidError Error getting user account.
InternalError.GetStreamInfoError Failed to get stream information.
InternalError.GetUpstreamInfoError Error getting live stream source information.
InternalError.NotPermmitOperat No permission to operate.
InternalError.StreamStatusError Exceptional stream status.
InternalError.UpdateDataError Failed to update data.
InvalidParameter Parameter error
InvalidParameterValue Incorrect parameter value
MissingParameter Missing parameter