DescribeLiveRealtimeDeliveryAcc-阿里云帮助中心

Operation description

Queries statistics on real-time log delivery attempts, including the number of successful and failed log delivery attempts.
Supports queries by UID dimension.
The billable count includes both successful and failed log delivery attempts.

QPS limit

The single-user QPS limit for this API is 100 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Invoke this API appropriately.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
StartTime	string	No	The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2015-12-10T20:00:00Z
EndTime	string	No	The end time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC). The end time must be later than the start time. The interval between the start time and end time cannot exceed one year.	2015-12-10T21:05:00Z
Interval	string	No	The time granularity of the queried data. Unit: seconds. Valid values: 300 3600 86400 If this parameter is not specified or the specified value is not supported, the default value is 300 seconds when the time span does not exceed 3 days, 3600 seconds when the time span exceeds 3 days, and 86400 seconds when the time span exceeds 30 days.	3600
Project	string	No	The Project for real-time log delivery. If this parameter is not specified, the merged data of all Projects is returned by default.	project_example
LogStore	string	No	The Logstore for real-time log delivery. If this parameter is not specified, the merged data of all Logstores is returned by default.	logstore_example
DomainName	string	No	The streaming domain. You can specify a single domain name or multiple domain names. Separate multiple domain names with commas (,). If this parameter is not specified, the merged data of all live streaming domain names is returned by default.	example.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	684306D2-2511-4977-991D-CE97E91FD7C0
RealTimeDeliveryAccData	object
AccData	array<object>	The real-time log delivery count information.
	object
TimeStamp	string	The start of the time slice.	2015-12-10T20:00:00Z
FailedNum	integer	The number of failed real-time log deliveries.	0
SuccessNum	integer	The number of successful real-time log deliveries.	321321

Examples

Success response

JSON format

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

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	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.
400	InvalidEndTime.Mismatch	Specified 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.