tencent cloud

文档反馈

CreateStreamPackageChannelEndpoint

最后更新时间:2024-11-18 19:24:12

    1. API Description

    Domain name for API request: mdp.intl.tencentcloudapi.com.

    This API is used to create an endpoint on a StreamPackage channel.

    A maximum of 20 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 Params. The value used for this API: CreateStreamPackageChannelEndpoint.
    Version Yes String Common Params. The value used for this API: 2020-05-27.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    Id Yes String Channel ID
    Name Yes String Endpoint name, which must contain 1 to 32 characters and supports digits, letters, and underscores
    AuthInfo Yes EndpointAuthInfo Authentication information
    Protocol No String Endpoint protocol type, supports HLS, DASH, CMAF (only HLS type input can create CMAF Endpoint).
    Manifest No String Mainifest name, default is main.
    TimeShiftEnable No Boolean Whether to turn on the TimeShift function, true: on, false: off, the default is off.
    TimeShiftDuration No Integer The number of days to look back in TimeShift, up to 30 days is supported.

    3. Output Parameters

    Parameter Name Type Description
    Info EndpointInfo Information of the created channel endpoint
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Sample request

    Input Example

    https://mdp.intl.tencentcloudapi.com/?Action=CreateStreamPackageChannelEndpoint
    &Id=XXX
    &Name=XXX
    &AuthInfo.WhiteIpList.0=0.0.0.0/0
    &AuthInfo.BlackIpList.0=0.0.0.0/0
    &AuthInfo.AuthKey=XXX
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "Info": {
                "Url": "",
                "AuthInfo": {
                    "AuthKey": "",
                    "BlackIpList": [
                        "1.2.3.4/24",
                        "19.76.68.1/1"
                    ],
                    "WhiteIpList": [
                        "11.2.3.4/24",
                        "119.76.68.1/1"
                    ]
                },
                "Name": ""
            },
            "RequestId": "11-222-333"
        }
    }
    

    5. Developer Resources

    SDK

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

    Command Line Interface

    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
    InternalError Internal error.
    InvalidParameter.AuthInfo Incorrect authentication configuration.
    InvalidParameter.ExceededQuantityLimit The quantity exceeds the limit.
    InvalidParameter.Id Invalid Id.
    InvalidParameter.Name Invalid name.
    InvalidParameter.NotFound Failed to find the channel/input/output.
    InvalidParameter.SSAIInfo