All Products
Search
Document Center

PolarDB:CreatePxfsTenant

Last Updated:Sep 10, 2026

Creates an Agent file service tenant.

Operation description

Creates an Agent file service tenant.

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 instance ID of the PolarDB-X instance.

pxc-xxxxxxxx

TenantId

string

Yes

The tenant ID.

tenant-001

TenantName

string

Yes

The tenant name.

agent-files

QuotaBytes

integer

Yes

The capacity quota.

107374182400

QuotaFiles

integer

Yes

The file count quota.

1000000

RateLimitRps

integer

No

The maximum request rate.

1000

RateLimitWbps

integer

No

The maximum write bandwidth.

104857600

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.

TenantId

string

The tenant ID.

tenant-001

TenantName

string

The tenant name.

agent-files

QuotaBytes

integer

The capacity quota.

107374182400

QuotaFiles

integer

The file count quota.

1000000

RateLimitRps

integer

The maximum request rate.

1000

RateLimitWbps

integer

The maximum write bandwidth.

104857600

Status

string

The status.

ACTIVE

AccessDeniedDetail

object

The details of the access denial.

AuthAction

string

The authentication action.

xxx

AuthPrincipalType

string

The type of the authentication principal.

222

AuthPrincipalOwnerId

string

The owner ID of the authentication principal.

111

AuthPrincipalDisplayName

string

The display name of the authentication principal.

xxx

PolicyType

string

The policy type.

PRIORITY

NoPermissionType

string

NoPermissionType

ImplicitDeny

EncodedDiagnosticMessage

string

The encoded diagnostic message.

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Data": {
    "TenantId": "tenant-001",
    "TenantName": "agent-files",
    "QuotaBytes": 107374182400,
    "QuotaFiles": 1000000,
    "RateLimitRps": 1000,
    "RateLimitWbps": 104857600,
    "Status": "ACTIVE"
  },
  "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.