Update Live Package Origin Endpoint via API - Intelligent Media Services - Alibaba Cloud - Intelligent Media Services

Updates the origin endpoint configuration of a channel group for live packaging, including protocol, time-shifting settings, and access control.

Operation description

This operation modifies the origin endpoint configuration of the live packaging service under a specified channel group. You can use this operation to adjust the back-to-origin protocol, set the number of time-shifting days, define playlist names, and configure IP blacklists and whitelists to achieve fine-grained management of live streaming distribution. Some parameters are required. You must specify at least one of the IP whitelist and the back-to-origin request header.

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:UpdateLivePackageOriginEndpoint

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GroupName	string	Yes	The name of an existing channel group.	channel-group-1
ChannelName	string	Yes	The name of an existing channel.	channel-1
EndpointName	string	Yes	The name of the origin endpoint. The name can contain uppercase and lowercase 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 protocol. Currently, only HLS is supported.	HLS
ManifestName	string	No	The playlist name. Default value: manifest.	manifest
Description	string	No	The description of the endpoint.	This is an origin endpoint.
TimeshiftVision	integer	No	The number of time-shifting days. Maximum value: 30.	5
AuthorizationCode	string	No	The authorization code. You must specify at least one of AuthorizationCode and IpWhitelist. Maximum length: 200 characters. Format: [A-Za-z0-9-_.]+	Abc123Def456
IpWhitelist	string	No	The IP whitelist. Subnet masks are supported. The value 0.0.0.0/0 is not allowed. Separate multiple IP addresses with commas (,). You must specify at least one of IpWhitelist and AuthorizationCode. Maximum length: 1000 characters.	192.168.1.0/24,10.0.0.1
IpBlacklist	string	No	The IP blacklist. Subnet masks are supported. Separate multiple IP addresses with commas (,).	103.0.0.0/8
LivePackagingConfig	LivePackagingConfig	No	The live packaging configuration.

Response elements

Element	Type	Description	Example
	object	Schema of Response
LivePackageOriginEndpoint	object	The origin endpoint information.
AuthorizationCode	string	The authorization code.	Abc123Def456
ChannelName	string	The channel name.	channel-1
CreateTime	string	The time when the endpoint was created.	2023-04-01T12:00:00Z
Description	string	The description of the endpoint.	This is an origin endpoint.
EndpointName	string	The endpoint name.	endpoint-1
EndpointUrl	string	The endpoint URL.	https://xxx.packagepull-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest
GroupName	string	The channel group name.	channel-group-1
IpBlacklist	string	The IP blacklist. Subnet masks are supported. Separate multiple IP addresses with commas (,).	10.21.222.1/32,192.168.100.0/24
IpWhitelist	string	The IP whitelist. Subnet masks are supported. Multiple IP addresses are separated with commas (,).	192.168.1.0/24,10.0.0.1/24
LastModified	string	The time when the endpoint was last modified.	2023-04-01T12:00:00Z
ManifestName	string	The playlist name. Default value: manifest.	manifest
Protocol	string	The protocol. Currently, only HLS is supported.	HLS
TimeshiftVision	integer	The number of time-shifting days. Maximum value: 30.	5
LivePackagingConfig	LivePackagingConfig	The live packaging configuration.
RequestId	string	The request ID.	5D87B753-0250-5D9D-B248-D40C3271F864

Examples

Success response

JSON format

{
  "LivePackageOriginEndpoint": {
    "AuthorizationCode": "Abc123Def456",
    "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": "10.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": 5,
    "LivePackagingConfig": {
      "LiveManifestConfigs": [
        {
          "SegmentCount": 3,
          "AdMarkers": "NONE",
          "MinVideoBitrate": 1000000,
          "MinBufferTime": 8,
          "PresentationDelay": 12,
          "StreamOrder": "ORIGINAL",
          "MaxVideoBitrate": 8000000,
          "DateTimeInterval": 5,
          "SegmentTemplateFormat": "NUMBER_TIMELINE",
          "MinUpdatePeriod": 8,
          "ManifestDuration": 60
        }
      ],
      "UseAudioRenditionGroups": true,
      "DrmConfig": {
        "SystemIds": [
          "9a04f079-9840-4286-ab92-e65be0885f95"
        ],
        "RotatePeriod": 0,
        "ContentId": "live-axb1-9dd2fa123",
        "EncryptionMethod": "SAMPLE_AES",
        "IV": "00000000000000000000000000000000",
        "Url": "https://exampledrm.com/path?arg1=xxx"
      },
      "SegmentDuration": 6
    }
  },
  "RequestId": "5D87B753-0250-5D9D-B248-D40C3271F864"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.