All Products
Search
Document Center

CDN:DescribeDomainCcActivityLog

Last Updated:Nov 29, 2024

Queries log entries of rate limiting.

Operation description

  • 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 the StartTime and EndTime parameters, the request returns the data collected within the specified time range. You must set both parameters or leave both parameters empty.
  • You can specify up to 20 domain names in reach request. If you specify multiple domain names, separate them with commas (,).
  • You can query data collected over the last 30 days.
  • You can call this operation up to 50 times per second per account.

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

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The accelerated domain name. You can specify multiple domain names and separate them with commas (,).

If you do not specify this parameter, data of all accelerated domain names under your account is queried.

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.

The minimum time granularity of data collection is 5 minutes.

If you leave this parameter empty, the data collected over the last 24 hours is queried.

2018-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.

2018-12-10T21:00:00Z
TriggerObjectstringNo

The trigger of rate limiting by which you want to query data.

If you leave this parameter empty, all events that triggered rate limiting are queried.

IP
ValuestringNo

The value of the trigger.

If you leave this parameter empty, all events recorded for the trigger are queried.

1.2.3.4
RuleNamestringNo

A custom rule name. Valid values:

  • default_normal: rule for the normal mode
  • default_attack: rule for the emergency mode

If you leave this parameter empty, events that triggered rate limiting based on all rules are queried.

test2
PageSizelongNo

The number of entries to return on each page. Default value: 30.

30
PageNumberlongNo

The page number of the page to return. Default value: 1.

1

Response parameters

ParameterTypeDescriptionExample
object
PageIndexlong

The page number of the returned page.

1
RequestIdstring

The ID of the request.

3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F
PageSizelong

The number of entries returned per page.

30
Totallong

The total number of entries returned.

20
ActivityLogarray<object>

The list of rate limiting logs.

LogInfoobject
Valuestring

The value of the trigger for rate limiting.

1.2.3.4
Ttllong

The period of time during which rate limiting remains effective.

300
Actionstring

The action that was triggered.

deny
TriggerObjectstring

The trigger of rate limiting.

Ip
TimeStampstring

The timestamp of the data returned.

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

The accelerated domain name.

example.com
RuleNamestring

The name of the rule based on which rate limiting was triggered.

test

Examples

Sample success responses

JSONformat

{
  "PageIndex": 1,
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "PageSize": 30,
  "Total": 20,
  "ActivityLog": [
    {
      "Value": "1.2.3.4",
      "Ttl": 300,
      "Action": "deny",
      "TriggerObject": "Ip",
      "TimeStamp": "2015-12-10T20:00:00Z",
      "DomainName": "example.com",
      "RuleName": "test"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidStartTime.MalformedSpecified StartTime is malformed.The specified start time is invalid. For more information, see the API references.
400InvalidEndTime.MalformedSpecified EndTime is malformed.The format of the end time is invalid. Specify a valid value.
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The start time is invalid. Set this parameter to another value and try again.
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.EndTime is earlier than StartTime.

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