All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnWafLogs

Last Updated:Apr 11, 2024

Queries the address from which you can download the Web Application Firewall (WAF) logs of a domain name.

Operation description

Note
  • If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last 24 hours. If you set both these parameters, the request returns the data collected within the specified time range.

  • The log data is collected every hour.

  • 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:DescribeDcdnWafLogsRead
  • Domain
    acs:dcdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringYes

The accelerated domain name. You can specify only one domain name in each request.

example.com
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.

2017-12-21T08: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.

2017-12-22T08:00:00Z
PageSizelongNo

The number of entries to return on each page. Default value: 300. Valid values: 1 to 1000.

300
PageNumberlongNo

The number of the page to return. Valid values: an integer greater than 0.

1

Response parameters

ParameterTypeDescriptionExample
object
DomainLogDetailsobject []

Details about logs returned.

DomainNamestring

The WAF domain name.

example.com
LogCountlong

The total number of entries returned on the current page.

10
LogInfosobject []

The log information.

EndTimestring

The end of the time range during which data was queried.

2015-05-23T14:00:00Z
LogNamestring

The name of the log file.

demo.aliyundoc.com_2015_05_23_2100_2200.xxxxxx.gz
LogPathstring

The path of the log file.

guide.aliyundoc.com-hangzhou.xxx
LogSizelong

The size of the log file. Unit: bytes.

258
StartTimestring

The beginning of the time range during which data was queried.

2015-05-23T13:00:00Z
PageInfosobject

The page information.

PageIndexlong

The page number of the returned page.

1
PageSizelong

The number of entries returned per page.

20
Totallong

The total number of entries returned.

20
RequestIdstring

The ID of the request.

0985A362-C81E-5A56-891D-90226BEECA7C

Examples

Sample success responses

JSONformat

{
  "DomainLogDetails": [
    {
      "DomainName": "example.com\n",
      "LogCount": 10,
      "LogInfos": [
        {
          "EndTime": "2015-05-23T14:00:00Z\n",
          "LogName": "demo.aliyundoc.com_2015_05_23_2100_2200.xxxxxx.gz",
          "LogPath": "guide.aliyundoc.com-hangzhou.xxx\n",
          "LogSize": 258,
          "StartTime": "2015-05-23T13:00:00Z\n"
        }
      ],
      "PageInfos": {
        "PageIndex": 1,
        "PageSize": 20,
        "Total": 20
      }
    }
  ],
  "RequestId": "0985A362-C81E-5A56-891D-90226BEECA7C"
}

Error codes

HTTP status codeError codeError message
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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