全部产品
Search
文档中心

对象存储 OSS:ListBucketAntiDDosInfo

更新时间:Apr 29, 2024

调用ListBucketAntiDDosInfo接口获取Bucket防护信息列表。

注意事项

阿里云账号默认拥有获取Bucket防护信息列表的权限。如果您希望通过RAM用户或者STS的方式获取Bucket防护信息列表,您必须拥有oss:ListBucketAntiDDosInfo权限。具体操作,请参见为RAM用户授权自定义的权限策略

请求语法

GET /?bucketAntiDDos?marker=&max-keys=100 HTTP/1.1
Date:  GMT Date
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

请求头

此接口仅涉及公共请求头。更多信息,请参见公共请求头(Common Request Headers)

请求元素

名称

类型

是否必选

示例值

描述

marker

字符串

设定从marker之后按字母排序开始返回高防实例。

说明

第一次请求时可以将marker设置为空字符串。如果返回结果中IsTruncated存在且为true,则需要将返回结果中的marker字段作为参数进行下一次请求。

max-keys

字符串

100

指定返回的高防实例最大数量。

取值:[1,100]

默认值:100

此接口涉及的其他公共请求头,例如Host、Date等的更多信息,请参见公共请求头(Common Request Headers)

响应头

此接口仅涉及公共响应头。更多信息,请参见公共响应头(Common Response Headers)

响应元素

名称

类型

示例值

描述

AntiDDOSListConfiguration

容器

不涉及

保存Bucket防护信息列表的容器。、

父节点:无

子节点:Marker、IsTruncated、AntiDDOSConfiguration

Marker

字符串

nextMarker

返回字母排序在指定marker之后的高防实例。

父节点:AntiDDOSListConfiguration

子节点:无

IsTruncated

字符串

true

是否已返回所有高防实例。

  • true:本次请求未返回所有高防实例。

  • false:本次请求已返回所有高防实例。

父节点:AntiDDOSListConfiguration

子节点:无

AntiDDOSConfiguration

容器

不涉及

保存高防实例信息的容器。

父节点:AntiDDOSListConfiguration

子节点:InstanceId、Bucket、Owner、Ctime、Mtime、Status、Type、Cnames

InstanceId

字符串

cbcac8d2-4f75-4d6d-9f2e-c3447f73****

高防实例ID。

父节点:AntiDDOSConfiguration

子节点:无

Bucket

字符串

examplebucket

防护的Bucket名称。

父节点:AntiDDOSConfiguration

子节点:无

Owner

字符串

114893010724****

Bucket拥有者的UID。

父节点:AntiDDOSConfiguration

子节点:无

Ctime

字符串

1626769503

高防实例创建时间,格式为时间戳。

父节点:AntiDDOSConfiguration

子节点:无

Mtime

字符串

1626769840

高防实例更新时间,格式为时间戳。

父节点:AntiDDOSConfiguration

子节点:无

ActiveTime

字符串

1626769845

高防实例激活时间,格式为时间戳。

父节点:AntiDDOSConfiguration

子节点:无

Status

字符串

Defending

高防实例所处状态。

  • Init:初始化防护状态。

  • Defending:防护中状态。

  • HaltDefending:解除防护状态。

父节点:AntiDDOSConfiguration

子节点:无

Type

字符串

AntiDDosPremimum

高防实例类型。固定值为AntiDDosPremimum。

父节点:AntiDDOSConfiguration

子节点:无

Cnames

容器

不涉及

保存自定义域名的容器。

父节点:AntiDDOSConfiguration

子节点:Domain

Domain

字符串

abc1.example.cn

自定义域名。

示例

  • 请求示例

GET /?bucketAntiDDos?marker=&max-keys=100 HTTP/1.1
Date:  Fri, 04 Mar 2022 05:34:24 GMT
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
Authorization: OSS qn6q**************:77Dv****************
  • 返回示例

HTTP/1.1 200 OK
Server: AliyunOSS
Date: Fri, 04 Mar 2022 05:34:24 GMT
Content-Length: 0
Connection: keep-alive
x-oss-request-id: 534B371674E88A4D8906****
<?xml version="1.0" encoding="utf-8"?>

<AntiDDOSListConfiguration> 
  <Marker>nextMarker</Marker>
  <IsTruncated>true</IsTruncated>
  <AntiDDOSConfiguration>      
    <InstanceId>cbcac8d2-4f75-4d6d-9f2e-c3447f73****</InstanceId>  
    <Owner>114893010724****</Owner>  
    <Bucket>examplebucket</Bucket>  
    <Ctime>1626769503</Ctime>  
    <Mtime>1626769840</Mtime>  
    <ActiveTime>1626769845</ActiveTime>  
    <Status>Defending</Status>  
    <Type>AntiDDosPremimum</Type>  
    <Cnames> 
      <Domain>abc1.example.cn</Domain>  
      <Domain>abc2.example.cn</Domain> 
    </Cnames> 
  </AntiDDOSConfiguration>  
  <AntiDDOSConfiguration>      
    <InstanceId>cbcae8u6-4f75-4d6d-9f2e-c3446g89****</InstanceId>  
    <Owner>1148930107246818</Owner>  
    <Bucket>test-antiddos2</Bucket>  
    <Ctime>1626769993</Ctime>  
    <Mtime>1626769993</Mtime>  
    <ActiveTime>0</ActiveTime>  
    <Status>Init</Status>  
    <Type>AntiDDosPremimum</Type>  
    <Cnames> 
      <Domain>abc3.example.cn</Domain>  
      <Domain>abc4.example.cn</Domain> 
    </Cnames> 
  </AntiDDOSConfiguration> 
</AntiDDOSListConfiguration>