DescribeLivePackageConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Obtain the main streaming domain, and then call this operation to query live stream encapsulation configurations.

QPS limit

You can call this operation up to 300 times per minute per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

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:
- The required resource types are displayed in bold characters.
- 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
live:DescribeLivePackageConfig		Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The main streaming domain.	example.com
AppName	string	No	The application name. If you leave this parameter empty, all applications are matched.	AppName
StreamName	string	No	The stream name. If you leave this parameter empty, all streams are matched.	StreamName
PageNum	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 5 to 30. Default value: 10.	10
Order	string	No	The sorting order. Valid values: asc (default): ascending order desc: descending order	asc

Response parameters

Parameter	Type	Description	Example
	object	The encapsulation information.
LivePackageConfigList	array<object>	The live stream encapsulation configurations.
LivePackageConfig	object	The details about the live stream encapsulation configuration.
AppName	string	The application name.	AppName
DomainName	string	The main streaming domain.	example.com
IgnoreTranscode	boolean	Indicates whether the transcoded stream is ignored. Valid values: true (default) false	true
PartDuration	integer	The part length. Unit: milliseconds.	0
Protocol	string	The streaming protocol and encapsulation format.	HLS_CMAF
SegmentDuration	integer	The segment length. Unit: seconds.	5
SegmentNum	integer	The number of segments.	3
StreamName	string	The stream name.	StreamName
Order	string	The sorting order. Valid values: asc (default): ascending order desc: descending order	asc
PageNum	integer	The 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 live stream encapsulation configurations.	1
TotalPage	integer	The total number of pages.	10

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation

No change history