All Products
Search

This Product

    Anti-DDoS:DescribeSystemLog

    Document Center

    Anti-DDoS:DescribeSystemLog

    Last Updated:Jul 25, 2025

    Queries the billing details of burstable clean bandwidth.

    Operation description

    This operation lets you query the system logs of Anti-DDoS Pro. System logs currently include only the billing logs of burstable clean bandwidth.

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

    QPS limits

    The QPS limit for this operation is 10 per second per user. If the number of calls per second exceeds this limit, throttling is triggered. This may affect your business operations. Therefore, call this operation at an appropriate frequency.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    yundun-ddoscoo:DescribeSystemLog

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    EntityType

    integer

    No

    The type of system logs to query. The value is fixed at 20, which indicates the billing logs of burstable clean bandwidth.

    Note

    You must set this parameter. Otherwise, the call fails.

    20
    EntityObject

    string

    No

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

    Note

    You can call DescribeInstanceDetails to query the IP addresses of Anti-DDoS instances.

    203.107.XX.XX
    StartTime

    integer

    Yes

    The start time to query bills of burstable clean bandwidth that are generated after the specified time. This value is a timestamp in milliseconds.

    1609430400000
    EndTime

    integer

    Yes

    The end time to query bills of burstable clean bandwidth that are generated before the specified time. This value is a timestamp in milliseconds.

    1640966400000
    PageNumber

    integer

    Yes

    The page number of the returned page.

    1
    PageSize

    integer

    Yes

    The number of logs to return on each page.

    10

    When you call this operation, in addition to the preceding operation-specific request parameters, you must also specify common request parameters. For more information, see Common parameters.

    For the request format, see the "Examples" section of this topic.

    Response parameters

    Parameter

    Type

    Description

    Example

    object

    Total

    integer

    The total number of billing logs for burstable clean bandwidth that are queried.

    1
    RequestId

    string

    The ID of the request.

    8BC3A33A-F832-58DB-952F-7682A25AD14C
    SystemLog

    array<object>

    The details of the billing logs for burstable clean bandwidth.

    object

    Status

    integer

    The status of the bill. Valid values:

    • 0: indicates that the bill is pending.

    • 1: indicates that the bill is generated.

    • 2: indicates that the bill is terminated.

    1
    EntityType

    integer

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

    20
    EntityObject

    string

    The IP address of the Anti-DDoS instance.

    203.107.XX.XX
    GmtCreate

    integer

    The time when the bill was created. This value is a timestamp in milliseconds.

    1631793531000
    OpAction

    integer

    The operation type. The value is fixed at 100, which indicates that a billing record for burstable clean bandwidth is added.

    100
    GmtModified

    integer

    The time when the bill was last modified. This value is a timestamp in milliseconds.

    1635425407000
    OpAccount

    string

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

    171986973287****
    OpDesc

    string

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

    • newEntity: Object type, which indicates the bill record and contains the following fields:

      • billValue: Integer type | The usage of burstable clean bandwidth in the billing month. Unit: Mbit/s.

      • instanceId: String type | The ID of the Anti-DDoS instance.

      • ip: String type | The IP address of the Anti-DDoS instance.

      • maxBw: String type | The actual peak value of service traffic in the billing month (monthly 95th percentile). Unit: Mbit/s.

      • month: Long type | The month when the bill is generated (the billing month is the calendar month before the month when the bill is generated). This value is a timestamp in milliseconds.

      • overBandwidth: Integer type | The bandwidth that exceeds the clean bandwidth specification of the instance. Unit: Mbit/s.

      • peakTime: Long type | The time when the actual peak value of service traffic is measured. This value is a timestamp in seconds.

      • startTimestamp: Long type | The start time of the period when the peak value of instance service traffic is measured. This value is a timestamp in seconds.

    {"newEntity":{"billValue":"60","instanceId":"ddoscoo-cn-zz121ogz****","ip":"203.107.XX.XX","maxBw":"300","month":1627747200000,"overBandwidth":"120","peakTime":1629871200,"startTimestamp":1629871200}}

    Examples

    Success response

    JSON format

    {
  "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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.