All Products
Search

This Product

    Object Storage Service:GetAccessPoint

    Document Center

    Object Storage Service:GetAccessPoint

    Last Updated:Jun 18, 2026

    Queries the configuration and status of a specified access point.

    Usage notes

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

    Request syntax

    GET /?accessPoint HTTP/1.1
Date: GMT Date
Content-Length: ContentLength
Content-Type: ContentType
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
x-oss-access-point-name: apname
Authorization: SignatureValue

    Request headers

    Header

    Type

    Required

    Example

    Description

    x-oss-access-point-name

    String

    Yes

    ap-01

    The name of the access point.

    This request also includes common request headers such as Date and Authorization. For more information, see Common request headers.

    Response headers

    The response contains only common response headers. For more information, see Common response headers.

    Response elements

    Element

    Type

    Example

    Description

    GetAccessPointResult

    Container

    N/A

    The container for access point information.

    Parent nodes: none

    Child nodes: AccessPointName, Bucket, AccountId, NetworkOrigin, VpcConfiguration, AccessPointArn, CreationDate, Alias, Status, and Endpoints

    AccessPointName

    String

    ap-01

    The name of the access point.

    Parent nodes: GetAccessPointResult

    Child nodes: none

    Bucket

    String

    oss-example

    The name of the bucket associated with the access point.

    Parent nodes: GetAccessPointResult

    Child nodes: none

    AccountId

    String

    111933544165xxxx

    The ID of the Alibaba Cloud account that owns the access point.

    Parent nodes: GetAccessPointResult

    Child nodes: none

    NetworkOrigin

    String

    vpc

    The network origin of the access point. Valid values:

    • vpc: You can use a specific virtual private cloud (VPC) ID to access the access point.

    • internet: You can use public and internal endpoints to access the access point.

    Parent nodes: GetAccessPointResult

    Child nodes: none

    VpcConfiguration

    Container

    N/A

    The container for VPC information.

    Parent nodes: GetAccessPointResult

    Child nodes: VpcId

    VpcId

    String

    vpc-t4nlw426y44rd3iq4xxxx

    The ID of the VPC.

    Parent nodes: VpcConfiguration

    Child nodes: none

    AccessPointArn

    String

    arn:acs:oss:cn-hangzhou:111933544165xxxx:accesspoint/ap-01

    The Alibaba Cloud Resource Name (ARN) of the access point.

    Parent nodes: GetAccessPointResult

    Child nodes: none

    CreationDate

    String

    1626769503

    The time when the access point was created, in Unix timestamp format.

    Parent nodes: GetAccessPointResult

    Child nodes: none

    Alias

    String

    ap-01-ossalias

    The alias of the access point.

    Parent nodes: GetAccessPointResult

    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 deleted.

    Parent nodes: GetAccessPointResult

    Child nodes: none

    Endpoints

    Container

    N/A

    The container for access point endpoint information.

    Parent nodes: GetAccessPointResult

    Child nodes: PublicEndpoint and InternalEndpoint

    PublicEndpoint

    String

    ap-01.oss-cn-hangzhou.oss-accesspoint.aliyuncs.com

    The public endpoint of the access point.

    Parent nodes: Endpoints

    Child nodes: none

    InternalEndpoint

    String

    ap-01.oss-cn-hangzhou-internal.oss-accesspoint.aliyuncs.com

    The internal endpoint of the access point.

    Parent nodes: Endpoints

    Child nodes: none

    PublicAccessBlockConfiguration

    Container

    N/A

    The container for Block Public Access configurations.

    Parent nodes: GetAccessPointResult

    Child nodes: BlockPublicAccess

    BlockPublicAccess

    Boolean

    true

    Specifies whether Block Public Access is enabled for the access point.

    • true: Block Public Access is enabled.

    • false: Block Public Access is disabled.

    Parent nodes: PublicAccessBlockConfiguration

    Child nodes: none

    Examples

    • Sample request

      GET /?accessPoint HTTP/1.1
Date: Mon, 19 Jun 2023 03:15:40 GMT
Content-Length: 10
Content-Type: application/xml
Host: oss-example.oss-cn-hangzhou.aliyuncs.com
x-oss-access-point-name: ap-01
Authorization: OSS4-HMAC-SHA256 Credential=LTAI********************/20250417/cn-hangzhou/oss/aliyun_v4_request,AdditionalHeaders=content-length,Signature=a7c3554c729d71929e0b84489addee6b2e8d5cb48595adfc51868c299c0c218e

    • Sample success response

      HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<GetAccessPointResult>
  <AccessPointName>ap-01</AccessPointName>
  <Bucket>oss-example</Bucket>
  <AccountId>111933544165xxxx</AccountId>
  <NetworkOrigin>vpc</NetworkOrigin>
  <VpcConfiguration>
     <VpcId>vpc-t4nlw426y44rd3iq4xxxx</VpcId>
  </VpcConfiguration>
  <AccessPointArn>arn:acs:oss:cn-hangzhou:111933544165xxxx:accesspoint/ap-01</AccessPointArn>
  <CreationDate>1626769503</CreationDate>
  <Alias>ap-01-ossalias</Alias>
  <Status>enable</Status>
  <Endpoints>
    <PublicEndpoint>ap-01.oss-cn-hangzhou.oss-accesspoint.aliyuncs.com</PublicEndpoint>
    <InternalEndpoint>ap-01.oss-cn-hangzhou-internal.oss-accesspoint.aliyuncs.com</InternalEndpoint>
  </Endpoints>
  <PublicAccessBlockConfiguration>
    <BlockPublicAccess>true</BlockPublicAccess>
  </PublicAccessBlockConfiguration>
</GetAccessPointResult>

    ossutil

    For information about the ossutil command that corresponds to the GetAccessPoint operation, see get-access-point.