All Products
Search
Document Center

PolarDB:ScaleInOpenSearch

Last Updated:Sep 10, 2026

Scales in nodes of a PolarDB-X Search cluster.

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 ID.

cn-hangzhou

DBInstanceName

string

Yes

The name of the instance.

pxc-spsil01pww4hfz

SearchNodeCount

string

Yes

The total number of data nodes after the scale-in. The value must be a positive integer and less than the current number of data nodes.

2

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEF

OrderId

string

The order ID.

20211103105558

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 encrypted complete diagnostic message.

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "OrderId": "20211103105558",
  "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.