Domain name for API request: live.tencentcloudapi.com.
This API is used to disable a stream. You can set a time to resume the stream.
Note:
A maximum of 200 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: ForbidLiveStream. |
Version | Yes | String | Common Params. The value used for this API: 2018-08-01. |
Region | No | String | Common Params. This parameter is not required for this API. |
AppName | Yes | String | Push path, which is the same as the AppName in push and playback addresses and is "live" by default. |
DomainName | Yes | String | Your push domain name. |
StreamName | Yes | String | Stream name. |
ResumeTime | No | String | The time (in UTC format) to resume the stream, such as 2018-11-29T19:00:00Z. Notes: 1. The default stream disabling period is seven days. A stream can be disabled for up to 90 days. 2. Beijing time is 8 hours ahead of UTC. The ISO 8601 format is used. |
Reason | No | String | Reason for forbidding. Note: Be sure to enter the reason for forbidding to avoid any faulty operations. Length limit: 2,048 bytes. |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to disable a stream.
https://live.tencentcloudapi.com/?Action=ForbidLiveStream
&DomainName=5000.livepush.myqcloud.com
&AppName=live
&StreamName=stream1
&ResumeTime=2018-11-24T12:00:00Z
&<Common request parameters>
{
"Response": {
"RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
FailedOperation.CallOtherSvrFailed | Failed to call the internal service. |
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 the stream information. |
InternalError.GetUpstreamInfoError | Error getting the live stream source information. |
InternalError.NotPermmitOperat | No permission to operate. |
InternalError.StreamStatusError | Exceptional stream status. |
InternalError.UpdateDataError | Failed to update data. |
InvalidParameter | Invalid parameter. |
InvalidParameterValue | Invalid parameter value. |
MissingParameter | Parameter missing. |
ResourceNotFound.ForbidService | You are blocked. |
ResourceNotFound.FreezeService | Service suspended. |
ResourceNotFound.StopService | The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first. |
ResourceNotFound.UserDisableService | You disabled the service. |
ResourceNotFound.UserNotExist | The LVB service has not been activated. |
この記事はお役に立ちましたか?