Download CSV Reports

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameDownload CSV Reports
Description

Download CSV Reports for Managed and Unmanaged VMs based on specific query parameters

Allowed Role(s)WM_USER
MethodGET
URI

  • v1/virtualMachines.csv?listType=MANAGED_VMS&startDate=startDate&endDate=endDate&size=size

  • v1/virtualMachines?listType=UNMANAGED_VMS&regionId=regionId&cloudAccountId=cloudAccountId

  • cloudcenter-ccm-backend/api/v1/virtualMachines.csv?listType=MANAGED_VMS&startDate=startDate&endDate=endDate&size=size

  • cloudcenter-ccm-backend/api/v1/virtualMachines?listType=UNMANAGED_VMS&regionId=regionId&cloudAccountId=cloudAccountId

Sample Request
curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/virtualMachines.csv?listType=MANAGED_VMS&startDate=1452462753191&endDate=1483998753191&size=0"
curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/virtualMachines.csv?listType=MANAGED_VMS&startDate=1452462753191&endDate=1483998753191&size=0"
Release

Introduced in CloudCenter 4.8.0

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
  • The cloudAccount must be owned by the user issuing the API call – be aware that ACL-shared cloud accounts result in a validation error.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

  • action: get. virtualMachines
    actionparam: listType=MANAGED_VMS&startDate=startDate&endDate=endDate&size=size
  • action: get. virtualMachines
    actionparam: listType=UNMANAGED_VMS&regionId= regionId&cloudAccountId=cloudAccountId

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Download Managed Reports

curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/virtualMachines.csv?listType=UNMANAGED_VMS&regionId=1&cloudAccountId=1"

Response

The CSV file (default = Excel format) is available for download.

Request Attributes

listType
  • Description: Identifies the Virtual Machine type so the CloudCenter platform can process the request accordingly. See VM Management for additional details.

  • Type: Enumeration

    EnumerationDescription
    UNMANAGED_VMSVMs that are already managed by the CloudCenter platform. This list includes CloudCenter deployed VMs and imported VMs.
    MANAGED_VMSDisplays VMs that are not yet managed, by the CloudCenter platform. This list includes VMs discovered by the CloudCenter platform.

regionId

  • Description: Unique, system-generated identifier for the cloud region 

  • Type: String

cloudAccountId

  • Description: Unique, system-generated identifier for the cloudAccount

  • Type: String

Optional – Query Parameters
 List of Query Parameters
page

  • Description: The total number of pages in for the API listing.

    • Default = 0

    • If size=0, then the page value is ignored.

    • If not specified (page=0&size=20), the default size (default = 20) value displays the first 20 elements, which is equal to one page

    • If you specify both the page and the size values, the following applies:

      If you specify......then
      size=21Elements numbered 21 - 40 entities are displayed, which is equal to 2 pages
      page=0
      (or not specified)      		The first set of 20 elements in the list, elements 1 to 20 are displayed
      page=1The second set of 20 elements in the list, elements 21 to 40 are displayed
      page=2

      The third set of 20 elements in the list (the third page).

      if the page does not have more than 10 elements, then only those 10 elements are displayed.

      page=1&&size=10A set of 10 elements, Elements 11 to 20 are displayed
      page=1&&size=20A set of 20 elements, Elements 21 to 40 are displayed
      page=2&&size=10A set of 10 elements, Elements 21 to 30 are displayed
  • Type: Integer
size

  • Description: Total number of records that any list page should contain. The default is: 

    • v1 APIs = 20 records

    • v2 APIs:

      • Prior to 4.8.0: All elements are returned and the page value is ignored.

      • Effective 4.8.0: 50 records
  • Type: Integer
 sort

sort
  • Description: Sorts API responses based on the format specified.
  • Type: String
    • Sorting order:
      • Ascending order = ASC
      • Descending order = DESC
    • Default: Sort criteria is based on startTime and DESC order.
    • Format: sort=[attribute, order]
    • Example: [endTime,ASC]

    • Sorting attributes:

      id

      • Description: Unique, system-generated identifier for this CloudCenter Resource.

      • Type: String
      status

      • Description: Status of the operation. See the Deployment and VM States section for the relevant release to view a list of all job operations.

      • Type: Enumeration

        EnumerationDescription
        SUBMITTEDThe operation has been submitted
        RUNNINGThe operation is currently in progress
        SUCCESSThe operation succeeded
        FAILThe operation failed
      startTime
      endTime
      totalCost

      • Description: Identifies the total cost per hour of the job for billing purposes. See the CloudCenter Cost and Fees section for the relevant release to view additional details.

      • Type: Float

      nodeHours

      • Description: The number of VM hours for this resource. See the Financial Overview section for the relevant release to view additional details.

      • Type: Float

      name

      • Description: The name assigned for this CloudCenter Resource. Valid characters are letters, numbers, underscores, and spaces.

      • Type: String

      deploymentEntity.name

      • Description: Identifies evolving resource details about the deployment. The deploymentEntity attribute uses the deploymentEntity.name format, where .name is search value for deploymentEntity and deploymentEntity itself is a JSON object.

        Instead of placing the deployment name at the top level search and adding numerous query parameters, this format allows for nested search results. The top level name is the job name and deploymentEntity.name is the deployment name.

      • Type: JSON objects

        type
        • Description: The type of resource
        • Type: String

        id

        • Description: Unique, system-generated identifier for this CloudCenter Resource.

        • Type: String

        The ID for the job or deployment

        name

        • Description: The name assigned for this CloudCenter Resource. Valid characters are letters, numbers, underscores, and spaces.

        • Type: String

        The name for the job or deployment

        attributes
        • Description: Identifies attribute details for the deployment entity.

        • Type: Sequence of related information about the resource – these details differ based on the resource being deployed.

      favoriteCreationTime
      • Description: If the job was configured as a favorite job, then this attribute identifies the time when this configuration took place. See the Favorite Deployments section for the relevant release for additional context.
      • Type: Epoch time as a String

startDate
endDate

size=0 must be part of the request to ensure that pagination attributes are not applied to the downloaded file

size

  • Description: Total number of records that any list page should contain. The default is: 

    • v1 APIs = 20 records

    • v2 APIs:

      • Prior to 4.8.0: All elements are returned and the page value is ignored.

      • Effective 4.8.0: 50 records
  • Type: Integer

 

Response Attributes

None


  • No labels
© 2017-2019 Cisco Systems, Inc. All rights reserved