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

Queries the details of the real-time packaging configuration for a specified channel.

Operation description

Request description

You can use this API to query the detailed information of a real-time packaging channel under a specified channel, including but not limited to configurations such as the channel creation time, description, ingest endpoints, protocol, segment count, and segment duration.

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

get

*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

Response elements

Element	Type	Description	Example
	object	Schema of Response
LivePackageChannel	object	The detailed information of the real-time packaging channel.
ChannelName	string	The name of the channel.	ch4
CreateTime	string	The creation time. The time is displayed in the ISO 8601 standard in UTC (ending with Z).	2023-04-01T12:00:00Z
Description	string	The description of the channel.	Test channel
GroupName	string	The name of the channel group.	channel-group-1
IngestEndpoints	array<object>	The array of ingest endpoints.
	object	The ingest endpoint.
Id	string	The ID of the ingest endpoint.	ingest1
Password	string	The password.	2F9e******b569c8
Url	string	The URL of the ingest endpoint.	http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest
Username	string	The username.	us12******das
LastModified	string	The last modified time.	2023-04-01T12:00:00Z
Protocol	string	The ingest protocol, such as HLS.	HLS
SegmentCount	integer	The number of m3u8 segments in the ingest stream.	3
SegmentDuration	integer	The segment duration of the ingest stream.	5
RequestId	string	The unique identifier of the request.	RequestId-12345678

Examples

Success response

JSON format

{
  "LivePackageChannel": {
    "ChannelName": "ch4",
    "CreateTime": "2023-04-01T12:00:00Z",
    "Description": "Test channel",
    "GroupName": "channel-group-1",
    "IngestEndpoints": [
      {
        "Id": "ingest1",
        "Password": "2F9e******b569c8",
        "Url": "http://xxx-1.packagepush-abcxxx.ap-southeast-1.aliyuncsiceintl.com/v1/group01/1/ch01/manifest\n",
        "Username": "us12******das"
      }
    ],
    "LastModified": "2023-04-01T12:00:00Z",
    "Protocol": "HLS",
    "SegmentCount": 3,
    "SegmentDuration": 5
  },
  "RequestId": "RequestId-12345678"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.