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 2024-08-28 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.

  • Before calling an API, you need to understand the API in Authentication.

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 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

single_to_ha

Yes

Object

For details, see Table 3.

Table 3 single_to_ha field data structure description

Name

Mandatory

Type

Description

az_code_new_node

Yes

String

Specifies the AZ code of the DB instance node.

is_auto_pay

No

Boolean

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.

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

ad_domain_info

No

Object

Specifies AD domain information. This parameter is mandatory only when a single instance configured with the AD domain is to be changed to a primary/standby instance.

This parameter is available only for RDS for SQL Server.

For details about the field structure, see Table 4.

Table 4 ADDomainInfo field data structure description

Name

Mandatory

Type

Description

domain_admin_account_name

Yes

String

Name of the domain administrator account.

domain_admin_pwd

Yes

String

Password of the domain administrator.

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 Parameter description

      Name

      Type

      Description

      job_id

      String

      Task ID.

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

      For details, see Abnormal Request Results.

  • Yearly/Monthly DB instances
    • Normal response
      Table 6 Parameter description

      Name

      Type

      Description

      order_id

      String

      Indicates the order ID.

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

      For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.