Creates an origin endpoint for a live package channel to deliver live streams in HLS format.
Operation description
Usage notes
This API operation is mainly used to configure origin settings, security policies including the IP address blacklist and whitelist and authorization code, and time shifting settings for channels. Before you create an origin endpoint, you must create a live package channel group and channel. After you create the endpoint, the endpoint URL and other configuration details are returned.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ice:CreateLivePackageOriginEndpoint | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| GroupName | string | Yes | The channel group name. | channel-group-1 |
| ChannelName | string | Yes | The channel name. | channel-1 |
| EndpointName | string | Yes | The origin endpoint name. It can contain letters, digits, hyphens (-), and underscores (_). The name must be 1 to 200 characters in length. Format: [A-Za-z0-9_-]+ | endpoint-1 |
| Protocol | string | Yes | The distribution protocol. | HLS |
| ManifestName | string | No | The playlist name. Default value: manifest. | manifest |
| Description | string | No | The endpoint description. | |
| TimeshiftVision | integer | No | The number of days that time-shifted content is available. Maximum value: 30. Default value: 0, which indicates that time shifting is not supported. | 1 |
| AuthorizationCode | string | No | The authorization code. It can be up to 200 characters in length. You must configure AuthorizationCode, IpWhitelist, or both. Format: [A-Za-z0-9-_.]+ | AbcDef123 |
| IpWhitelist | string | No | The IP address whitelist. It supports subnet masks. 0.0.0.0/0 is not allowed. It can be up to 1,000 characters in length. Separate multiple IP addresses with commas (,). You must configure AuthorizationCode, IpWhitelist, or both. | 192.168.1.0/24,10.0.0.1/24 |
| IpBlacklist | string | No | The IP address blacklist. It supports subnet masks. 0.0.0.0/0 is not allowed. It can be up to 1,000 characters in length. Separate multiple IP addresses with commas (,). | 103.21.222.1/32,192.168.100.0/24 |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. | ****0311a423d11a5f7dee713535**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"LivePackageOriginEndpoint": {
"AuthorizationCode": "Abcded123",
"ChannelName": "channel-1",
"CreateTime": "2023-04-01T12:00:00Z",
"Description": "",
"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
},
"RequestId": "******11-DB8D-4A9A-875B-275798******"
}Error codes
For a list of error codes, visit the Service error codes.