Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Restricted to 4.x per CCSWM-5544

List VMs

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameList VMs
Description

Displays configured information for all VMsor for the specified VM – you can view a list by specifying any attribute used to Create Tenant

Allowed Role(s)WM_USER
MethodGET
URI
  • v1/tenants/tenantId/vms?regionName=regionName&depEnvId=depEnvId&ccmOnly=true
  • v1/tenants/tenantId/vms?regionName=regionName&depEnvId=depEnvId&nonCcmOnly=true

  • cloudcenter-ccm-backend/api/v1/tenants/tenantId/vms?regionName=regionName&depEnvId=depEnvId&ccmOnly=true
  • cloudcenter-ccm-backend/api/v1/tenants/tenantId/vms?regionName=regionName&depEnvId=depEnvId&nonCcmOnly=true

Sample Request
Code Block
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/vms?depEnvId=1&regionName=Amazon-us-west-2&ccmOnly=true&page=0&size=30&sort=id"
Code Block
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/tenants/1/vms?depEnvId=1&regionName=Amazon-us-west-2&ccmOnly=true&page=0&size=30&sort=id"l -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/tenants/1/images"
Release
  • Introduced in CloudCenter 4.0
  • Updated in CloudCenter 4.6.1 to include vmOperationData

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 response includes information for the specified tenantId only.
  • Use the View Deployment Environments to retrieve the depEnvId.
  • You can display information for VMs in a specific tenant by including the regionName, depEnvId, and type of deployment environment (ccmOnly or nonCcmOnly) query parameters with this API.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

  • action: get.tenants.tenantId.vms
    actionparam: regionName=regionName&depEnvId=depEnvId&ccmOnly=true
  • action: get.tenants.tenantId.vms
    actionparam: regionName=regionName&depEnvId=depEnvId&nonCcmOnly=true

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

Not applicable

Sample Response: Managed VMs 

...

Terms & Conditions Privacy Statement Cookies Trademarks