View Unmanaged VM Inventory Report (Deprecated)

Details

API	Details
Name	View Unmanaged VM Inventory Report
Description	Displays the Unmanaged VM Inventory report for all cloud regions and accounts my tenant or for a specific sub-tenant.
Method	GET
URI	v2/tenants/tenantId/reports?reportType=reportType&startDate=start_date&endDate=end_date &cloudAccountId= cloudAccountId&regionId=regionId&page=page&size=size
CloudCenter Release	Introduced in CloudCenter 4.6 Deprecated in CloudCenter 4.8.0. Use the View Managed and Unmanaged VMs API instead.
Notes	General Notes: For additional context on <PORT> usage in the following example(s), see Base URI Format. The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview > Pagination section for additional context. API Notes: Default response: My tenant. This API supports the CSV format for the response. See Response Schema > CSV (Only for Reports). Access Control: This API is only available to admin users. Admin users can access data to their unmanaged cloud accounts or regions by changing the cloudAccountId or regionId path attribute in the request as displayed in the examples below.
ESB Header	action: get.tenants.tenantId.reports actionparam: reportType=reportType&startDate=start_date&endDate=end_date& cloudAccountId= cloudAccountId&regionId=regionId&page=page&size=size

Example 1 – My Tenant (Default)

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/tenants/1/reports?reportType= UNMANAGED_VM_INVENTORY_REPORT&startDate=1467488819620&endDate=1470080819621&page=0&size=50

Response

{
    "summary": {
        "totalNumberOfVMs": 8,
        "totalNumberOfRunningVMs": 8
    },
    "details": [{
        "nodeId": "412caa93-38e6-4ad1-8627-6ca1d60a02ed",
        "nodeStatus": "Running",
        "hostName": "cco",
        "publicIpAddress": "10.110.12.218",
        "privateIpAddress": "10.0.0.33 "
    }, {
        "nodeId ": "d3cdc409 - 6 a93 - 424e-905 c - 15506 a9194b6 ",
        "nodeStatus ": "Running ",
        "hostName ": "ccm1 ",
        "publicIpAddress ": "10.110.13.18",
        "privateIpAddress": "10.0.0.27"
    }, {
        "nodeId": "d1c6def0-5db9-4a5b-8634-7b94c0b02023",
        "nodeStatus": "Running",
        "hostName": "ccm46",
        "publicIpAddress": "10.110.13.170",
        "privateIpAddress": "10.0.0.24"
    }, {
        "nodeId": "b871ec1d-4959-4c1a-bbb9-e89593de26d9",
        "nodeStatus": "Running",
        "hostName": "chef",
        "publicIpAddress": "10.110 .13 .12 ",
        "privateIpAddress ": "10.0 .0 .21 "
    }, {
        "nodeId ": "4 cb3a0fc - efd8 - 4 b12 - b44e - 1 b954aec27e9 ",
        "nodeStatus ": "Running",
        "hostName": "dokku",
        "publicIpAddress": null,
        "privateIpAddress": "10.0.0.19"
    }, {
        "nodeId": "0894a243-5dd4-475d-9710-acdfac81cdd9",
        "nodeStatus": "Running",
        "hostName": "cco-4.5.0",
        "publicIpAddress": "10.110.13.185",
        "privateIpAddress": "10.0 .0 .13 "
    }, {
        "nodeId ": "90 ddae1d - 14 bd - 4e41 - b6ce - ca835c621046 ",
        "nodeStatus ": "Running ",
        "hostName ": "ccm - 4.5.0 ",
        "publicIpAddress ": "10.110 .13 .186 ",
        "privateIpAddress ": "10.0 .0 .11 "
    }, {
        "nodeId ": "04 d68b0e - 37 c2 - 4 a4d - a2ea - 4 c1bea590a71 ",
        "nodeStatus": "Running",
        "hostName": "ccm-chef",
        "publicIpAddress": "10.110.13.183",
        "privateIpAddress": "10.0 .0 .3 "
    }]
}

Example 2 – Specific Tenant

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/tenants/1/reports?reportType=UNMANAGED_VM_INVENTORY_REPORT&startDate=1467500921101&endDate=1470092921102&cloudAccountId=150&page=0&size=50

Response

