DescribeLivePackageConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the live stream packaging configurations for a specified streaming domain.

Operation description

Before you call this operation, you must obtain the primary streaming domain. You can then use this operation to query the live stream packaging configurations for that domain.

QPS limit

The queries per second (QPS) limit for this operation is 300 calls per minute for each user. If you exceed this limit, API calls are throttled. This may affect your business. We recommend that you call this operation at a reasonable rate.

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

live:DescribeLivePackageConfig

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The primary streaming domain for playback.	example.com
AppName	string	No	The application name. If you leave this parameter empty, it matches all application names.	AppName
StreamName	string	No	The stream name. If you leave this parameter empty, it matches all stream names.	StreamName
PageNum	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Valid values: 5 to 30.	10
Order	string	No	The sort order. Valid values: asc (default): ascending. desc: descending.	asc

Response parameters

Parameter	Type	Description	Example
	object	The packaging configuration information.
LivePackageConfigList	object
LivePackageConfig	array<object>	The list of packaging configurations.
	object	The list of packaging configurations.
AppName	string	The application name.	AppName
DomainName	string	The primary streaming domain for playback.	example.com
IgnoreTranscode	boolean	Indicates whether to ignore transcoded streams. Valid values: true (default): Ignore. false: Do not ignore.	true
PartDuration	integer	The duration of a part segment, in milliseconds.	0
Protocol	string	The live streaming protocol and container format.	HLS_CMAF
SegmentDuration	integer	The segment length, in seconds.	5
SegmentNum	integer	The number of segments in the M3U8 playlist for live streaming.	3
StreamName	string	The stream name.	StreamName
Order	string	The sort order. Valid values: asc (default): ascending. desc: descending.	asc
PageNum	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0
TotalNum	integer	The total number of entries.	1
TotalPage	integer	The total number of pages.	10

Examples

Success response

JSON format

{
  "LivePackageConfigList": {
    "LivePackageConfig": [
      {
        "AppName": "AppName",
        "DomainName": "example.com",
        "IgnoreTranscode": true,
        "PartDuration": 0,
        "Protocol": "HLS_CMAF",
        "SegmentDuration": 5,
        "SegmentNum": 3,
        "StreamName": "StreamName"
      }
    ]
  },
  "Order": "asc",
  "PageNum": 1,
  "PageSize": 10,
  "RequestId": "1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0",
  "TotalNum": 1,
  "TotalPage": 10
}

Error codes

HTTP status code	Error code	Error message
400	MissingParam	%s
400	InvalidParams	%s
400	ConfigAlreadyExists	%s
400	InvalidProtocol	%s
400	InvalidSegmentNum	%s
400	InvalidSegmentDuration	%s
400	InvalidPartDuration	%s
500	InternalErr	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.