Data Center Management

A data center is a facility that shares IT operations and equipment to collect, store, process, and disseminate data and applications in centralized locations. Data centers are an integral part of the enterprise, designed to support business applications and provide services such as data storage, management, backup, and recovery. Hence as part of disaster recovery plan, it is important to deploy multiple data centers in API Gateway.

API Gateway provides the capability to configure data centers, activate data centers in different deployment modes (such as active-active, hot standby, warm, and cold), and switch data centers between different deployment modes.

API Gateway provides the following REST API and the resources to manage the data centers:

PUT/rest/apigateway/dataspace/listener: Configures the GRPC listener in the data center.

GET/rest/apigateway/dataspace/listener: Retrieves the GRPC listener configuration of the associated data center.

PUT/rest/apigateway/dataspace/ring: Configures the data center and establishes the ring configuration with the associated data centers.

GET/rest/apigateway/dataspace/ring: Retrieves the connectivity information of the associated data centers in the ring configuration.

PATCH/rest/apigateway/dataspace/ring: Appends the data center configuration to the ring in API Gateway.

PUT/rest/apigateway/dataspace/configure: Configures multiple data centers and establishes the connection with the associated data centers.

PUT/rest/apigateway/dataspace/activate: Activates a data center configuration in API Gateway.

PUT/rest/apigateway/dataspace/activateAll: Activates multiple data center configuration in API Gateway.

PUT/rest/apigateway/dataspace/activateAll?mode= ACTIVE_RING: Activates all the data centers in the active-active mode in API Gateway.

PUT/rest/apigateway/dataspace/activateAll?mode= STANDBY: Activates all the data centers in the hot standby mode in API Gateway.

PUT/rest/apigateway/dataspace/activateAll?mode= STANDALONE: Switches the data center from the active-active or hot standby mode to stand alone mode in API Gateway.

GET/rest/apigateway/dataspace: Retrieves the current configuration of the associated data center in API Gateway.

For details on the REST API see the swagger file APIGatewayDataManagement.json, located at SAG_Install_Directory/IntegrationServer/instances/instance_name/packages/WmAPIGateway/resources/apigatewayservices.

For details on sample payloads, import Postman collection from the following link in Postman client: https://github.com/SoftwareAG/webmethods-api-gateway/blob/10.11/apigatewayservices/postmancollections/apis/crossdc-management/cross-dc-management-postman-collection.json.

For information on how to implement the data centers set up in API Gateway, see High Availability and Fault Tolerance.