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

使用说明

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

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSystemLog

要执行的操作。取值:DescribeSystemLog

RegionId String cn-hangzhou

DDoS高防实例所属地域ID。取值:

  • cn-hangzhou(默认):表示中国内地,即DDoS高防(新BGP)实例。
  • ap-southeast-1:表示非中国内地,即DDoS高防(国际)实例。
EntityType Integer 20

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

说明 必须设置该参数,否则会调用失败。
EntityObject String 203.107.XX.XX

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

说明 您可以调用DescribeInstanceDetails查询DDoS高防实例的IP地址。
StartTime Long 1609430400000

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

EndTime Long 1640966400000

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

PageNumber Integer 1

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

PageSize Integer 10

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

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

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

返回数据

名称 类型 示例值 描述
Total Long 1

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

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

本次请求的ID。

SystemLog Array of SystemLog

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

Status Integer 1

账单的状态。取值:

  • 0:表示待出账。
  • 1:表示已出账。
  • 2:表示终止出账。
EntityType Integer 20

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

EntityObject String 203.107.XX.XX

DDoS高防实例的IP地址。

GmtCreate Long 1631793531000

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

OpAction Integer 100

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

GmtModified Long 1635425407000

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

OpAccount String 171986973287****

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

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

账单详情。使用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类型 | 实例业务流量峰值区间的起始时刻,使用时间戳表示,单位:秒。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeSystemLog
&EndTime=1640966400000
&PageNumber=1
&PageSize=10
&StartTime=1609430400000
&<公共请求参数>

正常返回示例

XML格式

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格式

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

错误码

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