全部產品
Search
文件中心

Object Storage Service:ListAccessPoints

更新時間:Jun 08, 2024

調用ListAccessPoints介面擷取使用者層級或Bucket層級的存取點資訊。

注意事項

阿里雲帳號預設擁有擷取存取點資訊的許可權。如果您希望通過RAM使用者或者STS的方式擷取存取點資訊,您必須擁有oss:ListAccessPoints許可權。

請求文法

擷取使用者層級存取點資訊與擷取Bucket層級的存取點資訊的區別僅在於請求Host。擷取使用者層級存取點資訊的請求Host為外網Endpoint(例如oss-cn-hangzhou.aliyuncs.com)或者內網Endpoint(例如oss-cn-hangzhou-internal.aliyuncs.com);擷取Bucket層級存取點資訊的請求Host為Bucket網域名稱,例如oss-example.oss-cn-hangzhou.aliyuncs.com

擷取使用者層級存取點資訊

GET /?accessPoint&max-keys=10&continuation-token=abcd HTTP/1.1
Date: GMT Date
Content-Length:ContentLength
Content-Type: application/xml
Host: oss-cn-hangzhou.aliyuncs.com 
Authorization: SignatureValue

擷取Bucket層級存取點資訊

GET /?accessPoint&max-keys=10&continuation-token=abcd HTTP/1.1
Date: GMT Date
Content-Length:ContentLength
Content-Type: application/xml
Host: BucketName.oss-cn-hangzhou.aliyuncs.com 
Authorization: SignatureValue

要求標頭

此介面僅涉及公用要求標頭。更多資訊,請參見公用要求標頭(Common Request Headers)

請求元素

名稱

類型

是否必選

樣本值

描述

max-keys

字串

10

指定返回存取點的最大數量。取值如下:

  • 擷取使用者層級存取點時,取值要求大於0小於等於1000

  • 擷取Bucket層級存取點時,取值要求大於0小於等於100

說明

如果因為max-keys的設定無法一次完成列舉,返回結果會附加一個<NextContinuationToken>作為下一次列舉的continuation-token。

continuation-token

字串

abc

指定List操作需要從此token開始。您可從返回結果中的NextContinuationToken擷取此token。

回應標頭

此介面僅包含公用回應標頭。更多資訊,請參見公用回應標頭(Common Response Headers)

響應元素

名稱

類型

樣本值

描述

ListAccessPointsResult

容器

不涉及

儲存本次列舉存取點資訊結果的容器。

父節點:無

子節點:IsTruncated,NextContinuationToken,AccountId和AccessPoints

IsTruncated

布爾值

true

請求中返回的結果是否被截斷。傳回值如下:

  • true:表示本次未返回全部結果。

  • false:表示本次已返回全部結果。

父節點:ListAccessPointsResult

子節點:無

NextContinuationToken

字串

abc

表明本次ListAccessPoints請求包含後續結果,需要將NextContinuationToken指定為continuation-token繼續擷取結果。

父節點:ListAccessPointsResult

子節點:無

AccountId

字串

111933544165****

存取點所屬的阿里雲帳號UID。

父節點:ListAccessPointsResult

子節點:無

AccessPoints

容器

不涉及

儲存所有存取點資訊的容器。

父節點:ListAccessPointsResult

子節點:AccessPoint

AccessPoint

容器

不涉及

儲存單個存取點資訊的容器。

父節點:AccessPoints

子節點:Bucket,AccessPointName,Alias,NetworkOrigin,VpcConfiguration和Status

Bucket

字串

oss-example

配置存取點的Bucket名稱。

父節點:AccessPoint

子節點:無

AccessPointName

字串

ap-01

存取點名稱。

父節點:AccessPoint

子節點:無

Alias

字串

ap-01-ossalias

存取點別名。

父節點:AccessPoint

子節點:無

NetworkOrigin

字串

vpc

存取點網路來源。傳回值如下:

  • vpc:僅支援通過指定的VPC ID訪問存取點。

  • internet:同時支援通過外網和內網Endpoint訪問存取點。

父節點:AccessPoint

子節點:無

VpcConfiguration

容器

不涉及

儲存VPC網路來源資訊的容器。

父節點:AccessPoint

子節點:VpcId

VpcId

字串

vpc-t4nlw426y44rd3iq4****

專用網路執行個體ID。

父節點:VpcConfiguration

子節點:無

Status

enable

存取點所處狀態。傳回值如下:

  • enable:存取點已建立完成。

  • disable:存取點已禁用。

  • creating:存取點正在建立中。

  • deleting:存取點已刪除。

父節點:AccessPoint

子節點:VpcId

樣本

  • 請求樣本

    擷取使用者層級存取點資訊的請求樣本

    GET /?accessPoint&max-keys=10&continuation-token=abc HTTP/1.1
    Date: Mon, 19 Jun 2023 03:15:40 GMT
    Content-Length:36
    Content-Type: application/xml
    Host: oss-cn-hangzhou.aliyuncs.com 
    Authorization: OSS qn6q**************:77Dv****************    

    擷取Bucket層級存取點資訊的請求樣本

    GET /?accessPoint&max-keys=10&continuation-token=abc HTTP/1.1
    Date: Mon, 19 Jun 2023 03:15:40 GMT
    Content-Length:36
    Content-Type: application/xml
    Host: oss-example.oss-cn-hangzhou.aliyuncs.com 
    Authorization: OSS qn6q**************:77Dv****************    
  • 返回樣本

    HTTP/1.1 200
    <?xml version="1.0" encoding="UTF-8"?>
    <ListAccessPointsResult>
      <IsTruncated>true</IsTruncated>
      <NextContinuationToken>abc</NextContinuationToken>
      <AccountId>111933544165****</AccountId>
      <AccessPoints>
        <AccessPoint>
          <Bucket>oss-example</Bucket>
          <AccessPointName>ap-01</AccessPointName>
          <Alias>ap-01-ossalias</Alias>
          <NetworkOrigin>vpc</NetworkOrigin>
          <VpcConfiguration>
            <VpcId>vpc-t4nlw426y44rd3iq4****</VpcId>
          </VpcConfiguration>
          <Status>enable</Status>
        </AccessPoint>
        ...
      </AccessPoints>
    </ListAccessPointsResult>