Moving an API Gateway Between Compartments

• Console
• CLI
• API

• 1. On the Gateways list page, find the API gateway that you want to move. If you need help finding the list page or the API gateway, see Listing API Gateways.
  2. From the Actions menu () for the API gateway, select Move Resource, select the compartment to which you want to move the API gateway, and select Move Resource to start the process of moving the API gateway. Note that API deployments on the API gateway are not moved to the new compartment.

     Do not call API deployments while the API gateway on which they are deployed is in the process of being moved to the new compartment.

  3. On the Gateway Details page, select Work Requests from the Resources list and confirm the move operation is complete.

     When the move operation is complete, resume calls to API deployments deployed on the API gateway.

• To move API gateways to a different compartment using the CLI:

  1. Configure your client environment to use the CLI (Configuring Your Client Environment to use the CLI for API Gateway Development).

  2. To move an API gateway to a different compartment:

     1. Open a command prompt and run oci api-gateway gateway change-compartment to move the API gateway:

        Command

        CopyTry It

        oci api-gateway gateway change-compartment --gateway-id <gateway-ocid> --compartment-id <compartment-ocid>

        where:

        • <gateway-ocid> is the OCID of the API gateway to move. To find out the API gateway's OCID, see Listing API Gateways.
        • <compartment-ocid> is the OCID of the compartment to which to move the API gateway.

        For example:

        Command

        CopyTry It

        oci api-gateway gateway change-compartment --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq

        Note that API deployments on the API gateway are not moved.

        The response to the command includes:

        • The lifecycle state (for example, ACTIVE, FAILED).
        • The id of the work request to move the API gateway (details of work requests are available for seven days after completion, cancellation, or failure).

        If you want the command to wait to return control until the API gateway is active (or the request has failed), include either or both the following parameters:

        • --wait-for-state ACTIVE
        • --wait-for-state FAILED

        For example:

        Command

        CopyTry It

        oci api-gateway gateway change-compartment --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq" --wait-for-state ACTIVE

     2. (Optional) To see the status of the work request that is moving the API gateway, enter:

        Command

        CopyTry It

        oci api-gateway work-request get --work-request-id <work-request-ocid>

     3. (Optional) To view the logs of the work request that is moving the API gateway, enter:

        Command

        CopyTry It

        oci api-gateway work-request-log list --work-request-id <work-request-ocid>

     4. (Optional) If the work request that is moving the API gateway fails and you want to review the error logs, enter:

        Command

        CopyTry It

        oci api-gateway work-request-error --work-request-id <work-request-ocid>

     5. (Optional)  To verify that the API gateway has been moved, enter the following command and confirm that the API gateway's new compartment OCID is as you expect:

        Command

        CopyTry It

        oci api-gateway gateway get --gateway-id <gateway-ocid>

  For more information about using the CLI, see Command Line Interface (CLI). For a complete list of flags and options available for CLI commands, see CLI Help.

• Run the ChangeGatewayCompartment operation to move an API gateway to a different compartment.