View Cloud Properties (v2)

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameView Cloud Properties (v2)
Description

Displays cloud-specific details about the cloud from where a job is started

Allowed Role(s)

WM_USER, WM_ADMIN

MethodGET
URI
  • v2/cloudProperties/regionName
  • v2/cloudProperties/regionName?propertyTypes=propertyTypes&cloudAccount=cloudAccountId
  • v2/cloudProperties/regionName?propertyTypes=propertyTypes&cloudAccount=cloudAccountId&vCloudOrgVdcName=vCloudOrgVdcName
  • v2/cloudProperties/regionName?propertyTypes=NameSpace,PersistentVolumeClaims,StorageClass&cloudAccount=cloudAccountId
  • cloudcenter-cloud-setup/api/v2/cloudProperties/regionName
  • cloudcenter-cloud-setup/api/v2/cloudProperties/regionName?propertyTypes=propertyTypes&cloudAccount=cloudAccountId
  • cloudcenter-cloud-setup/api/v2/cloudProperties/regionName?propertyTypes=propertyTypes&cloudAccount=cloudAccountId&vCloudOrgVdcName=vCloudOrgVdcName
  • cloudcenter-cloud-setup/api/v2/cloudProperties/regionName?propertyTypes=NameSpace,PersistentVolumeClaims,StorageClass&cloudAccount=cloudAccountId
Sample Request
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/cloudProperties/Vcd-Default?propertyTypes=StoragePolicies&cloudAccount=1&vCloudOrgVdcName=org1_user_vdc" 
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-cloud-setup/api/v2/cloudProperties/Vcd-Default?propertyTypes=StoragePolicies&cloudAccount=1&vCloudOrgVdcName=org1_user_vdc" 
Release
  • Introduced in CloudCenter 4.8.1
  • Enhanced in CloudCenter 4.8.2 to include the attributes for the VPC and Subnets to indicate the IPv6 CIDR assigned and IPv6 address on the subnet (isIPV6Enabled and ipv6CidrBlock in Example 3 and 4 below)
  • Enhanced in CloudCenter 4.9.0 to include additional propertyTypes for cloud containers (NameSpace,PersistentVolumeClaims,StorageClass in Example 5 below)

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.
  • 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.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

  • action: get.cloudProperties.regionName
  • action: get.cloudProperties.regionName
    actionparam:
    propertyTypes=propertyTypes&cloudAccount=cloudAccountId
  • action: get.cloudProperties.regionName
    actionparam
    :
    propertyTypes=propertyTypes&cloudAccount=cloudAccountId&
    vCloudOrgVdcName=vCloudOrgVdcName

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

Not applicable

Sample Response 1

{
   "id":null,
   "resource":null,
   "properties":[
      {
         "propertyType":"StoragePolicies",
         "propertyValue":{
            "properties":[
               {
                  "id":null,
                  "resource":null,
                  "value":null,
                  "type":null,
                  "refId":null,
                  "attributes":[

                  ],
                  "relatedProperties":[
                     {
                        "id":"0",
                        "resource":null,
                        "value":"*",
                        "type":"StoragePolicies",
                        "refId":"*",
                        "attributes":[

                        ],
                        "relatedProperties":[

                        ]
                     },
                     {
                        "id":"0",
                        "resource":null,
                        "value":"shared",
                        "type":"StoragePolicies",
                        "refId":"shared",
                        "attributes":[

                        ],
                        "relatedProperties":[

                        ]
                     }
                  ]
               }
            ],
            "size":2
         }
      }
   ]
}

Example 2

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/cloudProperties/Vcd-Default?propertyTypes=OrgVdc&cloudAccount=1" 

Response

