All Products
Search
Document Center

PolarDB:CreateOpenSearchAccount

Last Updated:Sep 10, 2026

Creates an account for a PolarDB-X Search instance.

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-********

AccountName

string

Yes

The name of the account to be created.

account_sec

AccountPassword

string

Yes

The password of the account. The password must be 6 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$&%^*()_+-=).

*****

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

9B2F3840-****-475C-B269-2D5C3A31797C

Data

object

The details of the returned policy.

AccountName

string

The account name.

polardbx_meta_ro

TaskId

integer

The task ID.

2209883

AccessDeniedDetail

object

The details of the access denial.

AuthAction

string

The description is as above.

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": "9B2F3840-****-475C-B269-2D5C3A31797C",
  "Data": {
    "AccountName": "polardbx_meta_ro",
    "TaskId": 2209883
  },
  "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.