ListLivePackageOriginEndpoints - Intelligent Media Services

Queries origin endpoints by channel group and channel name. Paging and sorting are supported.

Operation description

Usage notes

This API operation allows you to query origin endpoints associated with a live package channel. The results include detailed configurations about the origin endpoints, such as access URL, protocol, and security policies. Paging and sorting by creation time are supported.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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:ListLivePackageOriginEndpoints	list	All Resources ``	none	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
Keyword	string	No	The endpoint name or description. Fuzzy match is supported.	endpoint-
PageNo	long	No	The page number.	1
PageSize	long	No	The number of entries per page.	10
SortBy	string	No	The sort order by creation time. Valid values: asc and desc (default).	desc

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
LivePackageOriginEndpoints	array<object>	The origin endpoints returned.
livePackageOriginEndpoint	object	LivePackageOriginEndpointItemType
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 endpoint description.
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.m3u8
GroupName	string	The channel group name.	channel-group-1
IpBlacklist	string	The IP address blacklist.	10.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 time when the endpoint was last modified.	2023-04-01T12:00:00Z
ManifestName	string	The playlist name.	manifest
Protocol	string	The distribution protocol.	HLS
TimeshiftVision	integer	The number of days that time-shifted content is available.	1
PageNo	long	The page number.	1
PageSize	long	The number of entries per page.	10
RequestId	string	The request ID.	b9f90a7ac8904db28dc18e0c2a72c75d
SortBy	string	The sort order. Valid values: `asc` and `desc` (default).	desc
TotalCount	long	The total number of entries returned.	10

Examples

Sample success responses

JSONformat

{
  "LivePackageOriginEndpoints": [
    {
      "AuthorizationCode": "Abc123Def456",
      "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.m3u8",
      "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": 1
    }
  ],
  "PageNo": 1,
  "PageSize": 10,
  "RequestId": "b9f90a7ac8904db28dc18e0c2a72c75d",
  "SortBy": "desc",
  "TotalCount": 10
}

Error codes

For a list of error codes, visit the Service error codes.