Query the details about the bills of the burstable clean bandwidth.

Usage notes

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 about 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSystemLog

The operation that you want to perform. Set the value to DescribeSystemLog.

RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: Chinese mainland, which indicates an Anti-DDoS Pro instance. This is the default value.
  • ap-southeast-1: outside the Chinese mainland, which indicates an Anti-DDoS Premium instance.
EntityType Integer No 20

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

Note This parameter is required. Otherwise, the call fails.
EntityObject String No 203.107.XX.XX

The IP address of the Anti-DDoS Pro or Anti-DDoS Premium instance to query.

Note You can call the DescribeInstanceDetails operation to query the IP addresses of all instances.
StartTime Long Yes 1609430400000

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. This value is a UNIX timestamp. Unit: milliseconds.

EndTime Long Yes 1640966400000

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. This value is a UNIX timestamp. Unit: milliseconds.

PageNumber Integer Yes 1

The number of the page to return.

PageSize Integer Yes 10

The number of entries to return on each page.

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

Parameter Type Example Description
Total Long 1

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

RequestId String 8BC3A33A-F832-58DB-952F-7682A25AD14C

The ID of the request.

SystemLog Array of SystemLog

The details about the billing logs for the burstable clean bandwidth.

Status Integer 1

The status of the bill. Valid values:

  • 0: to be billed
  • 1: billed
  • 2: terminated
EntityType Integer 20

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

EntityObject String 203.107.XX.XX

The IP address of the Anti-DDoS Pro or Anti-DDoS Premium instance.

GmtCreate Long 1631793531000

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

OpAction Integer 100

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

GmtModified Long 1635425407000

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

OpAccount String 171986973287****

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

OpDesc String null

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 Anti-DDoS Pro or Anti-DDoS Premium instance. Data type: string.
    • ip: the IP address of the Anti-DDoS Pro or Anti-DDoS Premium instance. Data type: string.
    • maxBw: the peak business 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 business traffic minus the clean bandwidth of the Anti-DDoS Pro or Anti-DDoS Premium instance. Unit: Mbit/s. Data type: integer.
    • peakTime: the time in point of the peak business 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 business traffic range. This value is a UNIX timestamp. Unit: seconds. Data type: long.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeSystemLog
&EndTime=1640966400000
&PageNumber=1
&PageSize=10
&StartTime=1609430400000
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 API Error Center.