Help Center/ ROMA Connect/ User Guide (ME-Abu Dhabi Region)/ Asset Management/ Restoring/Migrating Integration Assets/ Modifying API Configurations
Updated on 2022-12-05 GMT+08:00
View PDF
Share

Modifying API Configurations

Overview

The environment information, control policy information, secret information, blacklist and whitelist for API authorization, and APIs that are not published in the RELEASE environment are not asset data. You need to reconfigure this information after importing integration assets.

  • Environment information includes the independent domain names, environment variables, cloud server information of load balance channels, and non-default environments.
  • Control policy information includes request throttling policies, access control policies, client access control policies, and client quota policies.
  • Secret information includes clients' AppCodes and custom backends' configurations of the password or certificate type.

Prerequisites

You have imported integration assets. For details, see Importing Integration Assets.

Configuring Environment Information

  1. Bind an independent domain name.
    1. Log in to the ROMA Connect console, choose API Connect > API Management, and click the API Groups tab.
    2. Choose More > Manage Domain Name on the right of the target API group.
    3. On the Domain Names tab page, click Bind Independent Domain Name to bind an independent domain name to the API group.

      For details about the parameters, see Binding Domain Names.

    4. Click OK.
  2. Create an environment.
    1. On the API Management page, click the Environments tab.
    2. Click Create and create an environment for publishing APIs.
    3. Click OK.
  3. Add environment variables.
    1. On the API Management page, click the API Groups tab.
    2. Choose More > Manage Variable on the right of the target API group.
    3. Select the environment to which you want to add an environment variable and click Create Variable.

      For details about the parameters, see Creating an Environment Variable.

    4. Click OK.
  4. Modify a load balance channel member.
    1. On the API Management page, click the Load Balance Channels tab.
    2. Click Edit on the right of the target load balance channel.
    3. On the Edit Load Balance Channel page, click Next.
      • For a load balance channel whose Member Type is Instance, click Select ECS to add load balance channel members.
      • For a load balance channel whose Member Type is IP address, change the backend service address based on the backend server in use.

      For details about the parameters, see (Optional) Creating a Load Balance Channel.

    4. After the configuration is complete, click Finish.

Configuring Control Policy Information

  1. Configure a request throttling policy.
    1. On the API Management page, click the Request Throttling Policies tab.
    2. Click Create and add a request throttling policy.

      For details about the parameters, see Creating a Request Throttling Policy.

    3. Click OK.
    4. Bind the request throttling policy to the API, application, or tenant by following the procedure described in Configuring a Request Throttling Policy.
  2. Configure an access control policy.
    1. On the API Management page, click the Access Control Policies tab.
    2. Click Create and add an access control policy.

      For details about the parameters, see Creating an Access Control Policy.

    3. Click OK.
    4. Bind an access control policy to the API by following the procedure described in Configuring an Access Control Policy.
  3. Configure an access control policy for a client.
    1. On the API Calling page, click the Clients tab.
    2. Click Set Access Control on the right of the target client and set the access control policy for the client.

      For details about the parameters, see Configuring an Access Control Policy.

    3. Click OK.
  4. Configure a quota policy for a client.
    1. On the API Calling page, click the Client Quota Policies tab.
    2. Click Create and add a client quota policy.

      For details about the parameters, see Creating a Client Quota Policy.

    3. Click OK.
    4. Bind the quota policy to a client by following the procedure described in Configuring a Client Quota Policy.

Configuring Secret Information

  1. Add an AppCode for a client.
    1. On the API Calling page, click the Clients tab.
    2. Click the client name to access the client details page.
    3. On the AppCode tab page, click Add AppCode to add an AppCode for the client.
    4. Click OK.
  2. Add the configurations of the password or certificate type for custom backends.
    1. On the Custom Backend page, click the Configurations tab.
    2. Click Edit on the right of the target configuration.
      • For configuration of the password type, change the password.
      • For configuration of the certificate type, modify the certificate content and password.
    3. Click OK.

Modifying Blacklist and Whitelist Configurations of API Authorization

Only APIs that are accessed using App authentication support authorization configuration.

  1. On the API Management page, click the APIs tab.
  2. Click the name of the target API to access the API details page.
  3. On the Authorization tab page, choose More > Edit Green Channel on the right of the authorized integration application and modify the blacklist and whitelist configurations as required.
  4. Click OK.

Creating an API and Publishing It in a Non-RELEASE Environment

  1. On the API Management page, click the APIs tab.
  2. Click Create API and create an API as required.

    For details about the parameters, see Creating an API.

  3. Publish the API to a non-RELEASE environment by following the procedure described in Publishing an API.