All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnSLSRealtimeLogDelivery

Last Updated:Apr 11, 2024

Queries a real-time log delivery project.

Operation description

Note You can call this operation up to 100 times per second per account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
dcdn:DescribeDcdnSLSRealtimeLogDeliveryRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectNamestringYes

The name of a real-time log delivery project.

example

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

F32C57AA-7BF8-49AE-A2CC-9F42390F5A19
Contentobject

The configuration results of the domain name.

Statusstring

The status of real-time logs.

  • success
  • fail
success
Typestring

The type of log delivery. Only SLS_POST is supported.

SLS_POST
SLSLogStorestring

The name of the Logstore.

example-cn
DataCenterstring

The region from which logs were collected.

cn
FieldNamestring

The name of the field. For more information about fields in real-time log entries, see Fields in a real-time log.

field1,field2
ProjectNamestring

The name of the project.

example
SamplingRatestring

The sampling rate.

1.0
SLSProjectstring

The name of the log file.

example-cn
DomainNamestring

The domain names from which logs were collected. You can specify one or more domain names. Separate multiple domain names with commas (,).

example.com,example.org
BusinessTypestring

The type of the collected logs. Default value: cdn_log_access_l1. Valid values:

  • cdn_log_access_l1: access logs of Dynamic Content Delivery Network (DCDN) points of presence (POPs)
  • cdn_log_origin: back-to-origin logs
  • cdn_log_er: EdgeRoutine logs
cdn_log_access_l1
SLSRegionstring

The region to which logs were delivered.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "F32C57AA-7BF8-49AE-A2CC-9F42390F5A19",
  "Content": {
    "Status": "success",
    "Type": "SLS_POST",
    "SLSLogStore": "example-cn",
    "DataCenter": "cn",
    "FieldName": "field1,field2",
    "ProjectName": "example",
    "SamplingRate": "1.0",
    "SLSProject": "example-cn",
    "DomainName": "example.com,example.org",
    "BusinessType": "cdn_log_access_l1",
    "SLSRegion": "cn-hangzhou"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400ProjectNotFoundThe project provided does not belong to you.The project does not exist or does not belong to the current user.

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