All Products
Search
Document Center

PolarDB:CreatePxfs

Last Updated:Sep 10, 2026

Creates an Agent file service instance.

Operation description

Creates an Agent file service instance.

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 parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID.

cn-hangzhou

DBInstanceName

string

Yes

The PolarDB-X instance ID.

pxc-xxxxxxxx

NodeCount

integer

No

The number of nodes.

3

ClassCode

string

No

The node specification.

polarx.pxfs.x4.xlarge

StorageSize

integer

No

The storage size.

500

SecurityIPList

string

No

The IP whitelist.

192.168.1.0/24,10.0.0.1

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Data

object

The response data.

TaskId

integer

The task ID.

123456789

DBInstanceName

string

The PolarDB-X instance ID.

pxc-xxxxxxxx

PxfsInstanceId

string

The Agent file service instance ID.

pxfs-xxxxxxxx

AlreadyExists

boolean

Indicates whether the instance already exists.

false

AccessDeniedDetail

object

The details of the access denial.

AuthAction

string

The authorization action.

xxx

AuthPrincipalType

string

The type of the authorization principal.

222

AuthPrincipalOwnerId

string

The owner ID of the authorization principal.

111

AuthPrincipalDisplayName

string

The display name of the authorization principal.

xxx

PolicyType

string

The policy type.

PRIORITY

NoPermissionType

string

The type of the permission denial.

ImplicitDeny

EncodedDiagnosticMessage

string

The encoded diagnostic message.

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Data": {
    "TaskId": 123456789,
    "DBInstanceName": "pxc-xxxxxxxx",
    "PxfsInstanceId": "pxfs-xxxxxxxx",
    "AlreadyExists": false
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "PRIORITY",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.