DescribeLiveStreamsTotalCount - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

The maximum time range for a single query is 15 days.
You can query data from the last 1.5 years.

QPS limits

The queries per second (QPS) limit for this operation is 100 calls per minute for a single user. If you exceed the 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:DescribeLiveStreamsTotalCount

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The ingest or streaming domain name. This parameter is required to query data for a specific domain name. You can query up to 10 domain names at a time. Separate multiple domain names with commas (,).	example.com
Typ	string	No	If you do not specify this parameter, data is queried by domain name by default. Set this parameter to aliuid to query data by UID.	aliuid
StartTime	string	Yes	The start of the time range to query. Use the yyyy-MM-ddTHH:mm:ssZ format. The time is in Coordinated Universal Time (UTC). Note You can query data from the last 1.5 years.	2023-07-24T16:00:00Z
EndTime	string	Yes	The end of the time range to query. The end time must be later than the start time. Use the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC. Note The time range between StartTime and EndTime cannot exceed 15 days. The EndTime cannot be later than the current time. Data for the current day is available for query on the next day.	2023-07-25T16:00:00Z

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	String FCFFE4A4-F34F-4EEF-B401-36A01689AFBC
StreamCountList	object
StreamCountInfos	array<object>	The stream statistics.
	object	Details of the statistics.
Count	integer	The cumulative number of live streams.	934
Timestamp	string	The timestamp.	2023-07-24T16:00:00Z

Examples

Success response

JSON format

{
  "RequestId": "String\tFCFFE4A4-F34F-4EEF-B401-36A01689AFBC",
  "StreamCountList": {
    "StreamCountInfos": [
      {
        "Count": 934,
        "Timestamp": "2023-07-24T16:00:00Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidParam	Parameter invalid.	Illegal input parameters
400	Duration.Exceed	Duration between StartTime and EndTime is too long.
500	InternalError	The request processing has failed due to backend service exception.
404	InvalidDomain.NotFound	The domain provided does not belong to you.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.