Documentation|Tencent Cloud

Recent Pages

Documentation

DescribeLiveForbidStreamList

Last updated: 2020-07-14 18:08:14

1. API Description

Domain name for API request: live.tencentcloudapi.com.

This API is used to get the forbidden stream list.

A maximum of 500 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 parameter. The value used for this API: DescribeLiveForbidStreamList.
Version	Yes	String	Common parameter. The value used for this API: 2018-08-01.
Region	No	String	Common parameter. This parameter is not required for this API.
PageNum	No	Integer	Page number to get. Default value: 1.
PageSize	No	Integer	Number of entries per page. Maximum value: 100. Value: any integer between 1 and 100. Default value: 10.

3. Output Parameters

Parameter Name	Type	Description
TotalNum	Integer	Total number of eligible ones.
TotalPage	Integer	Total number of pages.
PageNum	Integer	Page number.
PageSize	Integer	Number of entries displayed per page.
ForbidStreamList	Array of ForbidStreamInfo	List of forbidden streams.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

https://live.tencentcloudapi.com/?Action=DescribeLiveForbidStreamList
&PageNum=1
&PageSize=10
&<Common request parameters>

Output Example

{
  "Response": {
    "ForbidStreamList": [
      {
        "StreamName": "5000_abcdefg",
        "CreateTime": "2019-01-16T12:00:00Z",
        "ExpireTime": "2019-04-16T12:00:00Z"
      }
    ],
    "TotalNum": 1,
    "TotalPage": 1,
    "PageNum": 1,
    "PageSize": 10,
    "RequestId": "8e50cdb5-56dc-408b-89b0-31818958d424"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.CallOtherSvrFailed	Failed to call the internal service.
InternalError	Internal error.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Wrong parameter value.
MissingParameter	Missing parameter.
ResourceNotFound.UserNotExist	The LVB service has not been activated.