All Products
Search

This Product

    ApsaraVideo Live:DescribeLiveRecordVodConfigs

    Document Center

    ApsaraVideo Live:DescribeLiveRecordVodConfigs

    Last Updated:Nov 14, 2024

    Queries Live-to-VOD configurations.

    Operation description

    Usage notes

    Obtain the streaming domain, and then call this operation to query the Live-to-VOD configurations.

    QPS limit

    You can call this operation up to 1,000 times per second 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

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    live:DescribeLiveRecordVodConfigsget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DomainNamestringYes

    The main streaming domain.

    		example.com
    AppNamestringNo

    The name of the application to which the live stream belongs.

    		liveApp****
    StreamNamestringNo

    The name of the live stream.

    		liveStream****
    PageNumlongNo

    The page number. Default value: 1.

    		1
    PageSizelongNo

    The number of entries per page. Default value: 10. Valid values: 5 to 100.

    		10

    Response parameters

    ParameterTypeDescriptionExample
    object
    PageNuminteger

    The page number.

    		1
    RequestIdstring

    The request ID.

    		5056369B-D337-499E-B8B7-B761BD37B08A
    PageSizeinteger

    The number of entries per page.

    		1
    Totalstring

    The total number of entries returned.

    		100
    LiveRecordVodConfigsarray<object>

    The configurations.

    LiveRecordVodConfigobject
    StorageLocationstring

    The storage location.

    		****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com
    AppNamestring

    The name of the application to which the live stream belongs.

    		liveApp****
    AutoComposestring

    Indicates whether automatic merging is enabled. Valid values:

    • ON
    • OFF
    		ON
    OnDemandinteger

    Indicates whether on-demand recording is enabled. Valid values:

    • 0 (default): On-demand recording is disabled.
    • 1: On-demand recording is enabled by using the HTTP callback method.
    		0
    StreamNamestring

    The name of the live stream.

    		liveStream****
    CreateTimestring

    The time when the live stream was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    		2015-12-01T17:37:00Z
    VodTranscodeGroupIdstring

    The ID of the transcoding template group in ApsaraVideo VOD.

    		e2d796d3bb5fd8049d32bff62f94****
    CycleDurationinteger

    The recording cycle. Unit: seconds. Default value: 3600. Valid values: 300 to 21600.

    		360
    DomainNamestring

    The main streaming domain.

    		example.com
    ComposeVodTranscodeGroupIdstring

    The ID of the transcoding template group that was used to automatically merge the VOD files created from the live streams.

    Note This parameter is returned if the value of the AutoCompose parameter is ON.
    		dadfcaadde****

    Examples

    Sample success responses

    JSONformat

    {
  "PageNum": 1,
  "RequestId": "5056369B-D337-499E-B8B7-B761BD37B08A",
  "PageSize": 1,
  "Total": "100",
  "LiveRecordVodConfigs": {
    "LiveRecordVodConfig": [
      {
        "StorageLocation": "****-tjptr2vatm.oss-cn-shanghai.aliyuncs.com",
        "AppName": "liveApp****",
        "AutoCompose": "ON",
        "OnDemand": 0,
        "StreamName": "liveStream****",
        "CreateTime": "2015-12-01T17:37:00Z",
        "VodTranscodeGroupId": "e2d796d3bb5fd8049d32bff62f94****",
        "CycleDuration": 360,
        "DomainName": "example.com",
        "ComposeVodTranscodeGroupId": "dadfcaadde****"
      }
    ]
  }
}

    Error codes

    HTTP status codeError codeError message
    400InternalErrorThe request processing has failed due to backend service exception.

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