DescribeLivePackageConfig API Reference - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the live packaging configuration under a streaming domain.

Operation description

Obtain the primary streaming domain first, and then call this operation to query the live packaging configuration under the streaming domain.

QPS limit

The single-user QPS limit for this operation is 300 calls per minute. If the limit is exceeded, API calls will be throttled, which may affect your business. Please call this operation as appropriate.

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 live streaming domain (primary playback domain).	example.com
AppName	string	No	The app name. Leave empty to match all names.	AppName
StreamName	string	No	The live stream name. Leave empty to match all stream names.	StreamName
PageNum	integer	No	The current page number. Default value: 1.	1
PageSize	integer	No	The page size. Default value: 10. Valid values: 5 to 30.	10
Order	string	No	The sort order. Valid values: asc (default): ascending order. desc: descending order. Valid values: asc : Ascending desc : Descending	asc

Response elements

Element	Type	Description	Example
	object	The packaging configuration information.
LivePackageConfigList	object
LivePackageConfig	array<object>	The packaging configuration list.
	object	The packaging configuration list.
AppName	string	The AppName of the live stream.	AppName
DomainName	string	The main streaming domain,	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 (partial segment). Unit: 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 live M3U8 manifest.	3
StreamName	string	The stream name.	StreamName
Order	string	The sort order. Valid values: asc (default): ascending order. desc: descending order.	asc
PageNum	integer	The current page number.	1
PageSize	integer	The page size.	10
RequestId	string	The request ID.	1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0
TotalNum	integer	The total number of records.	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	Description
400	MissingParam	%s, please check and try again later.	Parameter is missing, please check and try again.
400	InvalidParams	%s, please check and try again later.	Parameter is invalid, please check and try again.
400	ConfigAlreadyExists	%s Please check and try again later.	Configuration already exists, please check and try again.
400	InvalidProtocol	%s, please check and try again later.	The parameter Protocol is invalid, please check and try again.
400	InvalidSegmentNum	%s, please check and try again later.	The parameter SegmentNum is invalid, please check and try again.
400	InvalidSegmentDuration	%s, please check and try again later.	The parameter SegmentDuration is invalid, please check and try again.
400	InvalidPartDuration	%s, please check and try again later.	The parameter PartDuration is invalid, please check and try again.
500	InternalErr	%s, please try again.	Internal error, please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.