View Clouds

Details

API Details
Name

View Clouds

Description
MethodGET
URI
  • v1/tenants/tenantId/clouds
  • v1/tenants/tenantId/clouds?detail=true
  • v1/tenants/tenantId/clouds/cloudId
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
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.
  • If you include a cloudId to identify a cloud, the response only includes information for that cloud.
ESB Header
  • action: get.tenants.tenantId.clouds
  • action: get.tenants.tenantId.clouds
    actionparam: detail=true
  • action: get.tenants.tenantId.clouds.cloudId

Example – v1/tenants/1/clouds

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

Response

{
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds",
    "size": 4,
    "pageNumber": 0,
    "totalElements": 4,
    "totalPages": 1,
    "clouds": [
        {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/1",
            "perms": [],
            "name": "OpenStack",
            "cloudFamily": "Openstack",
            "description": "Cliqr's OpenStack Data Center",
            "publicCloud": false,
            "tenantId": "1",
            "detail": null
        },
        {
            "id": "2",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/2",
            "perms": [],
            "name": "Amazon",
            "cloudFamily": "Amazon",
            "description": "Amazon Cloud Group belonging to root tenant",
            "publicCloud": true,
            "tenantId": "1",
            "detail": null
        },
        {
            "id": "3",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/3",
            "perms": [],
            "name": "vCD",
            "cloudFamily": "Vcd",
            "description": "vCD",
            "publicCloud": false,
            "tenantId": "1",
            "detail": null
        },
        {
            "id": "4",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/4",
            "perms": [],
            "name": "MyAmazon",
            "cloudFamily": "Amazon",
            "description": "MyAmazon",
            "publicCloud": true,
            "tenantId": "1",
            "detail": null
        }
    ]
}

Example –  v1/tenants/1/clouds?detail=true

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/clouds?detail=true"

Response

{
    "id": "1",
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/1?detail=true",
    "perms": [],
    "name": "OpenStack",
    "cloudFamily": "Openstack",
    "description": "CliQr's OpenStack Data Center",
    "publicCloud": false,
    "tenantId": "1",
    "detail": {
        "cloudAccounts": [
            {
                "id": "1",
                "resource": "https: //<HOST>: <PORT>/v1/tenants/1/clouds/1/cloudAccounts/1",
                "perms": [],
                "displayName": "VP's US DC OpenStack cloud account",
                "cloudId": "1",
                "userId": "2",
                "accountName": "vp",
                "accountId": "VP's US DC OpenStack cloud account",
                "accountPassword": "welcome2cliqr",
                "accountDescription": "VP's US Data Center OpenStack cloud account",
                "manageCost": true,
                "publicVisible": false,
                "allowedUsers": [],
                "accessPermission": "USERS_AND_SUBTENANT_USERS",
                "accountProperties": [
                    {
                        "name": "QuantumEndpoint",
                        "value": ""
                    },
                    {
                        "name": "Region",
                        "value": "regionOne"
                    },
                    {
                        "name": "TenantName",
                        "value": "vp"
                    },
                    {
                        "name": "NeutronEndpoint",
                        "value": ""
                    },
                    {
                        "name": "NovaEndpoint",
                        "value": ""
                    },
                    {
                        "name": "Endpoint",
                        "value": "http://10.100.1.75:5000/v2.0"
                    },
                    {
                        "name": "PreferredNetwork",
                        "value": ""
                    }
                ]
            }
        ],
        "cloudRegions": [
            {
                "id": "1",
                "resource": "https: //<HOST>: <PORT>/v1/tenants/1/clouds/1/cloudRegions/1",
                "perms": [],
                "cloudId": "1",
                "displayName": "OpenStack-regionOne",
                "regionName": "OpenStack-regionOne",
                "description": null,
                "importRegion": null,
                "gateway": {
                    "address": "10.110.12.145",
                    "dnsName": null,
                    "status": "RUNNING",
                    "cloudId": "1",
                    "cloudAccountId": "1"
                },
                "storage": null,
                "enabled": true,
                "activated": true,
                "numUsers": 17,
                "status": "RUNNING",
                "statusDetail": null,
                "regionProperties": [
                    {
                        "name": "QuantumEndpoint",
                        "value": ""
                    },
                    {
                        "name": "Region",
                        "value": "regionOne"
                    },
                    {
                        "name": "AvailabilityZones",
                        "value": ""
                    },
                    {
                        "name": "NodeNameConfig",
                        "value": ""
                    },
                    {
                        "name": "Endpoint",
                        "value": "http://10.100.1.75:5000/v2.0"
                    },
                    {
                        "name": "NodesPerBatch",
                        "value": ""
                    }
                ]
            }
        ],
        "status": "RUNNING",
        "statusDetail": "RUNNING"
    }
}

Example 3 – v1/tenants/1/clouds/1

{
    "id": "1",
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/1",
    "perms": [],
    "name": "OpenStack",
    "cloudFamily": "Openstack",
    "description": "Cliqr's OpenStack Data Center",
    "publicCloud": false,
    "tenantId": "1",
    "detail": null
}

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String
cloudId
  • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

  • Type: String
details
  • Description: Detailed information that relates to this resource
  • Type: String

Response Attributes

resource
  • Description: Unique URL to access this resource.
  • Type: String
See pageResource or Pagination for additional context
clouds
  • Description: Information about each cloud family.
  • Type: Array of cloud

    id
    • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

    • 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

    cloudFamily                                                                                                                                                                                
    • Description: The cloud provider name.                     
    • Type: String

    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String

    publicCloud
    • Description: Inticates 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

    tenantId
    • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

    • Type: String

    detail (click for additional details)

    If the request URL does not have a detail query parameter with the value=true, then this field displays null.