All Products
Search
Document Center

:DescribeLiveStreamsTotalCount

Last Updated:Nov 07, 2023

Queries the total number of live streams within a specified time range. Data is collected on a daily basis.

Usage notes

  • The maximum time range for a query is 15 days.
  • You can query data in the last 18 months.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you may 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 DescribeLiveStreamsTotalCount

The operation that you want to perform. Set the value to DescribeLiveStreamsTotalCount.

DomainName String Yes example.com

The ingest domain or streaming domain. This parameter is required if you want to query data based on domain names. You can specify up to 10 domain names. Separate multiple domain names with commas (,).

Typ String No aliuid

The type of data that you want to query. If you leave this parameter empty, data is returned by domain name. If you want to query data by UID, specify the UID for this parameter.

StartTime String Yes 2023-07-24T16:00:00Z

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time must be in UTC.

Note You can query data in the last 18 months.
EndTime String Yes 2023-07-25T16:00:00Z

The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time must be in UTC.

Note The maximum time range for a query is 15 days. The end time must be earlier than the current time. Data of the current day can be queried on the next day.

Response parameters

Parameter

Type

Example

Description

RequestId String String FCFFE4A4-F34F-4EEF-B401-36A01689AFBC

The request ID.

StreamCountList Array of StreamCountInfos

The statistics about the live streams.

StreamCountInfos
Count Integer 934

The total number of live streams.

Timestamp String 2023-07-24T16:00:00Z

The timestamp.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamsTotalCount
&DomainName=example.com
&Typ=aliuid
&StartTime=2023-07-24T16:00:00Z
&EndTime=2023-07-25T16:00:00Z
&Common request parameters

Sample success responses

XML format

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

<DescribeLiveStreamsTotalCountResponse>
    <RequestId>String	FCFFE4A4-F34F-4EEF-B401-36A01689AFBC</RequestId>
    <StreamCountList>
        <Count>934</Count>
        <Timestamp>2023-07-24T16:00:00Z</Timestamp>
    </StreamCountList>
</DescribeLiveStreamsTotalCountResponse>

JSON format

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

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

Error codes

HttpCode

Error code

Error message

Description

400 InvalidStartTime.Malformed Specified StartTime is malformed. The value specified for StartTime is invalid. Check whether the value of the StartTime parameter is valid.
400 InvalidEndTime.Malformed Specified EndTime is malformed. The value specified for EndTime is invalid. Check whether the value of the EndTime parameter is valid.

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

Error code

Error message

HTTP status code

Description

InvalidStartTime.Malformed

Specified StartTime is malformed.

400

The value of the StartTime parameter is invalid.

InvalidEndTime.Malformed

Specified EndTime is malformed.

400

The value of the EndTime parameter is invalid.

MissingDomainName

DomainName is mandatory for this action.

400

The DomainName parameter is left empty.

InvalidParam

Parameter invalid.

400

One or more parameters are invalid.

Duration.Exceed

Duration between StartTime and EndTime is too long.

400

The specified time range exceeds the upper limit.

InvalidDomain.NotFound

The domain provided does not belong to you.

404

The domain name does not exist or does not belong to your account.

InternalError

The request processing has failed due to backend service exception.

500

An internal error occurred.