CliQr is now part of Cisco Learn More About Cisco

Download Logs

Details

API Details
NameDownload Logs
Description

Download logs for the CCO or CCM components. See Download Log File  for additional context.

MethodGET
URI
  • v1/downloadLogs?componentType=CCM (CCM)
  • v1/downloadLogs?componentType=CCO&regionId=CCORegionId  (CCO)
CloudCenter ReleaseIntroduced in CloudCenter 4.7.0.
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • Users with the following permissions can download log files:

    ServerAPI Permissions
    CCMOnly root admin
    CCOAny tenant admin with the following permissions:
    • Has access to the cloud region
    • Has a user cloud account configured on the CCO
ESB Header
  • action (CCM): get.downloadLogs
    actionparam:
    componentType=CCM 
  • action (CCO): get.logs
    actionparam:
    componentType=CCO&regionId=CCORegionId

Example 1 – CCM

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/ v1/downloadLogs?componentType=CCM" 

Response

When you issue this API request, you receive a browser popup requesting permission to open the downloaded file. The content of the downloaded CCM file is similar to the following example.

Example 2 – CCO

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/ v1/downloadLogs?componentType=CCO&regionId=1" 

Response

When you issue this API request, you receive a browser popup requesting permission to open the downloaded file. The content of the downloaded CCO file is similar to the following example.

Request Attributes

componentType
  • Description: A string that identifies the component server for the log file download.
  • Type: Enumeration

    EnumerationDescription
    CCMThe CCM component
    CCOThe CCO component

regionId
  • DescriptionUnique, system-generated identifier for the cloud region 
  • Type: String

The region identifier for the CCO

Response Attributes

None

 

  • No labels