All Products
Search

This Product

    ApsaraDB RDS:SwitchDBInstanceVpc

    Document Center

    ApsaraDB RDS:SwitchDBInstanceVpc

    Last Updated:May 29, 2023

    Changes the virtual private cloud (VPC) or vSwitch of an instance.

    Operation Description

    The instance must run one of the following database engines:

    • MySQL with local SSDs, standard SSDs, or enhanced ESSDs (ESSDs)
    • SQL Server with standard SSDs or ESSDs
    • MariaDB with standard SSDs or ESSDs
    • PostgreSQL with standard SSDs or ESSDs

    For more information about the impact of VPC and vSwitch changes, see Switch an ApsaraDB RDS for MySQL instance to a new VPC and a new vSwitch.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:SwitchDBInstanceVpcWRITE
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The ID of the instance.

    Note

    • The instance must run one of the following database engines:

      • MySQL with local SSDs, standard SSDs, or ESSDs
      • SQL Server with standard SSDs or ESSDs
      • MariaDB with standard SSDs or ESSDs
      • PostgreSQL with standard SSDs or ESSDs

    • The instance must be in the Running state.

    • The instance must reside in a VPC.

    • The instance cannot be a temporary instance or use an instance type that belongs to the shared instance family.

    		rm-uf6wjk5*****
    VPCIdstringYes

    The ID of the VPC.

    NoteThe VPC must belong to the same region as the instance.
    		vpc-uf6f7l4fg90*****
    VSwitchIdstringYes

    The ID of the vSwitch.

    NoteThe vSwitch must belong to the same zone as the instance.
    		vsw-uf6adz52c2p*****
    PrivateIpAddressstringNo

    The private IP address of the instance. The private IP address must be within the CIDR block of the vSwitch that is specified by the VSwitchId parameter.

    NoteYou can call the DescribeVSwitches operation to query the CIDR block of a specified vSwitch.
    		10.23.XX.XX

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		1AD222E9-E606-4A42-BF6D-8A4442913CEF

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400MigrateAlreadyExistsFaultDuplicate migration is forbidden.The same data cannot be migrated twice.
    400InvalidConnVPCIdSpecified conn vpc id is not valid.The specified VPC ID is invalid.
    400InvalidInstanceKind.NotSupportThe instance kind does not support this operation.The instance type does not support this operation.
    400InvalidPrivateIpAddress.MismatchSpecified private IP address is not in the CIDR block of virtual switch.The VPC endpoint is invalid.
    400MigrateAlreadyReadWriteSplitExistsFaultThe rds instance already has a given vpc migrate task.A task of migrating data to the specified VPC already exists.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2022-06-23API Description Update,The error codes of the API operation change.
    Change itemChange content
    API DescriptionAPI Description Update
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
    2022-06-23The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
    2021-10-28The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change