Troubleshoot API Deployments

This article describes how to troubleshoot the issues.
apip43
This article describes how to troubleshoot the following issues:
Portal Deployer is Not Receiving Deployment Events (On-Demand Deployments)
Symptoms
For on-demand deployments, the deployment is stuck in a 
Pending Deployment
 state or pending 
Undeployment
 state that does not resolve itself.
Solution
  • Restart the log by toggling the 
    portal.deployer.enabled
     cluster property to 
    true
     in the 
    Policy Manager
    .
  • View the Gateway logs from within the Policy Manager or from the filesystem from the Gateway node log (
    /opt/SecureSpan/Gateway/node/default/var/logs/ssg_X_0.log
    ).
    See "View Logs for the Gateway" in the Gateway documentation.
  • To get the API out of its Pending Deployment state, redeploy the API by making the redeploy API call.
Error When Deploying an API
 
Symptoms
 
The API Details page displays an error for an API deployment.
 
Solution
 
View the details of an error by clicking the red icon of error status.
The following graphic displays an on-demand deployment that contains an error status:
Screen capture of on-demand deployment error status  
The following graphic displays the details of an example error message:
Screen capture of error message
Failed Connecting to Broker Error (On-Demand Deployments)
Symptoms
For on-demand deployments, the deployment is stuck in a 
Pending Deployment
 state. Gateway logs display a 
Could not connect to the message broker - check your DNS configurations
 error.
Solution
  • Ensure that DNS is configured correctly. See Configure Your DNS Server, paying particular attention to the Edit Hosts File for Local Access section in step 3. Ensure that broker.mycompany.com is added to the 
    /etc/hosts
     file.
  •  To get the API out of its Pending Deployment state, you need to redeploy the API by making the redeploy API call.
Service Cannot be Found Error
Symptoms
In on-demand deployments, The 
API Details
 page displays an error for an API deployment. When the user selects the Error link, the message contains a reference to Service Not Found.
Solution
Ensure that RESTMAN is installed on the Gateway. See Rest Management API section in CA API Gateway documentation.