All Products
Search

This Product

    PolarDB:ModifyContextDBSecurityIps

    Document Center

    PolarDB:ModifyContextDBSecurityIps

    Last Updated:Sep 10, 2026

    Modifies the whitelist of a ContextDB-X service ReplicaSet.

    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-htri0****r4k9p
    SecurityIPList

    string

    Yes

    The IP addresses in the whitelist group. Separate multiple IP addresses with commas (,).

    127.0.0.1,192.168.0.0
    GroupName

    string

    No

    The name of the whitelist group for the instance.

    default
    ModifyMode

    string

    No

    The modification mode of the whitelist. Valid values:

    • 0: overwrites the whitelist group.

    • 1: adds a whitelist group.

    • 2: deletes a whitelist group.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    Id of the request

    9B2F3840-5C98-475C-B269-2D5C3A31797C
    Data

    object

    The data struct.

    DBInstanceId

    integer

    The instance ID.

    pxc-xxxxxxxxxx
    DBInstanceName

    string

    The instance ID.

    pxc-supabase-001
    ContextDBInstanceName

    string

    The context service instance name.

    pxt-*********
    TaskId

    integer

    The task ID.

    ******
    TaskIds

    array

    The list of task IDs in the task group.

    integer

    The list of task IDs in the task group.

    f6f2e335-74b4-47ff-9d63-f9c613f4b524
    AccessDeniedDetail

    object

    The details of the access denial.

    AuthAction

    string

    The authentication action.

    xxx
    AuthPrincipalType

    string

    The identity type used for authentication in the request. Valid values:

    • SubUser: RAM user.

    • AssumedRoleUser: RAM role.

    • Federated: SSO federated identity.

    222
    AuthPrincipalOwnerId

    string

    The ID of the Alibaba Cloud account to which the authentication principal belongs.

    111
    AuthPrincipalDisplayName

    string

    The display name of the authentication principal.

    xxx
    PolicyType

    string

    The policy type.

    System
    NoPermissionType

    string

    The type of the permission denial.

    ImplicitDeny
    EncodedDiagnosticMessage

    string

    The diagnostic information.

    AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

    Examples

    Success response

    JSON format

    {
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "Data": {
    "DBInstanceId": 0,
    "DBInstanceName": "pxc-supabase-001",
    "ContextDBInstanceName": "pxt-*********",
    "TaskId": 0,
    "TaskIds": [
      0
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "System",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.