All Products
Search
Document Center

Anti-DDoS:DescribeSystemLog

Last Updated:Apr 16, 2024

Queries the details of the bills for the burstable clean bandwidth.

Operation description

You can call the DescribeSystemLog operation to query the system logs of Anti-DDoS Pro or Anti-DDoS Premium. The system logs contain only billing logs for the burstable clean bandwidth.

If you have enabled the burstable clean bandwidth feature, you can call this operation to query the details of the bills of the burstable clean bandwidth.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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
yundun-ddoscoo:DescribeSystemLogRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EntityTypeintegerNo

The type of the system log. Set the value to 20, which indicates the billing logs for the burstable clean bandwidth.

Note You must specify this parameter. Otherwise, the call fails.
20
EntityObjectstringNo

The IP address of the instance.

Note You can call the DescribeInstanceDetails operation to query the IP addresses of all instances.
203.107.XX.XX
StartTimelongYes

The beginning of the time range to query. The bills of the burstable clean bandwidth that are issued after this point in time are queried. The value is a UNIX timestamp. Unit: milliseconds.

1609430400000
EndTimelongYes

The end of the time range to query. The bills of the burstable clean bandwidth that are issued before this point in time are queried. The value is a UNIX timestamp. Unit: milliseconds.

1640966400000
PageNumberintegerYes

The number of the page to return.

1
PageSizeintegerYes

The number of entries to return on each page.

10

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

ParameterTypeDescriptionExample
object
Totallong

The total number of billing logs for the burstable clean bandwidth.

1
RequestIdstring

The ID of the request.

8BC3A33A-F832-58DB-952F-7682A25AD14C
SystemLogobject []

An array that consists of details of the billing logs for the burstable clean bandwidth.

Statusinteger

The status of the bill. Valid values:

  • 0: to be billed
  • 1: billed
  • 2: terminated
1
EntityTypeinteger

The type of the system log. The value is fixed as 20, which indicates the billing logs for burstable clean bandwidth.

20
EntityObjectstring

The IP address of the instance.

203.107.XX.XX
GmtCreatelong

The time when the bill was generated. The value is a UNIX timestamp. Unit: milliseconds.

1631793531000
OpActioninteger

The operation type. The value is fixed as 100, which indicates the billing logs for the burstable clean bandwidth that you increased.

100
GmtModifiedlong

The time when the bill was last modified. The value is a UNIX timestamp. Unit: milliseconds.

1635425407000
OpAccountstring

The ID of the Alibaba Cloud account to which the bill belongs.

171986973287****
OpDescstring

The details of the bill. The value is a string that consists of a JSON struct. The JSON struct contains the following fields:

  • newEntity: the bill record, which contains the following fields. Data type: object.

    • billValue: the usage of the burstable clean bandwidth within a month. Unit: Mbit/s. Data type: integer.
    • instanceId: the ID of the instance. Data type: string.
    • ip: the IP address of the instance. Data type: string.
    • maxBw: the peak service traffic (monthly 95th percentile bandwidth) within a month. Unit: Mbit/s. Data type: string.
    • month: the month in which the bill of the previous calendar month is issued. This value is a UNIX timestamp. Unit: milliseconds. Data type: long.
    • overBandwidth: the peak service traffic minus the clean bandwidth of the instance. Unit: Mbit/s. Data type: integer.
    • peakTime: the time in point of the peak service traffic that is measured for billing. This value is a UNIX timestamp. Unit: seconds. Data type: long.
    • startTimestamp: the beginning of the time range for the peak service traffic range. This value is a UNIX timestamp. Unit: seconds. Data type: long.
{"newEntity":{"billValue":"60","instanceId":"ddoscoo-cn-zz121ogz****","ip":"203.107.XX.XX","maxBw":"300","month":1627747200000,"overBandwidth":"120","peakTime":1629871200,"startTimestamp":1629871200}}

Examples

Sample success responses

JSONformat

{
  "Total": 1,
  "RequestId": "8BC3A33A-F832-58DB-952F-7682A25AD14C",
  "SystemLog": [
    {
      "Status": 1,
      "EntityType": 20,
      "EntityObject": "203.107.XX.XX",
      "GmtCreate": 1631793531000,
      "OpAction": 100,
      "GmtModified": 1635425407000,
      "OpAccount": "171986973287****",
      "OpDesc": "{\"newEntity\":{\"billValue\":\"60\",\"instanceId\":\"ddoscoo-cn-zz121ogz****\",\"ip\":\"203.107.XX.XX\",\"maxBw\":\"300\",\"month\":1627747200000,\"overBandwidth\":\"120\",\"peakTime\":1629871200,\"startTimestamp\":1629871200}}"
    }
  ]
}

Error codes

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