{
    "summary": {
        "totalNumberOfVMs": 8,
        "totalNumberOfRunningVMs": 8
    },
    "details": [{
        "nodeId": "412caa93-38e6-4ad1-8627-6ca1d60a02ed",
        "nodeStatus": "Running",
        "hostName": "cco",
        "publicIpAddress": "10.10.12.21",
        "privateIpAddress": "10.0.0.33 "
    }, {
        "nodeId ": "d3cdc409 - 6 a93 - 424e-905 c - 15506 a9194b6 ",
        "nodeStatus ": "Running ",
        "hostName ": "ccm1 ",
        "publicIpAddress ": "10.10.13.18",
        "privateIpAddress": "10.0.0.27"
    }, {
        "nodeId": "d1c6def0-5db9-4a5b-8634-7b94c0b02023",
        "nodeStatus": "Running",
        "hostName": "ccm46",
        "publicIpAddress": "10.10.13.17",
        "privateIpAddress": "10.0.0.24"
    }, {
        "nodeId": "b871ec1d-4959-4c1a-bbb9-e89593de26d9",
        "nodeStatus": "Running",
        "hostName": "chef",
        "publicIpAddress": "10.10.13.12 ",
        "privateIpAddress ": "10.0.0.21 "
    }, {
        "nodeId ": "4 cb3a0fc - efd8 - 4 b12 - b44e - 1 b954aec27e9 ",
        "nodeStatus ": "Running",
        "hostName": "dokku",
        "publicIpAddress": null,
        "privateIpAddress": "10.0.0.19"
    }, {
        "nodeId": "0894a243-5dd4-475d-9710-acdfac81cdd9",
        "nodeStatus": "Running",
        "hostName": "cco-4.5.0",
        "publicIpAddress": "10.10.13.19",
        "privateIpAddress": "10.0.0.13 "
    }, {
        "nodeId ": "90 ddae1d - 14 bd - 4e41 - b6ce - ca835c621046 ",
        "nodeStatus ": "Running ",
        "hostName ": "ccm - 4.5.0 ",
        "publicIpAddress ": "10.10.13.16 ",
        "privateIpAddress ": "10.0.0.11"
    }, {
        "nodeId ": "04 d68b0e - 37 c2 - 4 a4d - a2ea - 4 c1bea590a71 ",
        "nodeStatus": "Running",
        "hostName": "ccm-chef",
        "publicIpAddress": "10.10.13.13",
        "privateIpAddress": "10.0 .0 .3 "
    }]
}

Request Attributes

tenantId

Description: Unique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional context.
Type: String

Required

reportType

Description: Type of reports available for CloudCenter deployments when using v2 APIs

Type: Enumeration

Enumeration	Description
RESOURCE_SUMMARY_REPORT	See the View Resource Summary Report or The Dashboard for additional context.
USAGE_SUMMARY_REPORT	(Default). See View Usage Summary Report or Usage Summary Report for additional context.
USAGE_DETAILS_REPORT	See View Usage Details Report or Usage Details Report for additional context.
MANAGED_VM_INVENTORY_REPORT	See View Managed VM Inventory Report or Managed VM Inventory Report for additional context.
UNMANAGED_VM_INVENTORY_REPORT	See Unmanaged VM Inventory Report for additional context.
VM_COUNT_REPORT	See Running VM History Report for additional context.
Remaining reports	See the v1 View Reports API.

Optional query parameter

regionId

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

Optional query parameter

cloudAccountId

Description: Unique, system-generated identifier for the cloudAccount
Type: String

Required

tenantId

Description: Unique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional context.
Type: String

Optional query parameter

startDate

Description: Unix time in milliseconds. See API Conventions for CloudCenter APIs > Date Format.
Type: Long

Optional query parameter

endDate

Description: Unix epoch time in milliseconds. See API Conventions for CloudCenter APIs > Date Format.
Type: Long

Optional query parameter

Response Attributes

summary

Description: Identifies the total non-managed VM inventory information for your cloud region or cloud account:

Type: Sequence of groups

totalNumberOfVMs

Description: The total number of VMs included in this report (see Deployment and VM States).
Type: Integer

totalNumberOfRunningVMs

Description: The total number of running VMs included in this report (see Financial Overview).
Type: Integer

details

Description: Identifies the non-managed VM inventory details for all jobs for a cloud region or account.

Type: Sequence of job details

nodeId

Description: Unique identifier for the node – generated by the cloud provider
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
Enumeration Description
SUBMITTED The operation has been submitted
RUNNING The operation is currently in progress
SUCCESS The operation succeeded
FAIL The operation failed

hostName

Description: The DNS host name for this VM.
Type: String

publicIpAddr

Description: Public IP address of the application VM or CCO. This attribute is the same as the publicIp or publicIpAddress attributes.
Type: String

privateIpAddr

Description: Private IP address of the application VM or CCO. This attribute is the same as the privateIp attribute and the privateIpAddress attribute.
Type: String