GetBucketOverwriteConfig

调用GetBucketOverwriteConfig接口获取存储空间(Bucket)的不覆盖写规则配置。

注意事项

如果Bucket未配置不覆盖写规则,则返回404状态码。

权限说明

阿里云账号默认拥有全部权限。阿里云账号下的RAM用户或RAM角色默认没有任何权限,需要阿里云账号或账号管理员通过RAM PolicyBucket Policy授予操作权限。

API

Action

说明

GetBucketOverwriteConfig

oss:GetBucketOverwriteConfig

获取Bucket的不覆盖写规则配置。

请求语法

GET /?overwriteConfig HTTP/1.1
Host: bucket-name.oss-cn-hangzhou.aliyuncs.com
Authorization: SignatureValue

请求头

此接口除支持公共请求头外,无特有请求头。更多信息,请参见公共HTTP头定义

请求元素

此接口不包含请求元素。

响应元素

名称

类型

示例值

描述

OverwriteConfiguration

容器

不覆盖写规则的根节点。
子节点:Rule
父节点:无

Rule

容器

不覆盖写规则项。
子节点:ID、Action、Prefix、Suffix、Principals
父节点:OverwriteConfiguration

ID

字符串

rule-001

规则的唯一标识符。
子节点:无
父节点:Rule

Action

字符串

forbid

操作类型。当前只支持forbid(禁止覆盖写)。
子节点:无
父节点:Rule

Prefix

字符串

a/

Object名称的前缀。
子节点:无
父节点:Rule

Suffix

字符串

.txt

Object名称的后缀。
子节点:无
父节点:Rule

Principals

容器

授权主体集合。
子节点:Principal
父节点:Rule

Principal

字符串

27737962156157xxxx

授权主体。
子节点:无
父节点:Principals

响应头

此接口仅涉及公共响应头。更多信息,请参见公共HTTP头定义

示例

  • 请求示例

    GET /?overwriteConfig HTTP/1.1
    Host: bucket-name.oss-cn-hangzhou.aliyuncs.com
    Authorization: SignatureValue
  • 返回示例

    • 成功返回(已配置规则)

    HTTP/1.1 200 OK
    x-oss-request-id: 5C4E5B5C5E5F5A5B5C5D5E5F
    Date: Mon, 25 Nov 2024 15:00:59 GMT
    Content-Type: application/xml
    Content-Length: 512
    
    <?xml version="1.0" encoding="UTF-8"?>
    <OverwriteConfiguration>
      <Rule>
        <ID>rule-001</ID>
        <Action>forbid</Action>
        <Prefix>a/</Prefix>
        <Suffix>.txt</Suffix>
        <Principals>
          <Principal>27737962156157xxxx</Principal>
        </Principals>
      </Rule>
      <Rule>
        <ID>rule-002</ID>
        <Action>forbid</Action>
        <Prefix>images/</Prefix>
        <Suffix/>
        <Principals/>
      </Rule>
      <Rule>
        <ID>rule-003</ID>
        <Action>forbid</Action>
        <Prefix/>
        <Suffix>.jpg</Suffix>
        <Principals/>
      </Rule>
      <Rule>
        <ID>rule-004</ID>
        <Action>forbid</Action>
        <Prefix/>
        <Suffix/>
        <Principals>
          <Principal>27737962156157xxxx</Principal>
        </Principals>
      </Rule>
    </OverwriteConfiguration>

    这个示例中展现了部分规则可能的样式:

    • Rule1包含指定前后缀和Principal,表示子用户27737962156157xxxx被禁止对前缀为a/、后缀为.txtObject执行覆盖写操作。

    • Rule2仅指定前缀,表示所有用户被禁止对前缀为images/的Object执行覆盖写操作。

    • Rule3仅指定后缀,表示所有用户被禁止对后缀为.jpgObject执行覆盖写操作。

    • Rule4仅指定Principal,表示Principal指定的用户会被禁止对Bucket中所有的Object执行覆盖写操作。

    • 未配置规则返回(404)

    HTTP/1.1 404 Not Found
    x-oss-request-id: 5C4E5B5C5E5F5A5B5C5XXXX
    Date: Mon, 25 Nov 2025 15:00:59 GMT
    Content-Type: application/xml
    Content-Length: 200
    
    <?xml version="1.0" encoding="UTF-8"?>
    <Error>
      <Code>NoSuchOverwriteConfiguration</Code>
      <Message>The specified overwrite configuration does not exist.</Message>
      <RequestId>5C4E5B5C5E5F5A5B5C5XXXX</RequestId>
      <HostId>bucket-name.oss-cn-hangzhou.aliyuncs.com</HostId>
    </Error>