All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveRealtimeDeliveryAcc

Last Updated:Nov 14, 2024

Queries the number of real-time log deliveries.

Operation description

  • You can collect statistics on the number of real-time log deliveries. The number of failed real-time log deliveries and the number of successful real-time log deliveries are counted.
  • You can query the data by UID.
  • You are charged for both successful and failed real-time log deliveries.

QPS limit

You can call this operation up to 100 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.

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:DescribeLiveRealtimeDeliveryAccget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
StartTimestringNo

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.

2015-12-10T20:00:00Z
EndTimestringNo

The end 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.

The end time must be later than the start time. The maximum time range that can be specified is one year.

2015-12-10T21:05:00Z
IntervalstringNo

The time granularity of the query. Unit: seconds. Valid values:

  • 300
  • 3600
  • 86400

If you specify an invalid value or do not specify this parameter, the default value is used. If the specified time range is no more than three days, the default value is 300. If the specified time range is more than three days and no more than 30 days, the default value is 3600. If the specified time range is more than 30 days, the default value is 86400.

3600
ProjectstringNo

The name of the Log Service project that is used for real-time log delivery. If you leave this parameter empty, the data of all Log Service projects is returned.

project_example
LogStorestringNo

The name of the Logstore to which log entries are delivered. If you leave this parameter empty, the data of all Logstores is returned.

logstore_example
DomainNamestringNo

The streaming domain.

  • You can query one or more domain names. If you specify multiple domain names, separate them with commas (,).
  • If you leave this parameter empty, the data of all domain names within your Alibaba Cloud account is returned.
example.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

684306D2-2511-4977-991D-CE97E91FD7C0
RealTimeDeliveryAccDataarray<object>

The information about real-time log deliveries.

AccDataobject
TimeStampstring

The timestamp of the data returned.

2015-12-10T20:00:00Z
FailedNuminteger

The number of failed real-time log deliveries.

0
SuccessNuminteger

The number of successful real-time log deliveries.

321321

Examples

Sample success responses

JSONformat

{
  "RequestId": "684306D2-2511-4977-991D-CE97E91FD7C0",
  "RealTimeDeliveryAccData": {
    "AccData": [
      {
        "TimeStamp": "2015-12-10T20:00:00Z",
        "FailedNum": 0,
        "SuccessNum": 321321
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.MalformedSpecified StartTime is malformed.-
400InvalidEndTime.MalformedSpecified EndTime is malformed.-
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The value specified for the StartTime parameter is invalid.
400InvalidEndTime.MismatchSpecified end time does not math the specified start time.The end time does not match the start time. Make sure that the start and end times match.

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

Change history

Change timeSummary of changesOperation
No change history

Special error codes

Error codeError messageHTTP status codeDescription
InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.400The error message returned because the time range that is specified by the EndTime and StartTime parameters exceeds 90 days.
InvalidEndTime.MismatchSpecified EndTime does not math the specified StartTime.400The error message returned because the end time is earlier than the start time.