DescribeLiveShiftConfigs - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

After you obtain a streaming domain name, you can call this operation to query the time-shifting configurations for the specified domain name.

QPS limit

You can make up to 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which 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:DescribeLiveShiftConfigs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
DomainName	string	Yes	The streaming domain name.	example.com

Response elements

Element	Type	Description	Example
	object	The time shifting configurations.
RequestId	string	The ID of the request.	B49E6DDA-F413-422B-B58E-2FA23F286726
Content	object
Config	array<object>	The list of configurations.
	object	The list of configurations.
AppName	string	The application name.	liveApp****
Vision	integer	The retention period in days.	7
DomainName	string	The domain name.	example.com
StreamName	string	The stream name.	liveStream****
IgnoreTranscode	boolean	Indicates whether to generate time-shifted streams for transcoded streams. Valid values: true: Time-shifted streams are not generated for transcoded streams. false: Time-shifted streams are generated for transcoded streams. The default value is true.	true

## Special error codes | Error code | Error message | HTTP status code | Description | | ---------- | ------------- | ---------------- | ----------- | | InvalidParam | Invalid parameter | 400 | One or more specified parameters are invalid. | | InvalidDataNotFound | Data not found | 404 | The user data cannot be found. |

Examples

Success response

JSON format

{
  "RequestId": "B49E6DDA-F413-422B-B58E-2FA23F286726",
  "Content": {
    "Config": [
      {
        "AppName": "liveApp****",
        "Vision": 7,
        "DomainName": "example.com",
        "StreamName": "liveStream****",
        "IgnoreTranscode": true
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParam	%s
404	InvalidDataNotFound	%s
409	InvalidStreamNum	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.