All Products
Search
Document Center

PolarDB:ListLakebaseS3Accounts

Last Updated:Aug 05, 2026

Lists PolarFS S3 accounts.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

No

The region ID.

Note

You can call the DescribeRegions operation to query region IDs.

cn-beijing

PfsInstanceId

string

Yes

The PolarFS instance ID.

pfs-xxx

PageSize

integer

No

The number of entries per page.

5

PageNumber

integer

No

The page number.

5

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

925B84D9-CA72-432C-95CF-738C22******

TotalCount

integer

The total number of accounts.

6

PageSize

integer

The number of entries per page.

10

PageNumber

integer

The current page number.

1

S3Accounts

array<object>

The list of S3 accounts.

object

The S3 account object.

UserAccAk

string

The access key of the S3 account.

accname

UserAccSk

string

The secret key of the S3 account (displayed in masked format).

password***

AccountType

string

The account type. Valid values:

  • default: the built-in default account.

  • user: a user-created account.

default

Examples

Success response

JSON format

{
  "RequestId": "925B84D9-CA72-432C-95CF-738C22******",
  "TotalCount": 6,
  "PageSize": 10,
  "PageNumber": 1,
  "S3Accounts": [
    {
      "UserAccAk": "accname",
      "UserAccSk": "password***",
      "AccountType": "default"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.