tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
StreamPackage
    Documentation
    Download PDF

    ModifyStreamPackageChannelEndpoint

    Last updated: 2024-11-18 19:24:36
    Download PDF

      1. API Description

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

      This API is used to modify an endpoint of 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: ModifyStreamPackageChannelEndpoint.
      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
      Url Yes String Channel endpoint URL
      Name Yes String New endpoint name
      AuthInfo Yes EndpointAuthInfo New channel authentication information
      Protocol No String Endpoint protocol.
      TimeShiftEnable No Boolean Whether to turn on the time shift function, true: on, false: off, the default is off.
      TimeShiftDuration No Integer The number of days in the time shift window, up to 30 days. Valid when TimeShiftEnable is turned on.
      SSAIEnable No Boolean Advertising insertion function switch.
      SSAIInfo No SSAIConf Ad insertion function configuration information. Valid when SSAIEnable is turned on.
      CustomUrlParamIndex No Integer The customer-defined url parameter is inserted into the subscript at the specified position of the Endpoint url.
      Calculation starts from the first '/' in the url path, and the subscript starts from 0, the optional range of the subscript is: [0,3].
      CustomUrlParam No String Customer-defined url parameters are inserted into the specified position of the Endpoint url based on the CustomUrlParamIndex.
      The parameters can only contain digits, letters, underscores (_), and hyphens (-), with a length of 1 to 64 chars.

      3. Output Parameters

      Parameter Name Type Description
      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=ModifyStreamPackageChannelEndpoint
&Id=XXX
&Url=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": {
        "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.Id Invalid Id.
      InvalidParameter.Name Invalid name.
      InvalidParameter.NotFound Failed to find the channel/input/output.
      InvalidParameter.SSAIInfo
      InvalidParameter.Url Invalid Url.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy