调用DescribeOpEntities查询DDoS原生防护的操作日志。

使用说明

本接口用于分页查询DDoS原生防护的操作日志。

QPS限制

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

调试

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

请求参数

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

要执行的操作。取值:DescribeOpEntities

CurrentPage Integer 1

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

PageSize Integer 10

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

StartTime Long 1609430400000

设置开始时间,查询在StartTime后产生的操作日志。使用时间戳表示,单位:毫秒。

EndTime Long 1640880000000

设置结束时间,查询在EndTime前产生的操作日志。使用时间戳表示,单位:毫秒。

OrderBy String opdate

设置操作日志的排序字段。取值固定为opdate,表示按照操作时间排序。

OrderDir String ASC

设置操作日志的排序方式。取值:

  • ASC:表示按照正序排序。
  • DESC:表示按照倒序排序。
InstanceId String ddosbgp-cn-n6w1r7nz****

要查询的DDoS原生防护实例的ID。

说明 您可以调用DescribeInstanceList查询所有DDoS原生防护实例的ID。
ResourceGroupId String rg-acfm2pz25js****

DDoS原生防护实例在资源管理服务中所属的资源组ID。

不设置该参数表示默认资源组。

RegionId String cn-hangzhou

DDoS原生防护实例所在地域ID。

说明 您可以调用DescribeRegions查询DDoS原生防护支持的所有地域ID。

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

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

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

查询到的操作日志的总数量。

RequestId String 52C8ECB0-0B1A-4E66-A31C-B6A855120E82

本次请求的ID。

OpEntities Array of OpEntity

操作日志的详情列表。

EntityType Integer 1

操作对象类型。取值固定为1,表示DDoS原生防护实例。

EntityObject String ddosbgp-cn-n6w1r7nz****

操作对象,即DDoS原生防护实例的ID。

OpAction Integer 8

操作类型。取值:

  • 3:表示为DDoS原生防护实例添加防护IP。
  • 4:表示为DDoS原生防护实例解绑防护IP。
  • 5:表示为DDoS原生防护实例降配。
  • 6:表示解除黑洞。
  • 7:表示重置解除黑洞次数。
  • 8:表示恢复弹性防护。
GmtCreate Long 1635818114000

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

OpAccount String 171986973287****

执行本次操作的阿里云账号ID。

说明 如果取值为system,表示本次操作由DDoS原生防护服务自动执行。
OpDesc String {"entity":{"baseBandwidth":20,"elasticBandwidth":20}}

操作详情。使用JSON结构体转换的字符串表示。JSON结构体包含以下字段:

  • entity:Object类型 | 表示操作对象。根据操作类型(OpAction)不同,entity包含的字段不同。具体说明如下:
    • OpAction3(表示添加防护IP)时,entity包含以下字段:
      • ips:Array类型 | 表示绑定到原生防护实例防护的公网IP资产列表。
    • OpAction4(表示解绑防护IP)时,entity包含以下字段:
      • ips:Array类型 | 表示从原生防护实例解除防护的公网IP资产列表。
    • OpAction5(表示实例降配)时,entity包含以下字段:
      • baseBandwidth:Integer类型 | 表示基础防护带宽,单位:Gbps。
      • elasticBandwidth:Integer类型 | 表示弹性防护带宽,单位:Gbps。
      • opSource:Integer类型 | 操作来源,取值固定为1(表示由DDoS原生防护服务自动执行本次操作)。
    • OpAction6(表示解除黑洞)时,entity包含以下字段:
      • ips:Array类型 | 表示解除黑洞状态的公网IP资产列表。
    • OpAction7(表示重置解除黑洞次数)时,entity为空。
    • OpAction8(表示实恢复弹性防护)时,entity包含以下字段:
      • baseBandwidth:Integer类型 | 表示基础防护带宽,单位:Gbps。
      • elasticBandwidth:Integer类型 | 表示弹性防护带宽,单位:Gbps。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeOpEntities
&CurrentPage=1
&PageSize=10
&StartTime=1609430400000
&EndTime=1640880000000
&OrderBy=opdate
&OrderDir=ASC
&InstanceId=ddosbgp-cn-n6w1r7nz****
&ResourceGroupId=rg-acfm2pz25js****
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

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

<DescribeOpEntitiesResponse>
    <TotalCount>1</TotalCount>
    <RequestId>52C8ECB0-0B1A-4E66-A31C-B6A855120E82</RequestId>
    <OpEntities>
        <EntityType>1</EntityType>
        <EntityObject>ddosbgp-cn-n6w1r7nz****</EntityObject>
        <OpAction>8</OpAction>
        <GmtCreate>1635818114000</GmtCreate>
        <OpAccount>171986973287****</OpAccount>
        <OpDesc>{"entity":{"baseBandwidth":20,"elasticBandwidth":20}}</OpDesc>
    </OpEntities>
</DescribeOpEntitiesResponse>

JSON格式

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

{
  "TotalCount" : 1,
  "RequestId" : "52C8ECB0-0B1A-4E66-A31C-B6A855120E82",
  "OpEntities" : [ {
    "EntityType" : 1,
    "EntityObject" : "ddosbgp-cn-n6w1r7nz****",
    "OpAction" : 8,
    "GmtCreate" : 1635818114000,
    "OpAccount" : "171986973287****",
    "OpDesc" : "{\"entity\":{\"baseBandwidth\":20,\"elasticBandwidth\":20}}"
  } ]
}

错误码

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