Description

The ListAccessPoints interface lists the access points under your account that meet the criteria. You can list all access points without any parameters, or specify a bucket name to filter access points linked to that bucket.

Request syntax

Request parameters and headers

For common request headers, see Common Parameters.

Field name	Location	Type	Required	Example value	Description
bucket	Query	String	No	bkt01	Used to filter and specify access points associated with the bucket. If this parameter is provided, the response only returns the list of access points that belong to the bucket.
maxResult	Query	Integer	No	100	Set the maximum number of access points returned per request. The default and maximum value is 1000.
nextToken	Query	String	No	token1	When the previous access point listing result is truncated, TOS returns the NextToken field. You can include this field's value in the next request to retrieve the remaining results.
x-tos-account-id	Header	String	Yes	200********	Your Volcano Engine account ID.

Request body elements

No elements are used.

Response headers

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

Response body elements

Field name	Type	Example value	Description
IsTruncated	Boolean	true	Indicates whether the returned result is truncated: true: indicates that there are still partial results not returned. false: indicates that all results have been returned.
NextToken	String	token	This field appears only when IsTruncated is true. Its value can be used as the nextToken parameter in the next request to retrieve the next page of results.
AccessPoints	Array	-	List of access points.
Name	String	ap-test	Access Point Name. Parent node: AccessPoints.
Alias	String	ap-test-********	Access point alias. Parent node: AccessPoints.
Bucket	String	bkt01	Name of the bucket associated with the access point. Parent node: AccessPoints.
BucketAccountId	String	200********	The account ID that owns the bucket. Parent node: AccessPoints.
AccessPointType	String	Regular	Access point type. The fixed value is Regular. Parent node: AccessPoints.
Status	String	enable	Access point status. Parent node: AccessPoints.
NetworkOrigin	String	internet	Allowed network sources. Parent node: AccessPoints.
AccessPointTrn	String	trn:tos:********	TRN of the access point. Parent node: AccessPoints.
Endpoints	Object	-	The set of domain names for accessing the access point.
ExtranetEndpoint	String	ap-test-200********tos-accesspoint.cn-beijing.volces.com	The extranet endpoint. Parent node: Endpoints.
IntranetEndpoint	String	ap-test-200********tos-accesspoint.cn-beijing.ivolces.com	VPC network access domain name. Parent node: Endpoints.

Sample request

Sample response

Torch Object Storage