View Non-Managed Cloud Details

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameView Non-Managed (nonManaged) Cloud Details
Description

Displays information for each cloud region or for a specified cloud region for the specified cloud within the specified tenant

Allowed Role(s)WM_USER
MethodGET
URI

v1/tenants/tenantId/nonManagedClouds

cloudcenter-ccm-backend/api/v1/tenants/tenantId/nonManagedClouds

Sample Request
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/nonManagedClouds"
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/tenants/1/nonManagedClouds"
Release
  • Introduced in CloudCenter 4.6
  • Enhanced in CloudCenter 4.9.0 to include the cloudFamilyType attribute and deprecate the publicCloud attribute

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.
  • For all available cloud families, logged-in users see all regions to which each user has access.

  • If the cloud regions status ≠ RUNNING (based on last known status in the CCM database), then this cloud region is not displayed.

  • Displays all cloud accounts owned by the user in that cloud family. Any cloud account that is explicitly shared to this user is not displayed.

  • If a cloud group has no regions or cloud accounts available – if either the size of cloudRegions or cloudAccounts = 0, then the cloud family is not displayed (both attributes are required to retrieve this list from the CCO).

Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: get.tenants.tenantId.nonManagedClouds

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

Not applicable

Sample Response

{
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/nonManagedClouds",
    "size": 0,
    "pageNumber": 0,
    "totalElements": 0,
    "totalPages": 0,
    "clouds": [{
        "id": "6",
        "resource": "https://<HOST>:<PORT>/v1/tenants/1/nonManagedClouds/6",
        "name": "SoftLayer",
        "cloudFamily": "SoftLayer",
        "description": "",
        "publicCloud": true,
        "tenantId": "1",
        "detail": {
            "cloudAccounts": [{
                "id": "6",
                "resource": null,
                "perms": ["administration", "write", "delete", "read"],
                "displayName": "SoftLayer CloudCenter Prod",
                "cloudId": "6",
                "userId": "2",
                "accountDescription": "",
                "manageCost": true,
                "allowedUsers": [],
                "accessPermission": "PRIVATE"
            }],
            "cloudRegions": [{
                "id": "11",
                "resource": null,
                "cloudId": "6",
                "displayName": "Dallas 09 (dal09)",
                "regionName": "SoftLayer-dal09",
                "description": "SoftLayer Dallas 09 (dal09)",
                "importRegion": null,
                "gateway": {
                    "address": "saas-cco-softlayer-dallas9.company.com",
                    "dnsName": null,
                    "status": "RUNNING",
                    "cloudId": "6",
                    "cloudAccountId": null
                },
                "enabled": true,
                "activated": true,
                "numUsers": 40,
                "status": "RUNNING",
                "statusDetail": null,
                "regionProperties": [{
                    "name": "privateVlanNumber",
                    "value": ""
                }, {
                    "name": "publicVlanNumber",
                    "value": ""
                }, {
                    "name": "datacenter",
                    "value": "dal09"
                }],
                "externalBundleLocation": null,
                "externalActions": []
            }],
            "status": "RUNNING",
            "statusDetail": "RUNNING"
        }
    }, {
        "id": "7",
        "resource": "https://<HOST>:<PORT>/v1/tenants/1/nonManagedClouds/7",
        "name": "Openstack",
        "cloudFamily": "Openstack",
        "description": "Openstack",
        "publicCloud": false,
        "tenantId": "1",
        "detail": {
            "cloudAccounts": [{
                "id": "13",
                "resource": null,
                "perms": ["administration", "write", "delete", "read"],
                "displayName": "CloudCenter Private Cloud",
                "cloudId": "7",
                "userId": "2",
                "accountDescription": "",
                "manageCost": true,
                "allowedUsers": [],
                "accessPermission": "PRIVATE"
            }, {
                "id": "150",
                "resource": null,
                "perms": ["administration", "write", "delete", "read"],
                "displayName": "hihu-openstack",
                "cloudId": "7",
                "userId": "2",
                "accountDescription": "",
                "manageCost": true,
                "allowedUsers": [],
                "accessPermission": "PRIVATE"
            }],
            "cloudRegions": [{
                "id": "13",
                "resource": null,
                "cloudId": "7",
                "displayName": "CloudCenter regionOne",
                "regionName": "Openstack-regionOne",
                "description": null,
                "importRegion": null,
                "gateway": {
                    "address": "saas-cco-openstack.company.com",
                    "dnsName": null,
                    "status": "RUNNING",
                    "cloudId": "7",
                    "cloudAccountId": null
                },
                "enabled": true,
                "activated": true,
                "numUsers": 53,
                "status": "RUNNING",
                "statusDetail": null,
                "regionProperties": [{
                    "name": "Endpoint",
                    "value": "http://1<HOST>:<PORT>/v2.0"
                }, {
                    "name": "NodeNameConfig",
                    "value": ""
                }, {
                    "name": "NodesPerBatch",
                    "value": ""
                }, {
                    "name": "AvailabilityZones",
                    "value": ""
                }, {
                    "name": "Region",
                    "value": "regionOne"
                }, {
                    "name": "QuantumEndpoint",
                    "value": ""
                }],
                "externalBundleLocation": null,
                "externalActions": []
            }, {
                "id": "38",
                "resource": null,
                "cloudId": "7",
                "displayName": "hihu-regionOne",
                "regionName": "Openstack-hihu-regionOne",
                "description": null,
                "importRegion": null,
                "gateway": {
                    "address": "<HOST>:<PORT>",
                    "dnsName": null,
                    "status": "RUNNING",
                    "cloudId": "7",
                    "cloudAccountId": "150"
                },
                "enabled": true,
                "activated": true,
                "numUsers": 3,
                "status": "RUNNING",
                "statusDetail": null,
                "regionProperties": [{
                    "name": "Endpoint",
                    "value": "http://<HOST>:<PORT>/v2.0"
                }, {
                    "name": "NodesPerBatch",
                    "value": ""
                }, {
                    "name": "NodeNameConfig",
                    "value": ""
                }, {
                    "name": "AvailabilityZones",
                    "value": ""
                }, {
                    "name": "Region",
                    "value": "regionOne"
                }, {
                    "name": "InstanceNamingStrategy",
                    "value": "Default"
                }, {
                    "name": "InstanceIPAMStrategy",
                    "value": "NoIPAM"
                }],
                "externalBundleLocation": null,
                "externalActions": []
            }],
            "status": "RUNNING",
            "statusDetail": "RUNNING"
        }
    }]
}


Request Attributes

Required

Response Attributes