View Cloud Families

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameList Cloud Families for a Tenant
Description

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

Allowed Role(s)WM_USER, WM_ADMIN
MethodGET
URI
  • v1/cloudFamilies
  • v1/cloudFamilies/cloudFamiliesId
  • cloudcenter-cloud-setup/api/v1/cloudFamilies
  • cloudcenter-cloud-setup/api/v1/cloudFamilies/cloudFamiliesId
Sample Request
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/clouds/1/accounts"         
curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-cloud-setup/api/v1/tenants/1/clouds/1/accounts"
Release
  • Introduced in CloudCenter 4.0
  • Enhanced in CloudCenter 4.7.2 to include the Alibaba Cloud in the cloudFamilies and the  cloudFamiliesId attributes
  • Enhanced in CloudCenter 4.9.0:
    • Include the Azure Stack cloud and Kubernetes container in the cloudFamilies and the  cloudFamiliesId attributes
    • 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.
  • Provides the HTTP location URL that you can use to query the system until this call returns a success or failure code.
  • The pageResource attributes do not apply to this API.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

  • action: get.cloudFamilies
  • action: get.cloudFamilies.cloudFamiliesId

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

Not applicable

Sample 1 -Cloud Family

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/cloudFamilies/Amazon"
{

    "id": "Amazon",

    "resource": "https://<HOST>:<PORT>/v1/cloudFamilies/Amazon",

    "perms": [],

    "name": "Amazon",

    "description": "Amazon Public Cloud",

    "publicCloud": true,

} 


Example 2 – Cloud Families

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/cloudFamilies"

Response

{
  "cloudFamilies": [
    {
      "id": "Amazon",
      "resource": https://<HOST>:<PORT>/v1/cloudFamilies/Amazon,
      "perms": [],
      "name": "Amazon",
      "description": "Amazon Public Cloud",
      "publicCloud": true  
    },
    {
      "id": "Cisco",
      "resource": https://<HOST>:<PORT>/v1/cloudFamilies/Cisco,
      "perms": [],
      "name": "Cisco",
      "description": "Cisco CloudCenter Service",
      "publicCloud": false
    },
    {
      "id": "CiscoUCSD",
      "resource": https://<HOST>:<PORT>/v1/cloudFamilies/CiscoUCSD,
      "perms": [],
      "name": "CiscoUCSD",
      "description": "Cisco UCSD",
      "publicCloud": false
    },
    {
      "id": "Google",
      "resource": https://<HOST>:<PORT>/v1/cloudFamilies/Google,
      "perms": [],
      "name": "Google Compute Engine",
      "description": "Google Compute Engine",
      "publicCloud": true
    },
    {
      "id": "Openstack",
      "resource": https://<HOST>:<PORT>/v1/cloudFamilies/Openstack,
      "perms": [],
      "name": "Openstack",
      "description": "Openstack",
      "publicCloud": false
    },
    {
      "id": "Opsource",
      "resource": https://<HOST>:<PORT>/v1/cloudFamilies/Opensource,
      "perms": [],
      "name": "Opsource",
      "description": "DimensionData",
      "publicCloud": true
    },
    {
      "id": "SoftLayer",
      "resource": https://<HOST>:<PORT>/v1/cloudFamilies/SoftLayer,
      "perms": [],
      "name": "SoftLayer",
      "description": "IBM SoftLayer",
      "publicCloud": true
    },
    {
      "id": "Vmware",
      "resource": https://<HOST>:<PORT>/v1/cloudFamilies/Vmware,
      "perms": [],
      "name": "VMware Private Cloud",
      "description": "VMware Private Cloud",
      "publicCloud": false
    },
    {
      "id": "Vcd",
      "resource": https://<HOST>:<PORT>/v1/cloudFamilies/Vcd,
      "perms": [],
      "name": "Vcd",
      "description": "VMWare vCloud Director",
      "publicCloud": false
    },
    {
      "id": "Azure",
      "resource": https://<HOST>:<PORT>/v1/cloudFamilies/Azure,
      "perms": [],
      "name": "Windows Azure",
      "description": "Windows Azure",
      "publicCloud": true
    },
    {  
      "id":"Alibaba",
      "resource":"https://<HOST>:<PORT>/v1/cloudFamilies/Alibaba",
      "name":"Alibaba",
      "description":"Alibaba Public Cloud",
      "publicCloud":true
    }
 ]
}

Request Attributes

The id attribute for a cloudFamiliesId is an alphabetic string, instead of the numeric integer string generated by the system for other CloudCenter resources.

Use the value of ID value (to retrieve the alphabetic string for cloudFamiliesId) from the View Cloud Families API to provide the list of acceptable value for the cloud of your choice so you can use it for the cloudFamily attribute to be used in this Update Cloud API.

Response Attributes

cloudFamilies
  • Description: The cloud provider information for the identified public clouds or datacenters and private clouds. See the Public Clouds section or the Supported Datacenters and Private Clouds section for the relevant release for additional context.
  • Type: Array of mapped attributes

    cloudFamiliesId
    • Description: Unique, system-generated identifier for a cloud family. Possible values are:

      • Alibaba (effective CloudCenter 4.7.2)  

      • Amazon

      • AzureRM 

      • AzurePack

      • AzureStack (effective CloudCenter 4.9.0)

      • CiscoUCSD

      • Kubernetes (effective CloudCenter 4.9.0)

      • Openstack

      • Opsource

      • SoftLayer

      • Vcd

      • Vmware

      • Cisco  (prior to CloudCenter 4.6.0)

      • CloudStack (prior to CloudCenter 4.6.0)

      • Cloudn (prior to CloudCenter 4.6.0)

      • Rackspace2 (prior to CloudCenter 4.6.0)

    • Type: String

    resource
    • Description: Unique URL to access this resource.
    • Type: String
    perms (click for additional details)

    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String

    publicCloud (Deprecated)
    • Description: Indicates if this is a public cloud. This attribute is useful to identify datacenters and private clouds as features like sync storage and add storage type is not applicable to public clouds.
    • Type: Boolean
      • true = This is a public cloud. See the Public Clouds section for the relevant release for a complete list.
      • false = This is not a public cloud. See the Datacenters and Private Clouds section for the relevant release for a complete list.

    cloudFamilyType
    • Description: Indicates if this is a public cloud, a private cloud/datacenter, or a container cloud. This attribute is useful to identify features that are not available in all cloud environments. For example, sync storage and add storage type are not applicable to public clouds.
    • Type: Enumeration

      EnumerationDescription
      PublicAny cloud listed in the Public Clouds section for the applicable release.
      PrivateAny cloud listed in the Datacenters and Private Clouds section for the applicable release.
      ContainerAny cloud listed in the Container Clouds section for the applicable release.



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