All Products
Search
Document Center

PolarDB:DisableOpenSearchPublicEndpoint

Last Updated:Sep 10, 2026

Disables public network access for PolarDB-X Search.

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

pxc-********

NodeType

string

No

The type of the target node. Valid values:

  • search: data node. This is the default value.

  • dashboard: dashboard node.

search

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

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

Message

string

The error message.

success

AccessDeniedDetail

object

The details about the access denial.

AuthAction

string

The authentication action.

xxx

AuthPrincipalType

string

The type of the authentication principal.

222

AuthPrincipalOwnerId

string

The description is the same as above.

111

AuthPrincipalDisplayName

string

The name of the authentication principal.

xxx

PolicyType

string

PolicyType

PRIORITY

NoPermissionType

string

NoPermissionType

ImplicitDeny

EncodedDiagnosticMessage

string

The diagnostic information.

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "173CA69A-3513-591D-8A09-C1EA37CBE2D9",
  "Message": "success",
  "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.