All Products
Search
Document Center

PolarDB:ModifyPxfsSecurityIps

Last Updated:Sep 10, 2026

Modifies the whitelist of the Agent file service.

Operation description

Modifies the whitelist of the Agent file service.

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

pxc-xxxxxxxx

SecurityIPList

string

Yes

The IP whitelist.

192.168.1.0/24,10.0.0.1

GroupName

string

No

The name of the whitelist group.

default

ModifyMode

string

No

The modification mode of the whitelist.

0

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

AccessDeniedDetail

object

The details of the access denial.

AuthAction

string

The authorization action.

xxx

AuthPrincipalType

string

The description is the same as above.

222

AuthPrincipalOwnerId

string

The owner ID of the authorization principal.

111

AuthPrincipalDisplayName

string

The identity used for authentication in the request.

xxx

PolicyType

string

The policy type.

PRIORITY

NoPermissionType

string

NoPermissionType

ImplicitDeny

EncodedDiagnosticMessage

string

The diagnostic information.

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Data": {
    "TaskId": 123456789
  },
  "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.