View Cloud Properties

Details

API Details
Name

View Cloud Properties

DescriptionDisplays information about cloud properties for the specified region.
MethodGET
URI
  • v1/cloudProperties/regionName
  • v1/cloudProperties/regionName?propertyType=propertyType&depEnv=depEnvId&cloudAccount=cloudAccountid
  • v1/cloudProperties/cloudType?propertyType=AccessKeyPairs&depEnv=depEnvId&TenantId=TenantId
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • Enhanced in CloudCenter 4.1.1 to include the TenantName and TenantId attributes (see OpenStack Configurations for additional context).
  • Enhanced in CloudCenter 4.7.2 to include the Google Cloud Platform Network and AvailableNetworks options in the propertyType attribute.
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.
  • You can display information for a specific property, deployment environment, and account by including the propertyType, depEnv, and/or cloudAccount query parameters with this API.
ESB Header
  • action: get.cloudProperties.regionName
  • action: get.cloudProperties.regionName
    actionparam:
    propertyType=propertyType&depEnv=depEnv&cloudAccount=cloudAccount
  • action: get.cloudProperties.cloudType
    actionparam: propertyType=AccessKeyPairs&depEnv=depEnvId&TenantId=TenantId

Example 1 – depEnv and cloudAccount

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/cloudProperties/OpenStack-V-Cloud-Region?propertyType=AvailableNetworks&depEnv=1" 

 

The response for the View Deployment Environments API provides the cloudID and the depEnvId details as shown in the following example.

Response

{
    "properties": [
        {
            "id": "0",
            "resource": null,
            "perms": [],
            "value": "2491be73-a12d-48ad-b5b4-57bf3c0fa091",
            "type": "AvailableNetworks",
            "refId": "2491be73-a12d-48ad-b5b4-57bf3c0fa091",
            "attributes": [
                {
                    "name": "NetworkName",
                    "value": "ext-net"
                }
            ],
            "relatedProperties": []
        },
        {
            "id": "0",
            "resource": null,
            "perms": [],
            "value": "72eea417-4686-49de-a57c-af4c49a44636",
            "type": "AvailableNetworks",
            "refId": "72eea417-4686-49de-a57c-af4c49a44636",
            "attributes": [
                {
                    "name": "NetworkName",
                    "value": "vad-net1"
                }
            ],
            "relatedProperties": []
        },
        {
            "id": "0",
            "resource": null,
            "perms": [],
            "value": "95845aef-995e-42d9-8d63-f2572e3cff9f",
            "type": "AvailableNetworks",
            "refId": "95845aef-995e-42d9-8d63-f2572e3cff9f",
            "attributes": [
                {
                    "name": "NetworkName",
                    "value": "vad-net"
                },
                {
                    "name": "isDefaultNetwork",
                    "value": "true"
                }
            ],
            "relatedProperties": []
        }
    ],
    "size": null
}

Example 2 – AccessKeyPairs and TenantId

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/cloudProperties/openstack-regionOne?propertyType=AccessKeyPairs&depEnv=1&TenantId=aa1130285af84becbe0bb4ba8e6b5d62" 

Response

{
    "properties": [
        {
            "id": "0",
            "resource": null,
            "perms": [],
            "value": null,
            "type": "AccessKeyPairs",
            "refId": null,
            "attributes": [
                {
                    "name": "osmosix-user-key-2",
                    "value": "1b:8d:c9:18:32:26:5c:4e:85:6e:93:4c:7a:9a:6e:00"
                },
                {
                    "name": "dd",
                    "value": "3e:97:d4:84:17:01:bd:56:5c:ad:83:f0:2d:e9:d1:26"
                },
                {
                    "name": "cliqrdev",
                    "value": "b8:9a:74:f3:19:ff:ad:35:60:e4:da:57:4a:c8:eb:dc"
                },
                {
                    "name": "test",
                    "value": "14:bf:4a:50:83:58:0a:a0:54:08:30:ba:21:8f:81:7c"
                },
                {
                    "name": "osmosix-system-key",
                    "value": "c3:b3:46:98:59:0b:8a:49:e8:a7:a1:b6:1a:56:0a:25"
                },
                {
                    "name": "garv",
                    "value": "50:ca:6f:b3:cf:6b:a6:b6:0c:42:8f:c6:d2:b8:f2:4f"
                }
            ],
            "relatedProperties": []
        }
    ],
    "size": 1
}

 

Request Attributes

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

  • Type: String
cloudType

Unique identifier for this cloud representation

When you see the cloudType attribute, use the regionName attribute instead.

Required

propertyType
  • Description: The cloud property type for this deployment environment:
    • EC2:

      • AvailabilityZone

      • Vpc

      • Subnet

      • AccountAttributes

    • Azure

      • VirtualNetwork

      • StorageAccount

      • AffinityGroup

    • Google

      • LaunchZone

      • Network
      • AvailableNetworks
    • Generic properties

      • AvailableNetworks: Provides the relevant network identifiers so it/they can be provided to NICs during the job submission process.

      • PrivateFixedIPAllocationStrategies: Provides the right allocation options to network interfaces during the job submission process. See IP Allocation Mode for additional details.

      • PrivatePublicIPPairSupport: Identifies if a cloud supports the Private IP - Public IP pair up. If this property is supported, you can have the Public IP attached to any NIC. 

      • InstanceTypes: Identifies the instance types supported by the cloud account.   

      • ImagesIdentifies images accessible by the cloud account.

  • Type: String

depEnvId
  • DescriptionUnique, system-generated identifier for the deployment environment. See Deployment Environments for additional details. This attribute is the same as the environmentId attribute.
  • Type: String
cloudAccountId
  • Description: Unique, system-generated identifier for the cloudAccount
  • Type: String
TenantId
  • Description: Identifies the network topology for various clouds for OpenStack project information. The network topology of each cloud tenants varies. To differentiate between each cloud tenant, append the OpenStack project information (TenantName or the TenantId) in the cloud properties to retrieve the available networks. If you do not specify any network for a NIC, the CloudCenter platform automatically picks either the specified default network or any network available (for that tenant) for the deployment. See OpenStack Configurations for additional context.
  • Type: String

Response Attributes

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 information)
value
  • Description: Indicates the set value for this property
  • Type: Float
type
  • DescriptionThe type of resource
  • Type: String
refId
  • DescriptionUnique, system-generated identifier for a cloud specific property.
    • For allocation strategies, CloudCenter provides the refId  (based on DHCP, static IP, and so forth) and the refId inherits the same value.
    • For networks, the cloud provides the refId (for example, a unique network Identifier).
  • Type: String
attributes
  • Description: Information about the cloud property
  • Type: Array of name-value pairs

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

    • Type: String

    value
    • Description: Indicates the set value for this property
    • Type: Float

regionProperties
  • Description: Additional properties for this resource
  • TypeName-Value Pair (array)
size
  • Description: Total number of records that any list page should contain. The default is: 

    • v1 APIs = 20 records

    • v2 APIs:

      • Prior to 4.8.0: All elements are returned and the page value is ignored.

      • Effective 4.8.0: 50 records
  • Type: Integer