DescribeSystemLog - 获取系统日志

更新时间: 2024-04-16 14:09:30

查询弹性业务带宽的账单详情。

接口说明

本接口用于查询 DDoS 高防服务的系统日志。系统日志目前只包含弹性业务带宽的出账日志。

如果您已经启用弹性业务带宽,可以调用本接口查询弹性业务带宽的账单详情。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-ddoscoo:DescribeSystemLogRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
EntityTypeinteger

要查询的系统日志的类型。取值固定为 20,表示弹性业务带宽出账日志。

说明 必须设置该参数,否则会调用失败。
20
EntityObjectstring

要查询的 DDoS 高防实例的 IP 地址。

说明 您可以调用 DescribeInstanceDetails 查询 DDoS 高防实例的 IP 地址。
203.107.XX.XX
StartTimelong

设置起始时间,查询在该起始时间后出账的弹性业务带宽账单。使用时间戳表示,单位:毫秒。

1609430400000
EndTimelong

设置结束时间,查询在该结束时间前出账的弹性业务带宽账单。使用时间戳表示,单位:毫秒。

1640966400000
PageNumberinteger

分页查询时,设置当前页面的页码。

1
PageSizeinteger

分页查询时,设置每页包含日志的数量。

10

调用 API 时,除了本文中该 API 的请求参数,还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍,请参见公共参数

调用 API 的请求格式,请参见本文示例中的请求示例。

返回参数

名称类型描述示例值
object
Totallong

查询到的弹性业务带宽出账日志的总数量。

1
RequestIdstring

本次请求的 ID。

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

弹性业务带宽出账日志的详情列表。

Statusinteger

账单的状态。取值:

  • 0:表示待出账。
  • 1:表示已出账。
  • 2:表示终止出账。
1
EntityTypeinteger

系统日志的类型。取值固定为 20,表示弹性业务带宽出账日志。

20
EntityObjectstring

DDoS 高防实例的 IP 地址。

203.107.XX.XX
GmtCreatelong

账单的创建时间。使用时间戳表示,单位:毫秒。

1631793531000
OpActioninteger

操作类型。取值固定为 100,表示新增弹性业务带宽出账记录。

100
GmtModifiedlong

账单最后一次被修改的时间。使用时间戳表示,单位:毫秒。

1635425407000
OpAccountstring

账单所属阿里云账号的 ID。

171986973287****
OpDescstring

账单详情。使用 JSON 结构体转化的字符串表示,JSON 结构体包含以下字段:

  • newEntity:Object 类型,表示账单记录,具体包含以下字段:

    • billValue:Integer 类型 | 计费月份的弹性业务带宽用量,单位:Mbps。
    • instanceId:String 类型 | DDoS 高防实例的 ID。
    • ip:String 类型 | DDoS 高防实例的 IP 地址。
    • maxBw:String 类型 | 计费月份的实际业务流量峰值(月 95 峰值),单位:Mbps。
    • month:Long 类型 | 账单出具月份(计费月份为账单出具月份的上个自然月),使用时间戳表示,单位:毫秒。
    • overBandwidth:Integer 类型 | 实际业务流量峰值超出实例业务带宽规格的带宽大小,单位:Mbps。
    • peakTime:Long 类型 | 实际业务流量峰值的计量时刻,使用时间戳表示,单位:秒。
    • startTimestamp:Long 类型 | 实例业务流量峰值区间的起始时刻,使用时间戳表示,单位:秒。
{"newEntity":{"billValue":"60","instanceId":"ddoscoo-cn-zz121ogz****","ip":"203.107.XX.XX","maxBw":"300","month":1627747200000,"overBandwidth":"120","peakTime":1629871200,"startTimestamp":1629871200}}

示例

正常返回示例

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}}"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

阿里云首页 DDoS防护 相关技术圈