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


## 1. API Description

API request domain name:

This API gets the list of prohibited streams.

Default API request rate limit: 500 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: DescribeLiveForbidStreamList
Version Yes String Common parameter; the version of this API: 2018-08-01
Region No String Common parameter; optional for this API
PageNum No Integer The page number to get; 1 by default.
PageSize No Integer Size per page; up to 100.
Value: any integer between 1 and 100.
Default value: 10.

3. Return 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.
ProhibitStreamList Array of ProhibitStreamInfo Prohibited stream list.
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
&<Common request parameter>

Output Sample Code

    "Response": {
                 "StreamName": "5000_abcdefg",
                 "CreateTime": "2019-01-16T12:00:00Z",
                     "ExpireTime": "2019-04-16T12:00:00Z"
        "TotalNum": 100,
        "TotalPage": 10,
        "PageNum": 1,
        "PageSize": 10,
        "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.


Cloud API 3.0 comes with a set of complementary development toolkits (SDKs) that support multiple programming languages and make it easier to call the API.


6. Error Codes

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

Error Code Description
InternalError Internal error
InvalidParameter Parameter error
InvalidParameterValue Incorrect parameter value
MissingParameter Missing parameter