List access points by calling the ListAccessPoints operation - Object Storage Service

Usage notes

An Alibaba Cloud account has permissions to query access point information by default. To perform this operation as a RAM user or by using Security Token Service (STS), you must have the oss:ListAccessPoints permission.

Request syntax

User-level and bucket-level access point queries differ only in the request host. For user-level access points, the host is a public endpoint (example: oss-cn-hangzhou.aliyuncs.com) or an internal endpoint (example: oss-cn-hangzhou-internal.aliyuncs.com). For bucket-level access points, the host is a bucket domain name (example: oss-example.oss-cn-hangzhou.aliyuncs.com).

Query information about user-level access points

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

Query information about bucket-level access points

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

Request headers

A ListAccessPoints request uses only common request headers. For more information, see Common HTTP headers.

Request elements

Element

Type

Required

Example

Description

max-keys

String

No

10

The maximum number of access points to return. Valid values:

For user-level access points: (0,1000].
For bucket-level access points: (0,100].

Note

If results are truncated because of the max-keys limit, the response includes the NextContinuationToken element as the token for the next listing request.

continuation-token

String

No

abc

The token from which the listing starts. Obtain this token from the NextContinuationToken element in the previous response.

Response headers

A ListAccessPoints response contains only common response headers. For more information, see Common HTTP headers.

Response elements

Element	Type	Example	Description
ListAccessPointsResult	Container	N/A	The container for the list result. Parent nodes: none Child nodes: IsTruncated, NextContinuationToken, AccountId, and AccessPoints
IsTruncated	Boolean	true	Indicates whether the results are truncated. Valid values: true: Not all results are returned. false: All results are returned. Parent nodes: ListAccessPointsResult Child nodes: none
NextContinuationToken	String	abc	The token to use for the next listing request. Set continuation-token to this value to retrieve subsequent results. Parent nodes: ListAccessPointsResult Child nodes: none
AccountId	String	111933544165****	The ID of the Alibaba Cloud account that owns the access point. Parent nodes: ListAccessPointsResult Child nodes: none
AccessPoints	Container	N/A	The container for all access points. Parent nodes: ListAccessPointsResult Child nodes: AccessPoint
AccessPoint	Container	N/A	The container for a single access point. Parent nodes: AccessPoints Child nodes: Bucket, AccessPointName, Alias, NetworkOrigin, VpcConfiguration, and Status
Bucket	String	oss-example	The name of the bucket associated with the access point. Parent nodes: AccessPoint Child nodes: none
AccessPointName	String	ap-01	The name of the access point. Parent nodes: AccessPoint Child nodes: none
Alias	String	ap-01-ossalias	The alias of the access point. Parent nodes: AccessPoint Child nodes: none
NetworkOrigin	String	vpc	The network origin of the access point. Valid values: vpc: The access point is accessible only from a specified virtual private cloud (VPC) ID. internet: The access point is accessible from public and internal endpoints. Parent nodes: AccessPoint Child nodes: none
VpcConfiguration	Container	N/A	The container for VPC configuration. Parent nodes: AccessPoint Child nodes: VpcId
VpcId	String	vpc-t4nlw426y44rd3iq4****	The VPC ID. Parent nodes: VpcConfiguration Child nodes: none
Status		enable	The status of the access point. Valid values: enable: The access point is created. disable: The access point is disabled. creating: The access point is being created. deleting: The access point is being deleted. Parent nodes: AccessPoint Child nodes: VpcId

Examples

Sample requests

Sample request for querying information about user-level access points

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: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=content-length,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e

Sample request for querying information about bucket-level access points

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****************

Sample response

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>

ossutil

For information about the ossutil command that corresponds to the ListAccessPoints operation, see list-access-points.