---
sourceDocument: Yokohama IT Operations Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/yokohama/it-operations-management

 Release :

    - yokohama

ft:locale :

    - en-US

ft:publication_title :

    - Yokohama IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# The Cloud API Trail

# The Cloud API Trail {#ariaid-title1}

* Release version: Yokohama
* 
* Updated January 30, 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read

The Cloud API Trail is an activity log for all activity that uses the Cloud API and goes
through the MID Server.

## Cloud API Trail contents

Figure 1. CAPI trail form {#cloud-api-trail__table_ibs_2x5_gz__entry__2}

| Field | Description |
|-|-|
| Dynamic route ID | An auto-generated ID number for the entry. |
| Mid name | The name of the MID Server through which the Discovery was performed. |
| Route status | Whether or not the Discovery operation run by the API was successful. Possible values are: * success * error * executing {#cloud-api-trail__ul_nft_2y5_gz} |
| Input parameters | The input parameter that generated the API trail record. This value is usually the datacenter in which the Discovery was run. |
| Interface name |   |
| Invoked by | This value is always CMP when running Discovery. |
| Method name | The interface operation from the Cloud API that processed this record. |
| Provider name | The cloud provider. |
| Version | The version specified in the Cloud API. |
[ ]

{#cloud-api-trail__table_ibs_2x5_gz}

## CAPI Trail Logs

The CAPI Trail Logs related list provides more details about Cloud API trail entry. The
following types of log keys are available:  
{#cloud-api-trail__table_wxx_bgv_gz__entry__2}

| Log key | Description |
|-|-|
| route_data | Information about the Cloud API calls. |
| dynamic_route | Information about the actual route the data took, including URIs. |
| route_result | The payload received by the instance, or a description of the result of the data transfer. The payload |
| chunk_number | The number of data chunks that the instance received. |
| route_status | Whether the route connection and payload transfer was successful. |
| route_error | The error that occurred. For example, the error `Failed to list loadbalancer Failed : HTTP error code : 403` means that your credentials were incorrect and Discovery could not access the cloud resource. |
| error_detail | More details about the error, including the Cloud Provisioning and Governance API and connector that was used in the attempted Discovery, and the errors that the cloud provider threw. |
[ ]

{#cloud-api-trail__table_wxx_bgv_gz}  
An example of a route_error is as follows:

    Failed to list loadbalancer Failed : HTTP error code : 403

An example of the error_detail entry for the same error is as follows:  

    com.snc.cmp.connector.cloud.loadbalancer.component.LoadBalancerException: Failed to list loadbalancer Failed : HTTP error code : 403
           at com.snc.cmp.connector.cloud.loadbalancer.customizer.impl.AWSLoadBalancerCustomizer.listLoadBalancers(AWSLoadBalancerCustomizer.java:56)
    	at com.snc.cmp.connector.cloud.loadbalancer.component.LoadBalancerProducer.process(LoadBalancerProducer.java:46)
    	at org.apache.camel.util.AsyncProcessorConverterHelper$ProcessorToAsyncProcessorBridge.process(AsyncProcessorConverterHelper.java:61)
           at org.apache.camel.processor.SendProcessor.process(SendProcessor.java:145)
           ...

These two entries indicate that the credentials were incorrect, and Discovery could not access
the cloud resource. The load balancer interface throws the first error because the load balancer
device is the first device that allows access to the cloud resource. The
`org.apache.camel` errors indicated routing errors on the Amazon Web Services
side.

The corresponding error on the instance side is captured in the Cloud Orchestration Trail.
**Related concepts**   

* [The Cloud Orchestration Trail](https://servicenow-prod.fluidtopics.net/Pv2euABZyLwAxQ9l_vDM8w "The Cloud Orchestration Trail is an activity log for all cloud resource activity on the instance.")

## Open the Cloud API Trail {#ariaid-title2}

Open the Cloud API Trail to debug and troubleshoot issues like a failed policy or failed Discovery of cloud resources.

### Before you begin

Role required: sn_cmp.cloud_operator or sn_cmp.cloud_admin

### Procedure

1. In the Cloud Admin Portal, navigate to OperateTrails.
2. On the Cloud Api Trail tab, filter and sort the list of Cloud API Trail records as needed.  
   If you are looking for something like a failed Discovery, filter the list so the Route Status column shows only entries with error.
3. Click a link in the Created column to open the Cloud API Trail record.
4. In the CAPI Trail Logs related list, open the log record that displays the information you want.  
   For example, open route_error or error_detail to debug a failed operation.

*[\>]: and then