All Products
Search
Document Center

PolarDB:DescribeContext0SecurityIps

Last Updated:Sep 10, 2026

Queries the whitelist of the context service.

Operation description

Note
  • The SQL audit and analysis feature of PolarDB-X 2.0 is free of charge. However, Simple Log Service charges fees for storage space, read traffic, number of requests, data transformation, and data shipping. For more information about the SQL audit feature, see Enable SQL audit and analysis.

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 name of the instance.

pxc-**************

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

173CA69A-3513-591D-8A09-C1EA37CBE2D9

Data

object

The monitoring data.

DBInstanceName

string

The name of the instance.

pxc-*********

GroupItems

array<object>

The list of whitelist groups.

object

The list of whitelist groups.

GroupName

string

The name of the whitelist group.

defaultGroup

SecurityIPList

string

The details of the whitelist group.

127.0.0.1,172.168.0.0

GroupTag

string

The tag of the group.

group1

Context0InstanceName

string

The name of the context service instance.

context0-example

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": "173CA69A-3513-591D-8A09-C1EA37CBE2D9",
  "Data": {
    "DBInstanceName": "pxc-*********",
    "GroupItems": [
      {
        "GroupName": "defaultGroup",
        "SecurityIPList": "127.0.0.1,172.168.0.0",
        "GroupTag": "group1"
      }
    ],
    "Context0InstanceName": "context0-example"
  },
  "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.