All Products
Search
Document Center

PolarDB:DescribePolarFsMapping

Last Updated:Aug 05, 2026

Queries the list of PolarFS path mappings.

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

PolarFsInstanceId

string

Yes

The PolarFS instance ID.

pfs-2ze0i7*****

DBClusterId

string

No

The cluster ID.

Note

You can call the DescribeDBClusters operation to query the details of all clusters under your account, including the cluster ID.

pc-**************

PageSize

integer

No

The number of entries per page. Valid values:

  • 30

  • 50

  • 100

Default value: 30.

30

PageNumber

integer

No

The page number.

1

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

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

PageSize

string

The number of entries per page. Valid values:

  • 30

  • 50

  • 100

30

PageNumber

string

The page number.

1

TotalRecordCount

string

The total number of records.

1

PageRecordCount

string

The number of records on the current page.

1

DefaultAccessKeyId

string

The default AccessKey ID at the instance level.

xxx

PathMappingItems

array<object>

The list of path mappings.

object

Bucket

string

The storage bucket.

pfs-xxx.oss-[regionId]-internal.aliyuncs.com

Path

string

The mapping path.

/test

BucketAccessKeyId

string

The AccessKey ID of the storage bucket.

xxx

Examples

Success response

JSON format

{
  "RequestId": "925B84D9-CA72-432C-95CF-738C22******",
  "PageSize": "30",
  "PageNumber": "1",
  "TotalRecordCount": "1",
  "PageRecordCount": "1",
  "DefaultAccessKeyId": "xxx",
  "PathMappingItems": [
    {
      "Bucket": "pfs-xxx.oss-[regionId]-internal.aliyuncs.com",
      "Path": "/test",
      "BucketAccessKeyId": "xxx"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.