All Products
Search
Document Center

Migrate API groups between instances

Last Updated: Jan 11, 2021

1 Application scenarios of different instances

  • Shared instance (classic network): This is an earlier instance type that is offered by API Gateway and provides limited features. Shared instances (classic network) are no longer maintained, and new features are unavailable for the instances of this type. We recommend that you migrate your data to shared instances (VPC) or dedicated instances (VPC) at the earliest possible opportunity.

  • Shared instance (VPC): Tenants share the same outbound IP address and bandwidth. Therefore, each tenant is easily affected by other tenants. This instance type is more suitable for development testing, evaluation, and small-scale production.

  • Dedicated instance (VPC): To obtain a higher-level guarantee in the service-level agreement (SLA), you can purchase a higher specification for requests per second (RPC) to use dedicated resources. The resources include inbound public IP addresses, IP addresses for virtual private clouds (VPCs), outbound Internet bandwidth, and isolated server clusters.

2 Migration procedure

Log on to the API Gateway console and choose API Groups > Group Details. On the Group Details page, click Modify API Group's Instance. Then, select the instance that you want to migrate the API group to. Carefully read the precautions and notes. Then, click Confirm Migration to complete migration. The migration immediately takes effect on the DNS of the second-level domains of API Gateway. The migration takes effect on your API groups about 1 to 10 minutes later based on the DNS cache.

Migrate API groupsMigrate API groups between instances

Note

If your dedicated instance cannot meet your needs, you must migrate the API groups in the dedicated instance to a dedicated instance of higher specifications. Perform the following steps for migration:

1. Purchase a dedicated instance of the required specifications.

2. Migrate your API groups to the new instance by following the steps in "2 Migration procedure."

Notes: Due to the DNS cache, some requests are sent to the previous instance after the migration. Make sure that all requests are forwarded to the new instance before you release the previous instance.

3 Migration notes

3.1 Migrate an API group to a shared instance (VPC)

If you need to migrate an API group for which you have changed the RPS, submit a ticket.

Before you migrate a group from a shared instance (classic network) to a shared instance (VPC), check each of the following technical details about the differences before and after migration:

  • API Gateway instances of the VPC type do not support backend service addresses of the classic network type.

  • The outbound IP address of an API Gateway instance may change. You can go to the Instances page to view the outbound IP address. Make sure that the outbound IP address of the API Gateway instance is included in the list of IP addresses that are allowed to access the backend service.

  • An API Gateway instance of the VPC type does not provide a preconfigured `crossdomain.xml` file. If you need to use the file, configure an API in mock mode.

  • The throttling, IP access control, and backend signature policies that have been configured are still valid. After the plug-ins for the same policies are used, the previously configured policies become invalid.

  • The APIs for which you have configured the OpenID Connect access policy are still valid. After the JwtAuth plug-in is used, the original configurations for the APIs become invalid.

3.2 Migrate an API group to a dedicated instance (VPC)

After a group is migrated from a shared instance (VPC) to a dedicated instance, the HTTPS security policy and the RPS upper limit of the dedicated instance apply to the group. Before you migrate a group from a shared instance (classic network) to a dedicated instance (VPC), check each of the following technical details about the differences before and after migration:

  • API Gateway instances of the VPC type do not support backend service addresses of the classic network type. If your backend service address is of the classic network type, API operations cannot be called after you migrate your API group. Change the backend configuration by using the method of VPC access authorization before you migrate your API group.

  • The outbound IP address of an API Gateway instance may change. You can go to the Instances page to view the outbound IP address. Make sure that the outbound IP address of the API Gateway instance is included in the list of IP addresses that are allowed to access the backend service.

  • An API Gateway instance of the VPC type does not provide a preconfigured `crossdomain.xml` file. If you need to use the file, configure an API in mock mode.

  • The throttling, IP access control, and backend signature policies that have been configured are still valid. After the plug-ins for the same policies are used, the previously configured policies become invalid.

  • The APIs for which you have configured the OpenID Connect access policy are still valid. After the JwtAuth plug-in is used, the original configurations for the APIs become invalid.

  • Assume that you use Function Compute as a backend service that is deployed in the China (Beijing), China (Shanghai), China (Hangzhou), or China (Shenzhen) region and you have not migrated Function Compute to a VPC. In this case, API Gateway temporarily accesses your Function Compute services over the Internet.

3.3 Migrate an API group back to a shared instance (classic network)

You can migrate an API group back to an instance of the classic network type. Before the migration, check each of the following technical details about the differences before and after migration:

  • For instances of the VPC type, the backend service can use the TLS 1.2 protocol. For instances of the classic network type, the backend service can use only the TLS 1.0 protocol.

  • All plug-in configurations become invalid. The throttling, IP access control, and backend signature policies for instances of the classic network type must be reconfigured.

  • The outbound IP address of an API Gateway instance may change. You can go to the Instances page to view the outbound IP address. Make sure that the outbound IP address of the API Gateway instance is included in the whitelist of IP addresses that are allowed to access the backend service.

  • Some new features may not be supported. Pay attention to the prompts that are displayed in the API Gateway console.