DescribeMeterLiveBypassDuration API Overview - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

DescribeMeterLiveBypassDuration.

Operation description

Maximum query span: 31 days.
Minimum query granularity: 5 minutes.
Maximum query range: data from the last 90 days.

QPS limit

A single user can call this operation up to 10 times per second. If the number of calls exceeds the limit, throttling is triggered, which may affect your business. Refer to QPS limit.

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:DescribeMeterLiveBypassDuration

none

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	Yes	The start time of the query. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.	2022-10-10T20:00:00Z
EndTime	string	Yes	The end time of the query. The end time must be later than the start time. The query granularity must be ≥ 5 minutes and ≤ 31 days. Specify the time in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.	2022-10-10T21:00:00Z
AppId	string	Yes	The application ID. You can view the application ID on the Application Management page of ApsaraVideo Real-time Communication.	4346289a-a790-4869-9e23-22766d5e****
Interval	string	No	The time granularity for querying data. Unit: seconds. Valid values: 300 3600 86400 If this parameter is not specified or set to an unsupported value, the default value 3600 is used.	86400

Response elements

Element	Type	Description	Example
	object	The response parameters.
AudioSummaryDuration	integer	The total audio-only duration at the basic specification. Unit: minutes.	20
Data	array<object>	The usage statistics information.
	object	The usage statistics information.
AudioDuration	integer	The audio-only duration at the basic specification. Unit: minutes.	20
Single_Audio	integer	The single-stream relay audio duration. Unit: minutes.	20
Single_Video	integer	The single-stream relay video duration. Unit: minutes.	30
Timestamp	string	The start time of the time segment. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format in UTC+0.	2022-10-10T20:00:00Z
TotalDuration	integer	The total duration. Unit: minutes.	150
V480Duration	integer	The standard definition duration, with a video resolution of 640 × 480 or lower. Unit: minutes.	30
V720Duration	integer	The high definition duration, with a video resolution of 1280 × 720 or lower. Unit: minutes.	40
V1080Duration	integer	The full high definition duration, with a video resolution of 1920 × 1080 or lower. Unit: minutes.	10
RequestId	string	The request ID.	4B460F8B-993C-4F48-B98A-910811DEBFEB
SingleAudioSummaryDuration	integer	The total single-stream relay audio duration. Unit: minutes.	20
SingleVideoSummaryDuration	integer	The total single-stream relay video duration. Unit: minutes.	30
TotalSummaryDuration	integer	The total duration. Unit: minutes.	150
V480SummaryDuration	integer	The total standard definition duration, with a video resolution of 640 × 480 or lower. Unit: minutes.	30
V720SummaryDuration	integer	The total high definition duration, with a video resolution of 1280 × 720 or lower. Unit: minutes.	40
V1080SummaryDuration	integer	The total full high definition duration, with a video resolution of 1920 × 1080 or lower. Unit: minutes.	10

Examples

Success response

JSON format

{
  "AudioSummaryDuration": 20,
  "Data": [
    {
      "AudioDuration": 20,
      "Single_Audio": 20,
      "Single_Video": 30,
      "Timestamp": "2022-10-10T20:00:00Z",
      "TotalDuration": 150,
      "V480Duration": 30,
      "V720Duration": 40,
      "V1080Duration": 10
    }
  ],
  "RequestId": "4B460F8B-993C-4F48-B98A-910811DEBFEB",
  "SingleAudioSummaryDuration": 20,
  "SingleVideoSummaryDuration": 30,
  "TotalSummaryDuration": 150,
  "V480SummaryDuration": 30,
  "V720SummaryDuration": 40,
  "V1080SummaryDuration": 10
}

Error codes

HTTP status code	Error code	Error message
400	Meter.ParamError	Param Error:%s,Please Check Again.
500	Meter.ServerInternalError	The Request Processing Has Failed Due To Some Unknown Error.
500	Meter.DataSourceQueryError	Data Source Error:%s,Please Try Again.
403	Meter.AuthError	Authentication Failed,Please Try Again.
502	Meter.ReadyTsError	Get ReadyTs Failed,Please Try Again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.