Addressing stability issues caused by the API Portal Integration Service (portalman) for version 3.0 of the API Developer Portal

Products

• CA API Developer Portal
• CA API Gateway

Issue/Introduction

Background

A CA API Gateway may experience stability and availability issues when the default API Portal Integration Service (or "portalman") is published. An administrator or operator may observe increasingly frequent garbage collection and increases in the amount of used heap space.

Impacted Products

Any version of the API Gateway that can interoperate with version 3.0 of the API Developer Portal may be subjected to this issue if the API Portal Integration Service is published. The following article will describe the Gateway versions that are compatible with the appropriate version of the API Developer Portal: API Gateway: Compatibility with the API Developer Portal and Mobile API Gateway

Resolution

This issue is resolved with an updated service policy. Download the service policy document (portalman-fix-v3.0.xml) attached to this article and execute the following procedure:

1. Login to the Policy Manager as an administrative user
2. Open the API Portal Integration Service [/portalman/*] service
3. Click Import Policy
4. Select the downloaded policy document
5. Click Save and Activate

Verification

The following procedure should succeed if the policy is replaced correctly.

1. Log in to the administrative content management system (CMS).

Note: The CMS is accessed via https://gateway.domain.com/admin where "gateway.domain.com" is the fully qualified domain name of the API Developer Portal appliance

2. Select Plugin Management.
3. Select Layer 7 Gateway.
4. Select Sync API Plans.
5. Ensure an HTTP 200 is received.

Environment

Release:
Component: APIPRD