All Products
Search

This Product

    PolarDB:ManagePrivateRds

    Document Center

    PolarDB:ManagePrivateRds

    Last Updated:Jul 10, 2026

    Calls the ManagePrivateRds operation to manage private custom RDS instances in the storage layer.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    drds:ManagePrivateRds

    *instance

    acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The region ID of the DRDS instance.

    Note

    You can call DescribeDrdsInstances to query the details of all instances in the target account, including the region ID.

    cn-hanzhou
    DrdsInstanceId

    string

    Yes

    The ID of the DRDS instance.

    Note

    You can call DescribeDrdsInstances to query the details of all instances in the target account, including the instance ID.

    drds*************
    DBInstanceId

    string

    Yes

    The ID of the private custom RDS instance in the storage layer.

    Note

    You can call DescribeDrdsRdsInstances to query the details of all private custom RDS instances in the storage layer, including the instance ID.

    rm-***************
    RdsAction

    string

    Yes

    The following management operations are supported for private custom RDS instances:

    • DescribeDBInstanceAttribute: Queries the details of a private custom RDS instance.

    • DescribeAvailableClasses: Queries the available instance types of a private custom RDS instance, including the instance type code and storage capacity.

    • DescribeSQLCollectorPolicy: Queries the SQL Explorer (SQL audit) status of a private custom RDS instance.

    • ModifySQLCollectorPolicy: Enables or disables the SQL Explorer (SQL audit) feature for a private custom RDS instance.

    • DescribeParameters: Queries the current parameter settings of a private custom RDS instance.

    • ModifyParameter: Modifies the parameters of a private custom RDS instance.

    • DescribeDBInstanceHAConfig: Queries the high-availability mode and data replication mode of a private custom RDS instance.

    • SwitchDBInstanceHA: Switches over the primary and secondary instances of a private custom RDS instance.

    SwitchDBInstanceHA
    Params

    string

    No

    A JSON string that contains the request parameters and their values to be forwarded to the private custom RDS API operation. All parameter values must be of the STRING type. Example: {NodeId:"1797****"}.

    For the request parameters and valid values of each private custom RDS API operation, see the request parameters section in the following topics:

    Note

    For the required request parameters of the preceding API operations, you do not need to specify the Action and DBInstanceId parameters. All other required request parameters must be specified.

    {NodeId:"1797****"}

    Response elements

    Element

    Type

    Description

    Example

    object

    Data

    string

    The result set returned by the forwarded private custom RDS API operation.

    {"requestId":"E63C810A-4A13-47B6-BA67-C0E23A******"}
    RequestId

    string

    The request ID.

    0237BCD2-2C7A-4F86-A766-657AF6******
    Success

    boolean

    Indicates whether the request was successful.

    true

    Examples

    Success response

    JSON format

    {
  "Data": "{\"requestId\":\"E63C810A-4A13-47B6-BA67-C0E23A******\"}",
  "RequestId": "0237BCD2-2C7A-4F86-A766-657AF6******",
  "Success": true
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    500 RDSAPI.ERROR Failed to call the RDS API operation.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.