文档

ListAccessPoints

更新时间:

调用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>