Download CSV Reports
Details
API Details | Release-Specific Information |
---|
CloudCenter Platform 4x | CloudCenter Suite 5x |
---|
Name | Download CSV Reports
|
Description | Download CSV Reports for Managed and Unmanaged VMs based on specific query parameters |
Allowed Role(s) | WM_USER |
Method | GET |
URI | | 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®ionId=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 Links | CloudCenter Platform 4x API | Workload Manager API |
ESB Header | - action: get. virtualMachines
actionparam: listType=MANAGED_VMS&startDate=startDate&endDate=endDate&size=size - action: get. virtualMachines
actionparam: listType=UNMANAGED_VMS®ionId= 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®ionId=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 Enumeration | Description |
---|
UNMANAGED_VMS | VMs that are already managed by the CloudCenter platform. This list includes CloudCenter deployed VMs and imported VMs. | MANAGED_VMS | Displays VMs that are not yet managed, by the CloudCenter platform. This list includes VMs discovered by the CloudCenter platform. |
|
|
|
Optional – Query Parameters List of Query Parameters | | 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: | | | | | | nameDescription: The name assigned for this CloudCenter Resource. Valid characters are letters, numbers, underscores, and spaces. Type: String
| | 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
|
| | | size=0 must be part of the request to ensure that pagination attributes are not applied to the downloaded file
|
|
Response Attributes
None