CreateLivePackageOriginEndpoint-Intelligent Media Services(IMS)-阿里云帮助中心

Adds the origin endpoint configuration for a live streaming channel, supporting the HLS, HLS_CMAF, and DASH protocols and DRM encryption.

Operation description

This operation creates an origin endpoint for a live packaging service. It is primarily used to configure back-to-origin settings, security policies (such as IP blacklists and whitelists, and authorization codes), and timeshift features for a channel. Currently, only HLS protocol playback is supported. Before you create an origin endpoint, you must create a live packaging channel group and a channel. After the endpoint is created, the system returns the endpoint playback URL and other configuration details.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:CreateLivePackageOriginEndpoint

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GroupName	string	Yes	The name of the channel group.	channel-group-1
ChannelName	string	Yes	The name of the channel.	channel-1
EndpointName	string	Yes	The name of the origin endpoint. The name must be 1 to 200 characters in length, and can contain only letters, digits, hyphens (-), and underscores (). Format: [A-Za-z0-9-]+	endpoint-1
Protocol	string	Yes	The distribution protocol.	HLS
ManifestName	string	No	The name of the manifest. Default value: manifest.	manifest
Description	string	No	The description of the endpoint.	This is an origin endpoint
TimeshiftVision	integer	No	The timeshift duration in days. Maximum value: 30. Default value: 0, which indicates that timeshift is not supported.	1
AuthorizationCode	string	No	The authorization code. You must specify at least one of AuthorizationCode and IpWhitelist. The code can be up to 200 characters in length. Format: [A-Za-z0-9-_.]+	AbcDef123
IpWhitelist	string	No	The IP address whitelist. Subnet masks are supported. You cannot configure 0.0.0.0/0. Separate multiple IP addresses with commas (,). You must specify at least one of IpWhitelist and AuthorizationCode. The whitelist can be up to 1,000 characters in length.	192.168.1.0/24,10.0.0.1/24
IpBlacklist	string	No	The IP blacklist. Subnet masks are supported. You cannot configure 0.0.0.0/0. Separate multiple IP addresses with commas (,). The blacklist can be up to 1,000 characters in length.	103.21.222.1/32,192.168.100.0/24
ClientToken	string	No	The idempotency parameter.	**0311a423d11a5f7dee713535**
LivePackagingConfig	LivePackagingConfig	No	The live packaging configuration.

Response elements

Element	Type	Description	Example
	object	Schema of Response
LivePackageOriginEndpoint	object	The live package origin endpoint.
AuthorizationCode	string	The authorization code.	Abcded123
ChannelName	string	The name of the channel.	channel-1
CreateTime	string	The creation time. The time is in the ISO 8601 format and in UTC (ending with Z).	2023-04-01T12:00:00Z
Description	string	The description of the endpoint.	This is an origin endpoint
EndpointName	string	The name of the endpoint.	endpoint-1
EndpointUrl	string	The playback URL of the endpoint.	https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest
GroupName	string	The name of the channel group.	channel-group-1
IpBlacklist	string	The IP blacklist.	103.21.222.1/32,192.168.100.0/24
IpWhitelist	string	The IP address whitelist.	192.168.1.0/24,10.0.0.1/24
LastModified	string	The last modification time.	2023-04-01T12:00:00Z
ManifestName	string	The name of the manifest.	manifest
Protocol	string	The protocol. Currently, only HLS is supported.	HLS
TimeshiftVision	integer	The timeshift duration in days. Maximum value: 30.	1
LivePackagingConfig	LivePackagingConfig	The live packaging configuration.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****

Examples

Success response

JSON format

{
  "LivePackageOriginEndpoint": {
    "AuthorizationCode": "Abcded123",
    "ChannelName": "channel-1",
    "CreateTime": "2023-04-01T12:00:00Z",
    "Description": "This is an origin endpoint",
    "EndpointName": "endpoint-1",
    "EndpointUrl": "https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest",
    "GroupName": "channel-group-1",
    "IpBlacklist": "103.21.222.1/32,192.168.100.0/24",
    "IpWhitelist": "192.168.1.0/24,10.0.0.1/24",
    "LastModified": "2023-04-01T12:00:00Z",
    "ManifestName": "manifest",
    "Protocol": "HLS",
    "TimeshiftVision": 1,
    "LivePackagingConfig": {
      "DrmConfig": {
        "SystemIds": [
          "9a04f079-9840-4286-ab92-e65be0885f95"
        ],
        "EncryptionMethod": "SAMPLE_AES",
        "IV": "00000000000000000000000000000000",
        "Url": "https://exampledrm.com/path?arg1=xxx",
        "RotatePeriod": 0,
        "ContentId": "live-axb1-9dd2fa123"
      },
      "SegmentDuration": 6,
      "UseAudioRenditionGroups": true,
      "LiveManifestConfigs": [
        {
          "SegmentCount": 3,
          "DateTimeInterval": 5,
          "MinUpdatePeriod": 8,
          "AdMarkers": "NONE",
          "StreamOrder": "ORIGINAL",
          "MinVideoBitrate": 1000000,
          "MaxVideoBitrate": 8000000,
          "MinBufferTime": 8,
          "PresentationDelay": 12,
          "ManifestDuration": 60,
          "SegmentTemplateFormat": "NUMBER_TIMELINE",
          "PartHoldBackMs": 0
        }
      ],
      "PartDurationMs": 0
    }
  },
  "RequestId": "******11-DB8D-4A9A-875B-275798******"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.