{
   "id":null,
   "resource":null,
   "properties":[
      {
         "propertyType":"OrgVdc",
         "propertyValue":{
            "properties":[
               {
                  "id":null,
                  "resource":null,
                  "value":null,
                  "type":null,
                  "refId":null,
                  "attributes":[

                  ],
                  "relatedProperties":[
                     {
                        "id":"0",
                        "resource":null,
                        "value":"org1_user_vdc",
                        "type":"OrgVdc",
                        "refId":"org1_user_vdc",
                        "attributes":[

                        ],
                        "relatedProperties":[
                           {
                              "id":"0",
                              "resource":null,
                              "value":"routed-net1",
                              "type":"OrgNetworks",
                              "refId":"routed-net1",
                              "attributes":[

                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"org1_user_dhcpOnly",
                              "type":"OrgNetworks",
                              "refId":"org1_user_dhcpOnly",
                              "attributes":[

                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"org1_shared_nw1",
                              "type":"OrgNetworks",
                              "refId":"org1_shared_nw1",
                              "attributes":[

                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"*",
                              "type":"StoragePolicies",
                              "refId":"*",
                              "attributes":[

                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"shared",
                              "type":"StoragePolicies",
                              "refId":"shared",
                              "attributes":[

                              ],
                              "relatedProperties":[

                              ]
                           }
                        ]
                     },
                     {
                        "id":"0",
                        "resource":null,
                        "value":"org1_mgmt_vdc",
                        "type":"OrgVdc",
                        "refId":"org1_mgmt_vdc",
                        "attributes":[

                        ],
                        "relatedProperties":[
                           {
                              "id":"0",
                              "resource":null,
                              "value":"org1_shared_nw1",
                              "type":"OrgNetworks",
                              "refId":"org1_shared_nw1",
                              "attributes":[

                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"org1_mgmt_nw1",
                              "type":"OrgNetworks",
                              "refId":"org1_mgmt_nw1",
                              "attributes":[

                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"*",
                              "type":"StoragePolicies",
                              "refId":"*",
                              "attributes":[

                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"shared",
                              "type":"StoragePolicies",
                              "refId":"shared",
                              "attributes":[

                              ],
                              "relatedProperties":[

                              ]
                           }
                        ]
                     }
                  ]
               }
            ],
            "size":2
         }
      }
   ]
}

Example 3 – AWS

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/cloudProperties/aws-eu-west-1"

The name value pairs identify of the status for these two values.

{"name":"isIPV6Enabled","value":"true"},

{"name":"ipv6CidrBlock","value":"2600:1f14:5aa:2f02::/64"}

Response

{
   "id":null,
   "resource":null,
   "properties":[
      {
         "propertyType":"Vpc",
         "propertyValue":{
            "properties":[
               {
                  "id":null,
                  "resource":null,
                  "value":null,
                  "type":null,
                  "refId":null,
                  "attributes":[

                  ],
                  "relatedProperties":[
                     {
                        "id":"0",
                        "resource":null,
                        "value":"vpc-0e96fe69",
                        "type":"Vpc",
                        "refId":"vpc-0e96fe69",
                        "attributes":[
                           {
                              "name":"instanceTenancy",
                              "value":"default"
                           },
                           {
                              "name":"NetworkName",
                              "value":null
                           },
                           {
                              "name":"isDefault",
                              "value":"false"
                           },
                           {
                              "name":"dhcpOptionsId",
                              "value":"dopt-0d37f76a"
                           },
                           {
                              "name":"cidrBlock",
                              "value":"<HOST>:<PORT>"
                           },
                           {
                              "name":"tag_Name",
                              "value":"qatestt"
                           },
                           {
                              "name":"isIPV6Enabled",
                              "value":"true"
                           },
                           {
                              "name":"type",
                              "value":null
                           },
                           {
                              "name":"ipv6CidrBlock",
                              "value":"2600:1f14:5aa:2f00::/56"
                           }
                        ],
                        "relatedProperties":[
                           {
                              "id":"0",
                              "resource":null,
                              "value":"subnet-02a6034b",
                              "type":"Subnet",
                              "refId":"subnet-02a6034b",
                              "attributes":[
                                 {
                                    "name":"isDefaultForAz",
                                    "value":"true"
                                 },
                                 {
                                    "name":"availableIpAddressCount",
                                    "value":"4085"
                                 },
                                 {
                                    "name":"vpcId",
                                    "value":"vpc-0e96fe69"
                                 },
                                 {
                                    "name":"cidrBlock",
                                    "value":"<HOST>:<PORT>"
                                 },
                                 {
                                    "name":"mapPublicIPCheckBoxOnLaunch",
                                    "value":"true"
                                 },
                                 {
                                    "name":"isIPV6Enabled",
                                    "value":"true"
                                 },
                                 {
                                    "name":"availabilityZone",
                                    "value":"us-west-2b"
                                 },
                                 {
                                    "name":"ipv6CidrBlock",
                                    "value":"2600:1f14:5aa:2f00::/64"
                                 },
                                 {
                                    "name":"assignIpv6AddressOnCreation",
                                    "value":"true"
                                 }
                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"subnet-63cdc83b",
                              "type":"Subnet",
                              "refId":"subnet-63cdc83b",
                              "attributes":[
                                 {
                                    "name":"isDefaultForAz",
                                    "value":"true"
                                 },
                                 {
                                    "name":"availableIpAddressCount",
                                    "value":"4090"
                                 },
                                 {
                                    "name":"vpcId",
                                    "value":"vpc-0e96fe69"
                                 },
                                 {
                                    "name":"cidrBlock",
                                    "value":"<HOST>:<PORT>"
                                 },
                                 {
                                    "name":"mapPublicIPCheckBoxOnLaunch",
                                    "value":"true"
                                 },
                                 {
                                    "name":"isIPV6Enabled",
                                    "value":"true"
                                 },
                                 {
                                    "name":"availabilityZone",
                                    "value":"us-west-2c"
                                 },
                                 {
                                    "name":"ipv6CidrBlock",
                                    "value":"2600:1f14:5aa:2f01::/64"
                                 },
                                 {
                                    "name":"assignIpv6AddressOnCreation",
                                    "value":"false"
                                 }
                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"subnet-39a2215e",
                              "type":"Subnet",
                              "refId":"subnet-39a2215e",
                              "attributes":[
                                 {
                                    "name":"isDefaultForAz",
                                    "value":"true"
                                 },
                                 {
                                    "name":"availableIpAddressCount",
                                    "value":"4091"
                                 },
                                 {
                                    "name":"vpcId",
                                    "value":"vpc-0e96fe69"
                                 },
                                 {
                                    "name":"cidrBlock",
                                    "value":"<HOST>:<PORT>"
                                 },
                                 {
                                    "name":"mapPublicIPCheckBoxOnLaunch",
                                    "value":"true"
                                 },
                                 {
                                    "name":"isIPV6Enabled",
                                    "value":"false"
                                 },
                                 {
                                    "name":"availabilityZone",
                                    "value":"us-west-2a"
                                 },
                                 {
                                    "name":"ipv6CidrBlock",
                                    "value":null
                                 },
                                 {
                                    "name":"assignIpv6AddressOnCreation",
                                    "value":"false"
                                 }
                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"subnet-41de2b09",
                              "type":"Subnet",
                              "refId":"subnet-41de2b09",
                              "attributes":[
                                 {
                                    "name":"isDefaultForAz",
                                    "value":"false"
                                 },
                                 {
                                    "name":"availableIpAddressCount",
                                    "value":"4091"
                                 },
                                 {
                                    "name":"vpcId",
                                    "value":"vpc-0e96fe69"
                                 },
                                 {
                                    "name":"cidrBlock",
                                    "value":"<HOST>:<PORT>"
                                 },
                                 {
                                    "name":"mapPublicIPCheckBoxOnLaunch",
                                    "value":"false"
                                 },
                                 {
                                    "name":"isIPV6Enabled",
                                    "value":"true"
                                 },
                                 {
                                    "name":"availabilityZone",
                                    "value":"us-west-2b"
                                 },
                                 {
                                    "name":"ipv6CidrBlock",
                                    "value":"2600:1f14:5aa:2f02::/64"
                                 },
                                 {
                                    "name":"assignIpv6AddressOnCreation",
                                    "value":"true"
                                 }
                              ],
                              "relatedProperties":[

                              ]
                           }
                        ]
                     }
                  ]
               }
            ],
            "size":1
         }
      },
      {
         "propertyType":"PrivateFixedIPAllocationStrategies",
         "propertyValue":null
      }
   ]
}

Example 4 – OpenStack

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/cloudProperties/Openstack1-RegionOne?propertyTypes=AllTenants%2CPrivateFixedIPAllocationStrategies%2CAvailableNetworks&cloudAccount=1&TenantName=riab"

The name value pairs identify of the status for these two values.

{"name":"isIPV6Enabled","value":"true"},

{"name":"ipv6CidrBlock","value":"2600:1f14:5aa:2f02::/64"}

Response

{
   "id":null,
   "resource":null,
   "properties":[
      {
         "propertyType":"AvailableNetworks",
         "propertyValue":{
            "properties":[
               {
                  "id":null,
                  "resource":null,
                  "value":null,
                  "type":null,
                  "refId":null,
                  "attributes":[

                  ],
                  "relatedProperties":[
                     {
                        "id":"0",
                        "resource":null,
                        "value":"8ab68d58-f20f-4ecd-969e-0c99042cd1a3",
                        "type":"AvailableNetworks",
                        "refId":"8ab68d58-f20f-4ecd-969e-0c99042cd1a3",
                        "attributes":[
                           {
                              "name":"instanceTenancy",
                              "value":null
                           },
                           {
                              "name":"NetworkName",
                              "value":"riabipv6"
                           },
                           {
                              "name":"isDefault",
                              "value":"false"
                           },
                           {
                              "name":"dhcpOptionsId",
                              "value":null
                           },
                           {
                              "name":"cidrBlock",
                              "value":null
                           },
                           {
                              "name":"isIPV6Enabled",
                              "value":"true"
                           },
                           {
                              "name":"type",
                              "value":null
                           },
                           {
                              "name":"ipv6CidrBlock",
                              "value":null
                           }
                        ],
                        "relatedProperties":[
                           {
                              "id":"0",
                              "resource":null,
                              "value":"3c606943-d2f0-40d1-864d-53f9ccfc02c9",
                              "type":"Subnet",
                              "refId":"3c606943-d2f0-40d1-864d-53f9ccfc02c9",
                              "attributes":[
                                 {
                                    "name":"isDefaultForAz",
                                    "value":"false"
                                 },
                                 {
                                    "name":"vpcId",
                                    "value":"8ab68d58-f20f-4ecd-969e-0c99042cd1a3"
                                 },
                                 {
                                    "name":"cidrBlock",
                                    "value":"10.16.0.0/16"
                                 },
                                 {
                                    "name":"isIPV6Enabled",
                                    "value":"false"
                                 },
                                 {
                                    "name":"availabilityZone",
                                    "value":null
                                 },
                                 {
                                    "name":"ipv6CidrBlock",
                                    "value":null
                                 },
                                 {
                                    "name":"assignIpv6AddressOnCreation",
                                    "value":"false"
                                 }
                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"ccc5d6ae-863c-4d96-9228-0ff266e8cb14",
                              "type":"Subnet",
                              "refId":"ccc5d6ae-863c-4d96-9228-0ff266e8cb14",
                              "attributes":[
                                 {
                                    "name":"isDefaultForAz",
                                    "value":"false"
                                 },
                                 {
                                    "name":"vpcId",
                                    "value":"8ab68d58-f20f-4ecd-969e-0c99042cd1a3"
                                 },
                                 {
                                    "name":"cidrBlock",
                                    "value":"2001:dbb::/48"
                                 },
                                 {
                                    "name":"isIPV6Enabled",
                                    "value":"true"
                                 },
                                 {
                                    "name":"availabilityZone",
                                    "value":null
                                 },
                                 {
                                    "name":"ipv6CidrBlock",
                                    "value":null
                                 },
                                 {
                                    "name":"assignIpv6AddressOnCreation",
                                    "value":"false"
                                 }
                              ],
                              "relatedProperties":[

                              ]
                           }
                        ]
                     },
                     {
                        "id":"0",
                        "resource":null,
                        "value":"b6ec17d9-67c4-41aa-b832-660b08c23ac4",
                        "type":"AvailableNetworks",
                        "refId":"b6ec17d9-67c4-41aa-b832-660b08c23ac4",
                        "attributes":[
                           {
                              "name":"instanceTenancy",
                              "value":null
                           },
                           {
                              "name":"NetworkName",
                              "value":"IPV4only"
                           },
                           {
                              "name":"isDefault",
                              "value":"false"
                           },
                           {
                              "name":"dhcpOptionsId",
                              "value":null
                           },
                           {
                              "name":"cidrBlock",
                              "value":null
                           },
                           {
                              "name":"isIPV6Enabled",
                              "value":"false"
                           },
                           {
                              "name":"type",
                              "value":null
                           },
                           {
                              "name":"ipv6CidrBlock",
                              "value":null
                           }
                        ],
                        "relatedProperties":[
                           {
                              "id":"0",
                              "resource":null,
                              "value":"f4ecb6d9-deb3-44d0-ab6f-8a7f8151c100",
                              "type":"Subnet",
                              "refId":"f4ecb6d9-deb3-44d0-ab6f-8a7f8151c100",
                              "attributes":[
                                 {
                                    "name":"isDefaultForAz",
                                    "value":"false"
                                 },
                                 {
                                    "name":"vpcId",
                                    "value":"b6ec17d9-67c4-41aa-b832-660b08c23ac4"
                                 },
                                 {
                                    "name":"cidrBlock",
                                    "value":"10.26.0.0/16"
                                 },
                                 {
                                    "name":"isIPV6Enabled",
                                    "value":"false"
                                 },
                                 {
                                    "name":"availabilityZone",
                                    "value":null
                                 },
                                 {
                                    "name":"ipv6CidrBlock",
                                    "value":null
                                 },
                                 {
                                    "name":"assignIpv6AddressOnCreation",
                                    "value":"false"
                                 }
                              ],
                              "relatedProperties":[

                              ]
                           }
                        ]
                     },
                     {
                        "id":"0",
                        "resource":null,
                        "value":"ba76e273-2a23-4022-8c0f-f75e9d761dc7",
                        "type":"AvailableNetworks",
                        "refId":"ba76e273-2a23-4022-8c0f-f75e9d761dc7",
                        "attributes":[
                           {
                              "name":"instanceTenancy",
                              "value":null
                           },
                           {
                              "name":"NetworkName",
                              "value":"riab-net01"
                           },
                           {
                              "name":"isDefault",
                              "value":"false"
                           },
                           {
                              "name":"dhcpOptionsId",
                              "value":null
                           },
                           {
                              "name":"cidrBlock",
                              "value":null
                           },
                           {
                              "name":"isIPV6Enabled",
                              "value":"true"
                           },
                           {
                              "name":"type",
                              "value":null
                           },
                           {
                              "name":"ipv6CidrBlock",
                              "value":null
                           }
                        ],
                        "relatedProperties":[
                           {
                              "id":"0",
                              "resource":null,
                              "value":"9b35ca85-deed-4ee0-9835-5b61404e6426",
                              "type":"Subnet",
                              "refId":"9b35ca85-deed-4ee0-9835-5b61404e6426",
                              "attributes":[
                                 {
                                    "name":"isDefaultForAz",
                                    "value":"false"
                                 },
                                 {
                                    "name":"vpcId",
                                    "value":"ba76e273-2a23-4022-8c0f-f75e9d761dc7"
                                 },
                                 {
                                    "name":"cidrBlock",
                                    "value":"10.0.0.0/24"
                                 },
                                 {
                                    "name":"isIPV6Enabled",
                                    "value":"false"
                                 },
                                 {
                                    "name":"availabilityZone",
                                    "value":null
                                 },
                                 {
                                    "name":"ipv6CidrBlock",
                                    "value":null
                                 },
                                 {
                                    "name":"assignIpv6AddressOnCreation",
                                    "value":"false"
                                 }
                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"8a08f774-b525-44e5-95b0-26775f97d5e7",
                              "type":"Subnet",
                              "refId":"8a08f774-b525-44e5-95b0-26775f97d5e7",
                              "attributes":[
                                 {
                                    "name":"isDefaultForAz",
                                    "value":"false"
                                 },
                                 {
                                    "name":"vpcId",
                                    "value":"ba76e273-2a23-4022-8c0f-f75e9d761dc7"
                                 },
                                 {
                                    "name":"cidrBlock",
                                    "value":"2001:dbb::/48"
                                 },
                                 {
                                    "name":"isIPV6Enabled",
                                    "value":"true"
                                 },
                                 {
                                    "name":"availabilityZone",
                                    "value":null
                                 },
                                 {
                                    "name":"ipv6CidrBlock",
                                    "value":null
                                 },
                                 {
                                    "name":"assignIpv6AddressOnCreation",
                                    "value":"false"
                                 }
                              ],
                              "relatedProperties":[

                              ]
                           }
                        ]
                     }
                  ]
               }
            ],
            "size":3
         }
      },
      {
         "propertyType":"PrivateFixedIPAllocationStrategies",
         "propertyValue":{
            "properties":[
               {
                  "id":null,
                  "resource":null,
                  "value":null,
                  "type":null,
                  "refId":null,
                  "attributes":[

                  ],
                  "relatedProperties":[
                     {
                        "id":"0",
                        "resource":null,
                        "value":"DHCP",
                        "type":"PrivateFixedIPAllocationStrategies",
                        "refId":"DHCP",
                        "attributes":[
                           {
                              "name":"ENABLED",
                              "value":"true"
                           },
                           {
                              "name":"DEFAULT",
                              "value":"true"
                           }
                        ],
                        "relatedProperties":[

                        ]
                     },
                     {
                        "id":"0",
                        "resource":null,
                        "value":"IPAMCallout",
                        "type":"PrivateFixedIPAllocationStrategies",
                        "refId":"IPAM_CALLOUT",
                        "attributes":[
                           {
                              "name":"ENABLED",
                              "value":"false"
                           },
                           {
                              "name":"DEFAULT",
                              "value":"false"
                           }
                        ],
                        "relatedProperties":[

                        ]
                     },
                     {
                        "id":"0",
                        "resource":null,
                        "value":"Preallocate IP",
                        "type":"PrivateFixedIPAllocationStrategies",
                        "refId":"PREALLOCATE_IP",
                        "attributes":[
                           {
                              "name":"ENABLED",
                              "value":"true"
                           },
                           {
                              "name":"DEFAULT",
                              "value":"false"
                           }
                        ],
                        "relatedProperties":[

                        ]
                     },
                     {
                        "id":"0",
                        "resource":null,
                        "value":"Static IP",
                        "type":"PrivateFixedIPAllocationStrategies",
                        "refId":"STATIC_IP",
                        "attributes":[
                           {
                              "name":"ENABLED",
                              "value":"false"
                           },
                           {
                              "name":"DEFAULT",
                              "value":"false"
                           }
                        ],
                        "relatedProperties":[

                        ]
                     }
                  ]
               }
            ],
            "size":4
         }
      },
      {
         "propertyType":"AllTenants",
         "propertyValue":{
            "properties":[
               {
                  "id":null,
                  "resource":null,
                  "value":null,
                  "type":null,
                  "refId":null,
                  "attributes":[

                  ],
                  "relatedProperties":[
                     {
                        "id":"0",
                        "resource":null,
                        "value":null,
                        "type":"Tenant",
                        "refId":"c5e235f303164d1ebcc3eceee2d54519",
                        "attributes":[
                           {
                              "name":"TenantName",
                              "value":"riab"
                           }
                        ],
                        "relatedProperties":[

                        ]
                     }
                  ]
               }
            ],
            "size":1
         }
      }
   ]
}

Example 5 – Kubernetes

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/cloudProperties/K8s-default?propertyTypes=NameSpace,PersistentVolumeClaims,StorageClass&cloudAccount=1

Response

{
   "id":null,
   "resource":null,
   "properties":[
      {
         "propertyType":"PersistentVolumeClaims",
         "propertyValue":{
            "properties":[
               {
                  "id":null,
                  "resource":null,
                  "value":null,
                  "type":null,
                  "refId":null,
                  "attributes":[

                  ],
                  "relatedProperties":[
                     {
                        "id":"0",
                        "resource":null,
                        "value":null,
                        "type":"PersistentVolumeClaims",
                        "refId":null,
                        "attributes":[

                        ],
                        "relatedProperties":[
                           {
                              "id":"0",
                              "resource":null,
                              "value":"mysql-pv-claim",
                              "type":"PersistentVolumeClaims",
                              "refId":"31a2cad0-faf9-11e7-a523-42010a8a0251",
                              "attributes":[
                                 {
                                    "name":"namespace",
                                    "value":"default"
                                 }
                              ],
                              "relatedProperties":[
                                 {
                                    "id":"0",
                                    "resource":null,
                                    "value":null,
                                    "type":"spec",
                                    "refId":null,
                                    "attributes":[
                                       {
                                          "name":"storageClassName",
                                          "value":"standard"
                                       },
                                       {
                                          "name":"volumeName",
                                          "value":"pvc-31a2cad0-faf9-11e7-a523-42010a8a0251"
                                       },
                                       {
                                          "name":"storage",
                                          "value":"20Gi"
                                       },
                                       {
                                          "name":"accessModes",
                                          "values":[
                                             "ReadWriteOnce"
                                          ]
                                       }
                                    ],
                                    "relatedProperties":[

                                    ]
                                 },
                                 {
                                    "id":"0",
                                    "resource":null,
                                    "value":null,
                                    "type":"status",
                                    "refId":null,
                                    "attributes":[
                                       {
                                          "name":"phase",
                                          "value":"Bound"
                                       },
                                       {
                                          "name":"storage",
                                          "value":"20Gi"
                                       },
                                       {
                                          "name":"accessModes",
                                          "values":[
                                             "ReadWriteOnce"
                                          ]
                                       }
                                    ],
                                    "relatedProperties":[

                                    ]
                                 }
                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"testclaim",
                              "type":"PersistentVolumeClaims",
                              "refId":"414951a2-f3f5-11e7-a523-42010a8a0251",
                              "attributes":[
                                 {
                                    "name":"namespace",
                                    "value":"default"
                                 }
                              ],
                              "relatedProperties":[
                                 {
                                    "id":"0",
                                    "resource":null,
                                    "value":null,
                                    "type":"spec",
                                    "refId":null,
                                    "attributes":[
                                       {
                                          "name":"storageClassName",
                                          "value":"slow"
                                       },
                                       {
                                          "name":"volumeName",
                                          "value":null
                                       },
                                       {
                                          "name":"storage",
                                          "value":"8Gi"
                                       },
                                       {
                                          "name":"accessModes",
                                          "values":[
                                             "ReadWriteOnce"
                                          ]
                                       }
                                    ],
                                    "relatedProperties":[

                                    ]
                                 },
                                 {
                                    "id":"0",
                                    "resource":null,
                                    "value":null,
                                    "type":"status",
                                    "refId":null,
                                    "attributes":[
                                       {
                                          "name":"phase",
                                          "value":"Pending"
                                       }
                                    ],
                                    "relatedProperties":[

                                    ]
                                 }
                              ]
                           }
                        ]
                     }
                  ]
               }
            ],
            "size":1
         }
      },
      {
         "propertyType":"StorageClass",
         "propertyValue":{
            "properties":[
               {
                  "id":null,
                  "resource":null,
                  "value":null,
                  "type":null,
                  "refId":null,
                  "attributes":[

                  ],
                  "relatedProperties":[
                     {
                        "id":"0",
                        "resource":null,
                        "value":null,
                        "type":"StorageClass",
                        "refId":null,
                        "attributes":[

                        ],
                        "relatedProperties":[
                           {
                              "id":"0",
                              "resource":null,
                              "value":"gold",
                              "type":"StorageClass",
                              "refId":"d5650d3b-006c-11e8-a1dc-42010a800090",
                              "attributes":[
                                 {
                                    "name":"type",
                                    "value":"pd-ssd"
                                 },
                                 {
                                    "name":"provisioner",
                                    "value":"kubernetes.io/gce-pd"
                                 },
                                 {
                                    "name":"reclaimPolicy",
                                    "value":"Delete"
                                 }
                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"standard",
                              "type":"StorageClass",
                              "refId":"abbc3392-006b-11e8-a1dc-42010a800090",
                              "attributes":[
                                 {
                                    "name":"type",
                                    "value":"pd-standard"
                                 },
                                 {
                                    "name":"provisioner",
                                    "value":"kubernetes.io/gce-pd"
                                 },
                                 {
                                    "name":"reclaimPolicy",
                                    "value":"Delete"
                                 }
                              ],
                              "relatedProperties":[

                              ]
                           }
                        ]
                     }
                  ]
               }
            ],
            "size":1
         }
      },
      {
         "propertyType":"NameSpace",
         "propertyValue":{
            "properties":[
               {
                  "id":null,
                  "resource":null,
                  "value":null,
                  "type":null,
                  "refId":null,
                  "attributes":[

                  ],
                  "relatedProperties":[
                     {
                        "id":"0",
                        "resource":null,
                        "value":null,
                        "type":"NameSpace",
                        "refId":null,
                        "attributes":[

                        ],
                        "relatedProperties":[
                           {
                              "id":"0",
                              "resource":null,
                              "value":"default",
                              "type":"NameSpace",
                              "refId":"fdfcb613-f161-11e7-ab43-42010a8a0251",
                              "attributes":[

                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"kube-public",
                              "type":"NameSpace",
                              "refId":"0065ec3a-f162-11e7-ab43-42010a8a0251",
                              "attributes":[

                              ],
                              "relatedProperties":[

                              ]
                           },
                           {
                              "id":"0",
                              "resource":null,
                              "value":"kube-system",
                              "type":"NameSpace",
                              "refId":"fe5274a8-f161-11e7-ab43-42010a8a0251",
                              "attributes":[

                              ],
                              "relatedProperties":[

                              ]
                           }
                        ]
                     }
                  ]
               }
            ],
            "size":1
         }
      }
   ]
}

Request Attributes

id

The id attribute is specific to the CloudCenter platform and will be null in this API's response, as this is a direct call to the cloud provider, and the retrieved information is not persisted by the CloudCenter platform.

resource

The resource attribute is specific to the CloudCenter platform and will be null in this API's response, as this is a direct call to the cloud provider, and the retrieved information is not persisted by the CloudCenter platform.

propertyTypes
  • Description: The cloud property type for each cloud provider.

  • Type: Enumeration

    Cloud ProviderProperty Type
    EC2 (AWS)
    • AvailabilityZone

    • Vpc
    • Subnet
    • AccountAttributes
    Azure
    • AffinityGroup

    • VirtualNetwork
    • StorageAccount
    • ResourceGroup
    ACI (VMware)
    • BridgeDomains

    • ExternalNetworks
    • ServiceGraphTemplates
    Google
    • Project

    • LaunchZone
    • Network
    • Subnetwork
    OpenStack
    • AllTenants

    CloudStack
    • LaunchZone

    • Vpc

    Kubernetes (effective CloudCenter 4.9.0)

    • NameSpace

    • PersistentVolumeClaims

    • StorageClass

    General Properties
    • AvailableNetworks

    • PrivateFixedIPAllocationStrategies
    • PrivatePublicIPPairSupport
    • InstanceTypes
    • StorageTypes
    • Images
    • AccessKeyPairs
    • Volumes
    • PublicIPAllocationStrategies
    • PublicAccessStrategies
    • AvailablePublicIPs
    New cloud provider interface, get volume types also from properties service
    • VolumeTypes

    Opsource
    • NetworkDomain

    • NetworkDomainVLAN
    VMware
    • Datacenter

    • Cluster
    • Datastore
    Vcd
    • OrgNetworks

    • StoragePolicies
    • OrgVdc

cloudAccountId
  • Description: Unique, system-generated identifier for the cloudAccount

  • Type: String

vCloudOrgVdcName
  • Description: The vCloud organization vDC that you determined for this user when you performed the site assessment.
  • Type: String

Response Attributes

id


The id attribute is specific to the CloudCenter platform and will be null in this API's response, as this is a direct call to the cloud provider, and the retrieved information is not persisted by the CloudCenter platform.

resource

The resource attribute is specific to the CloudCenter platform and will be null in this API's response, as this is a direct call to the cloud provider, and the retrieved information is not persisted by the CloudCenter platform.

properties
  • Description: Information about the propertyType.

  • Type: Array of mapped attributes

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

    • Type: String

    resource
    • Description: Unique URL to access this resource.
    • Type: String

    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

    relatedProperties
    • Description: Additional properties for this resource
    • Type: Array of Name-Value Pairs


properties
  • Description: Information about the cloud properties.

  • Type: Array of mapped attributes

    propertyType
    • Description: The property type identified by the request payload's propertyTypes (v2) attribute.

    • Type: String

    propertyValue
    • Description: The information applicable to the propertyTypes(v2) specified in the request payload.

    • Type: Array of cloud property details

      properties
      • Description: Information about the propertyType.

      • Type: Array of mapped attributes

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

        • Type: String

        resource
        • Description: Unique URL to access this resource.
        • Type: String

        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

        relatedProperties
        • Description: Additional properties for this resource
        • Type: Array of Name-Value Pairs


      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


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