All Products
Search

This Product

    PolarDB:DescribeOpenSearchAccountInfo

    Document Center

    PolarDB:DescribeOpenSearchAccountInfo

    Last Updated:Sep 10, 2026

    Queries the account information of 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 ID.

    cn-hangzhou
    DBInstanceName

    string

    Yes

    The instance ID.

    pxc-xxx

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    Id of the request

    A501A191-BD70-5E50-98A9-C2A486A82****
    Data

    object

    The data struct.

    PasswordLastModified

    string

    The time when the password was last modified.

    2026-08-21T12:00:00Z
    Username

    string

    The account name of the OpenSearch instance.

    elastic
    Accounts

    array<object>

    The list of accounts.

    object

    The list of accounts.

    Username

    string

    The account name of the OpenSearch instance.

    elastic
    AccountType

    string

    The account type.

    • Before three-role mode is enabled: 0 indicates a standard account, and 1 indicates a privileged account.

    • After three-role mode is enabled: 0 indicates a standard account, 2 indicates a system administrator account, 3 indicates a security administrator account, and 4 indicates an audit administrator account.

    2,3,4
    AccountStatus

    string

    The account status. Valid values:

    • Creating: The account is being created.

    • Available: The account is available.

    • Deleting: The account is being deleted.

    1
    AccessDeniedDetail

    object

    The details of the access denial.

    AuthAction

    string

    The authentication action.

    xxx
    AuthPrincipalType

    string

    The authentication principal type.

    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 diagnostic information.

    AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

    Examples

    Success response

    JSON format

    {
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "Data": {
    "PasswordLastModified": "2026-08-21T12:00:00Z",
    "Username": "elastic",
    "Accounts": [
      {
        "Username": "elastic",
        "AccountType": "2,3,4",
        "AccountStatus": "1"
      }
    ]
  },
  "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.