All Products
Search
Document Center

PolarDB:CreateLakebaseS3Account

Last Updated:Aug 05, 2026

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

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 can contain only uppercase letters, lowercase letters, and digits, and cannot exceed 32 characters in length.

accname

UserAccSk

string

Yes

The Secret Key of the S3 account (@sensitive, encryption in transit).

Note

The key must contain uppercase letters, lowercase letters, and digits, and must be greater than 18 and no more than 32 characters in length.

password***

UserAccPolicy

string

No

A policy document in JSON format that defines the permissions of the S3 account. If this parameter is not specified, the default policy is used.

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

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

24A1990B-4F6E-482B-B8CB-75C612******

Examples

Success response

JSON format

{
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.