All Products
Search
Document Center

Migrate API groups between instances

Last Updated: Aug 10, 2021

1. 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 opportunity.

  • Shared instance (VPC): Tenants share the same outbound IP address and bandwidth. Therefore, each tenant is prone to the interference from 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 (RPS) 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 Open API > Groups in the left-side navigation pane. Click the name of the API group that you want to migrate. On the Group Details page, click Modify Instance for API Group Deployment. In the Migrate Instance dialog box, select the destination instance from the Destination Instance drop-down list. Read the usage notes and select I have read the preceding statement and know the potential risks associated with the migration. Then, click Migration. The migration immediately takes effect on the Domain Name System (DNS) of the second-level domains of API Gateway. The migration takes effect on your API group about 1 to 10 minutes later based on the DNS cache.

Migrate an API groupMigrate an API group between instances

Note

If your dedicated instance cannot meet your needs, you can 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."

Note: 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

If you need to migrate an API group for which you have changed the RPS, submit a ticket. Before you migrate an API group, check each of the following technical details about the differences before and after migration.

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

  • 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 whitelist 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 from a shared instance (classic network) to a dedicated instance (VPC)

  • After you migrate an API group to a dedicated instance, the maximum RPS and the HTTPS security policy of the destination dedicated instance apply to the API group.

  • 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 whitelist 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.

  • For example, 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 the backend service to a VPC. In this case, API Gateway temporarily accesses your Function Compute services over the Internet.

  • If the second-level domain name for access over VPCs is enabled for your API group, make sure that a VPC is bound to the destination instance before you migrate your API group. This makes sure that you can access API Gateway from the bound VPC.

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

  • For API Gateway instances of the VPC type, the backend service can use the TLS 1.2 protocol. For API Gateway 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 API Gateway 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.

3.4 Migrate an API group from a shared instance (VPC) to a dedicated instance (VPC)

  • After you migrate an API group to a dedicated instance, the maximum RPS and the HTTPS security policy of the destination dedicated instance apply to the 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 whitelist of IP addresses that are allowed to access the backend service.

  • If specific features are enabled for your API group, make sure that relevant features are enabled for the destination instance before you migrate your API group. Specific features for an API group include the second-level domain name for access over VPCs, the internal domain name for API calls from API Gateway, inbound IPv6 traffic, and outbound IPv6 traffic.

3.5 Migrate an API group from a dedicated instance (VPC) to a dedicated instance (VPC)

  • After you migrate an API group to a dedicated instance, the maximum RPS and the HTTPS security policy of the destination dedicated instance apply to the 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 whitelist of IP addresses that are allowed to access the backend service.

  • If specific features are enabled for your API group, make sure that relevant features are enabled for the destination instance before you migrate your API group. Specific features for an API group include the second-level domain name for access over VPCs, the internal domain name for API calls from API Gateway, inbound IPv6 traffic, and outbound IPv6 traffic.