全部产品
Search
文档中心

对象存储 OSS:GetAccessPoint

更新时间:Apr 28, 2024

调用GetAccessPoint接口获取接入点信息。

注意事项

阿里云账号默认拥有获取接入点信息的权限。如果您希望通过RAM用户或者STS的方式获取接入点信息,您必须拥有oss:GetAccessPoint权限。

请求语法

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

请求头

名称

类型

是否必选

示例值

描述

x-oss-access-point-name

字符串

ap-01

接入点名称。

此接口涉及的其他公共请求头,例如Date,Authorization等。更多信息,请参见公共请求头(Common Request Headers)

响应头

此接口仅包含公共响应头。更多信息,请参见公共响应头(Common Response Headers)

响应元素

名称

类型

示例值

描述

GetAccessPointResult

容器

不涉及

保存接入点信息的容器。

父节点:无

子节点:AccessPointName,Bucket,AccountId,NetworkOrigin,VpcConfiguration,AccessPointArn,CreationDate,Alias,Status和Endpoints

AccessPointName

字符串

ap-01

接入点名称。

父节点:GetAccessPointResult

子节点:无

Bucket

字符串

oss-example

配置接入点的Bucket名称。

父节点:GetAccessPointResult

子节点:无

AccountId

字符串

111933544165xxxx

配置接入点的阿里云账号UID。

父节点:GetAccessPointResult

子节点:无

NetworkOrigin

字符串

vpc

接入点网络来源。返回值如下:

  • vpc:限制仅支持通过指定的VPC ID访问接入点。

  • internet:同时持通过外网和内网Endpoint互联网访问接入点。

父节点:GetAccessPointResult

子节点:无

VpcConfiguration

容器

不涉及

保存VPC网络来源信息的容器。

父节点:GetAccessPointResult

子节点:VpcId

VpcId

字符串

vpc-t4nlw426y44rd3iq4xxxx

专有网络实例ID。

父节点:VpcConfiguration

子节点:无

AccessPointArn

字符串

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

接入点ARN。

父节点:GetAccessPointResult

子节点:无

CreationDate

字符串

1626769503

接入点创建时间,格式为时间戳。

父节点:GetAccessPointResult

子节点:无

Alias

字符串

ap-01-ossalias

接入点别名。

父节点:GetAccessPointResult

子节点:无

Status

enable

接入点所处状态。返回值如下:

  • enable:接入点已创建完成。

  • disable:接入点已禁用。

  • creating:接入点正在创建中。

  • deleting:接入点已删除。

父节点:GetAccessPointResult

子节点:无

Endpoints

容器

不涉及

保存接入点网络来源信息的容器。

父节点:GetAccessPointResult

子节点:PublicEndpoint和InternalEndpoint

PublicEndpoint

字符串

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

接入点的外网Endpoint。

父节点:Endpoints

子节点:无

InternalEndpoint

字符串

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

接入点的内网Endpoint。

父节点:Endpoints

子节点:无

PublicAccessBlockConfiguration

容器

不涉及

保存阻止公共访问信息的容器。

父节点:GetAccessPointResult

子节点:BlockPublicAccess

BlockPublicAccess

布尔值

true

获取接入点的阻止公共访问配置信息。

  • true:开启阻止公共访问。

  • false:关闭阻止公共访问。

父节点:PublicAccessBlockConfiguration

子节点:无

示例

  • 请求示例

    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: OSS qn6q**************:77Dv****************    
  • 返回示例

    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>