Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ DB Instance Management/ Changing a Single DB Instance to Primary/Standby DB Instances
Updated on 2026-02-04 GMT+08:00

Changing a Single DB Instance to Primary/Standby DB Instances

Function

This API is used to change a single DB instance to primary/standby DB instances.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:singleToHa

write

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

Constraints

  • Single DB instances with certain specifications cannot be changed to primary/standby DB instances.
  • Single SQL Server DB instances that are billed on the yearly/monthly basis and are created in a DeC cannot be changed to primary/standby DB instances.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/action

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    Constraints

    The value cannot be empty.

    Range

    To obtain the value, see Obtaining a Project ID.

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    The value cannot be empty.

    Range

    You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances.

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

single_to_ha

Yes

Object

Definition

For details, see Table 3.

Constraints

N/A

Table 3 single_to_ha field data structure description

Parameter

Mandatory

Type

Description

az_code_new_node

Yes

String

Definition

Specifies the AZ code of the DB instance node.

Constraints

N/A

Range

N/A

Default Value

N/A

is_auto_pay

No

Boolean

Definition

Specifies whether the order will be automatically paid. This parameter can be specified only when the instance type is changed from single to primary/standby.

Constraints

N/A

Range

  • true: indicates the order will be automatically paid.
  • false (default setting): indicates the order will be manually paid.

Default Value

false

ad_domain_info

No

Object

Definition

Specifies the domain information. For details about the field structure, see Table 4.

Constraints

This parameter is supported only for RDS for SQL Server. It is mandatory when a single-node instance configured with the AD domain is to be changed to a primary/standby instance. It is not required for instances not configured with the AD domain.

Table 4 ADDomainInfo field data structure description

Parameter

Mandatory

Type

Description

domain_admin_account_name

Yes

String

Definition

Name of the domain administrator account.

Constraints

N/A

Range

N/A

Default Value

N/A

domain_admin_pwd

Yes

String

Definition

Password of the domain administrator.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Request

  • Change a pay-per-use RDS for MySQL or RDS for PostgreSQL DB instance from single to primary/standby.
    POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
    
    {
    	"single_to_ha": {
    		"az_code_new_node": "az2xahz"
    	}
    }
  • Change a yearly/monthly RDS for MySQL or RDS for PostgreSQL DB instance from single to primary/standby.
    {
             "single_to_ha": {
                       "az_code_new_node": "az1xahz",
                       "is_auto_pay": true
             }
    }
  • Change a pay-per-use RDS for SQL Server DB instance from single to primary/standby.
    {
        "single_to_ha": {
            "az_code_new_node": "az2xahz",
            "ad_domain_info": {
                "dns_server_ip": "192.168.0.1",
                "domain_admin_account_name": "Administrator",
                "domain_admin_pwd": "password@123",
                "dc_domain_name": "test.com"
            }
        }
    }
  • Change a yearly/monthly RDS for SQL Server DB instance from single to primary/standby
    {
        "single_to_ha": {
            "az_code_new_node": "az2xahz",
            "is_auto_pay": true, 
            "ad_domain_info": {
                "dns_server_ip": "192.168.0.1",
                "domain_admin_account_name": "Administrator",
                "domain_admin_pwd": "password@123",
                "dc_domain_name": "test.com"
            }
        }
    }

Response

  • Pay-per-use DB instances
    • Normal response
      Table 5 Parameters

      Parameter

      Type

      Description

      job_id

      String

      Definition

      Task ID.

      Range

      N/A

    • Example normal response
      {
      	"job_id": "2b414788a6004883a02390e2eb0ea227"
      }
    • Abnormal response

      For details, see Abnormal Request Results.

  • Yearly/Monthly DB instances
    • Normal response
      Table 6 Parameters

      Parameter

      Type

      Description

      order_id

      String

      Definition

      Order ID.

      Range

      N/A

    • Example normal response
      {
      	"order_id": "CS2009151216NO2U2"
      }
    • Abnormal response

      For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.