DescribeLivePackageConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage notes

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. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

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

Response parameters

Parameter	Type	Example	Description
PageNum	Integer	1	The page number.
RequestId	String	1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0	The request ID.
Order	String	asc	The sorting order. Valid values: asc (default): ascending order desc: descending order
TotalPage	Integer	10	The total number of pages.
PageSize	Integer	10	The number of entries per page.
TotalNum	Integer	1	The total number of live stream encapsulation configurations.
LivePackageConfigList	Array of LivePackageConfig
LivePackageConfig
AppName	String	AppName	The application name.
SegmentNum	Integer	3	The number of segments.
StreamName	String	StreamName	The stream name.
Protocol	String	HLS_CMAF	The streaming protocol and encapsulation format.
IgnoreTranscode	Boolean	true	Indicates whether the transcoded stream is ignored. Valid values: true (default) false
PartDuration	Integer	0	The part length. Unit: milliseconds.
SegmentDuration	Integer	5	The segment length. Unit: seconds.
DomainName	String	example.com	The main streaming domain.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLivePackageConfig
&DomainName=example.com
&AppName=AppName
&StreamName=StreamName
&PageNum=1
&PageSize=10
&Order=asc
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLivePackageConfigResponse>
    <PageNum>1</PageNum>
    <RequestId>1FEDCFD8-4C5D-5CB3-A5A1-0B59E5AE57B0</RequestId>
    <Order>asc</Order>
    <TotalPage>10</TotalPage>
    <PageSize>10</PageSize>
    <TotalNum>1</TotalNum>
    <LivePackageConfigList>
        <AppName>AppName</AppName>
        <SegmentNum>3</SegmentNum>
        <StreamName>StreamName</StreamName>
        <Protocol>HLS_CMAF</Protocol>
        <IgnoreTranscode>true</IgnoreTranscode>
        <PartDuration>0</PartDuration>
        <SegmentDuration>5</SegmentDuration>
        <DomainName>example.com</DomainName>
    </LivePackageConfigList>
</DescribeLivePackageConfigResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.