All Products
Search
Document Center

PolarDB:ModifyOpenSearchWhitelistGroup

Last Updated:Sep 10, 2026

Modifies a PolarDB-X Search whitelist group.

Operation description


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 in which the instance resides.

cn-hangzhou

DBInstanceName

string

Yes

The instance ID.

pxc-xxx

GroupId

string

Yes

The group ID.

group_y6sqhtr6jyu52w4oublg3674du

IPs

string

Yes

The list of source IP address restrictions.

192.168.1.0/24

Remark

string

No

The remarks.

000G2DJ1YGee321432

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

D6A4256F-7B83-5BD7-9AC0-72E1FAC05330

Data

object

The creation result.

GroupId

string

The group ID, which is a globally unique identifier generated by the system for the group.

g-00mzurifez86htk8fn90

UpdateTime

string

The time when the task was last updated, in timestamp format.

2025-09-17T02:27:11Z

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

The type of the permission denial.

ImplicitDeny

EncodedDiagnosticMessage

string

The encoded diagnostic message.

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "D6A4256F-7B83-5BD7-9AC0-72E1FAC05330",
  "Data": {
    "GroupId": "g-00mzurifez86htk8fn90",
    "UpdateTime": "2025-09-17T02:27:11Z"
  },
  "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.