DescribeLiveDomainRealtimeLogDelivery - - Alibaba Cloud Documentation Center

Operation description

You can call this operation to query the status of real-time log delivery for a domain name. Ensure that the parameter settings are valid.

QPS limits

This operation is limited to 6,000 queries per second (QPS) per user. Calls that exceed this limit are throttled, which can affect your business. Plan your calls accordingly.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain.	example.com

Response parameters

Parameter	Type	Description	Example
	object
Status	string	The status of real-time log delivery. Valid values: online: Real-time log delivery is enabled. offline: Real-time log delivery is disabled.	online
Logstore	string	The name of the Logstore in Simple Log Service (SLS) for real-time log delivery.	logstore_example
Project	string	The name of the SLS project for real-time log delivery.	project_example
RequestId	string	The request ID.	2F8F3852-912F-42AC-80EB-F1CF4284DE93
Region	string	The region where the SLS project is located.	cn-shanghai

Examples

Success response

JSON format

{
  "Status": "online",
  "Logstore": "logstore_example",
  "Project": "project_example",
  "RequestId": "2F8F3852-912F-42AC-80EB-F1CF4284DE93",
  "Region": "cn-shanghai"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Unauthorized	RealtimeLogDelivery Service Not Authorized
404	Domain.NotFound	Domain not found

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.