All Products
Search
Document Center

PolarDB:DescribeLakebaseS3Account

Last Updated:Aug 05, 2026

Queries the details of a PolarFS S3 account.

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

Yes

The region ID.

Note

You can call the DescribeRegions operation to query all available regions for your account, including region IDs.

cn-beijing

PfsInstanceId

string

Yes

The PolarFS instance ID.

pfs-xxx

UserAccAk

string

Yes

The Access Key of the S3 account.

Note

The account name supports only uppercase letters, lowercase letters, and digits, with a maximum length of 32 characters.

accname

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

CD3FA5F3-FAF3-44CA-AFFF-BAF869******

UserAccAk

string

The Access Key of the S3 account.

accname

UserAccSk

string

The Secret Key of the S3 account (masked).

password***

UserAccPolicy

string

The policy document of the S3 account.

{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Action":["s3:*"],"Resource":["*"]}]}

Examples

Success response

JSON format

{
  "RequestId": "CD3FA5F3-FAF3-44CA-AFFF-BAF869******",
  "UserAccAk": "accname",
  "UserAccSk": "password***",
  "UserAccPolicy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:*\"],\"Resource\":[\"*\"]}]}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.