View Deployment Environments

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameView Deployment Environment(s)
Description

Displays information for all Deployment Environment or for a specified deployment environment

Allowed Role(s)WM_USER
MethodGET
URI
  • v1/environments 
  • v1/environments/depEnvId
  • cloudcenter-ccm-backend/api/v1/environments 
  • cloudcenter-ccm-backend/api/v1/environments/depEnvId
Sample Request
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/environments/5"
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/environments/5"
Release
  • Introduced in CloudCenter 3.2.5
  • Enhanced in CloudCenter 4.2 to include the cloudId, totalDeployments, and costDetails attributes and to reflect a modified associatedClouds attribute
  • Enhanced in CloudCenter 4.4 to reflect a modified associatedClouds attribute:
    • Dee the Deployment Environments section for the relevant release for additional context
    • Includes the regionId of each associated cloud account
    • Contains new sections called cloudAssociationDefaults and default
  • Enhanced in CloudCenter 4.8.2 to include the extensionId attribute – see the Configuring ServiceNow Extensions section for the relevant release for additional context
  • Enhanced in CloudCenter 4.10.0 to include policy attributes as part of the tagless governance feature (Sample 2).

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

ESB Header

  • action: get.environments 
  • action: get. environments.depEnvId

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

Not applicable

Sample 1 Response

{
    "id": "1",
    "resource": "https://<HOST>:<PORT>/v1/environments/1/",
    "perms": [
        "read",
        "delete",
        "execute",
        "write",
        "administration",
        "authorize",
        "move_out",
        "approve",
        "move_in",
        "manage"
    ],
    "name": "AllClouds",
    "description": "",
    "allowedClouds": null,
    "defaultSettings": "{\"defaultCloud\":\"Openstack-na-west1\",
\"defaultInstanceType\":\"5073b9a8-....-....-....-..................\"}",
    "extensionId": "15",
    "requiresApproval": false,
    "associatedClouds": [
        {
            "regionId": "1",
            "regionName": "Openstack-na-west1",
            "regionDisplayName": "North America West",
            "cloudFamily": "Openstack",
            "cloudId": "1",
            "cloudAccountId": "1",
            "cloudName": "Openstack",
            "cloudAccountName": "ClAcc1",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "TenantId",
                    "value": "9ecc4e427d9844.................."
                }, 
                {
                    "name": "TenantName",
                    "value": "archana"
                }, 
                {
                    "name": "networkId",
                    "value": "ae358c6c-....-....-....-............"

                }, 
                {
                    "name": "privateIPAllocationMode",
                    "value": "DHCP"
                },
                {
                    "name": "networkName",
                    "value": "saad-net01"
                }
            ],
            "default": true
        }, 
        {
            "regionId": "1",
            "regionName": "Openstack-na-west1",
            "regionDisplayName": "North America West",
            "cloudFamily": "Openstack",
            "cloudId": "1",
            "cloudAccountId": "2",
            "cloudName": "Openstack",
            "cloudAccountName": "ClAcc2",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "TenantId",
                    "value": "9ecc4e427d98441faeda6cc90decaac1"
                },
                {
                    "name": "TenantName",
                    "value": "archana"
                },
                {
                    "name": "networkId",
                    "value": "acb2b98e-ad27-4dcf-9ec2-78c66b852cf3"
                },
                {
                    "name": "privateIPAllocationMode",
                    "value": "DHCP"
                },
                {
                    "name": "networkName",
                    "value": "archana-net01"
                }
            ],
            "default": false
        }, 
        {
            "regionId": "2",
            "regionName": "VMware-Dev1",
            "regionDisplayName": "Dev1",
            "cloudFamily": "Vmware",
            "cloudId": "2",
            "cloudAccountId": "3",
            "cloudName": "VMware",
            "cloudAccountName": "archana",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "UserClusterName",
                    "value": "test"
                },
                {
                    "name": "networkId",
                    "value": "1015-SE (CliQrDSwitch)"
                },
                {
                    "name": "UserTargetDeploymentFolder",
                    "value": "/Archana"
                },
                {
                    "name": "UserDataCenterName",
                    "value": "SCL2"
                },
                {
                    "name": "privateIPAllocationMode",
                    "value": ""
                },
                {
                    "name": "networkName",
                    "value": "1015-SE (CliQrDSwitch)"
                },
                {
                    "name": "UserDatastoreCluster",
                    "value": "QA-DS-cluster"
                }
            ],
            "default": true
        }, {

            "regionId": "3",
            "regionName": "AWSCloud-us-east-1",
            "regionDisplayName": "US East (Virginia)",
            "cloudFamily": "Amazon",
            "cloudId": "4",
            "cloudAccountId": "5",
            "cloudName": "AWSCloud",
            "cloudAccountName": "QA_AWS",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "vpcId",
                    "value": "vpc-3e41595b"
                },
                {
                    "name": "networkId",
                    "value": "subnet-1fafee46"
                }, 
                {
                    "name": "availabilityZoneId",
                    "value": "us-east-1a"
                }, 
                {
                    "name": "subnetId",
                    "value": "subnet-1fafee46"
                }, {

                    "name": "privateIPAllocationMode",
                    "value": "DHCP"
                },
                {
                    "name": "networkName",
                    "value": "subnet-1fafee46 | CIDR: 10.1.1.0/2"
                }
            ],
            "default": true
        },
        {
            "regionId": "2",
            "regionName": "VMware-Dev1",
            "regionDisplayName": "Dev1",
            "cloudFamily": "Vmware",
            "cloudId": "2",
            "cloudAccountId": "10",
            "cloudName": "VMware",
            "cloudAccountName": "sanand",
            "cloudAssociationDefaults": [],
            "default": false
        }
    ],
    "totalDeployments": 0,
    "costDetails": null
}

Sample 2 Response (Tagless Governance)

{
   "id":"13",
   "resource":"https://<HOST>:<PORT>/v1/environments/13/",
   "perms":[
      "administration",
      "approve",
      "manage",
      "move_out",
      "move_in",
      "write",
      "execute",
      "read",
      "authorize",
      "delete"
   ],
   "name":"MyDepEnv57Update",
   "description":"MyDepEnv57Update",
   "defaultSettings":"",
   "owner":2,
   "requiresApproval":false,
   "associatedClouds":[
      {
         "regionId":"1",
         "regionName":"OpenStack-RegionOne",
         "regionDisplayName":"RegionOne",
         "cloudFamily":"Openstack",
         "cloudId":"1",
         "cloudAccountId":"1",
         "cloudName":"OpenStack",
         "cloudAccountName":"OpenStackAccount",
         "networkSettings":[

         ],
         "defaultInstance":null,
         "defaultSshKey":null,
         "basicSettings":[

         ],
         "preference":"VISIBLE_UNLOCKED",
         "defaultCloudSettings":[

         ],
         "enableResourcePlacement":false,
         "enableResourceValidation":false,
         "resourcePlacementScript":null,
         "resourceValidationScript":null,
         "calloutPackage":null,
         "cloudAssociationDefaults":[

         ],
         "default":true
      }
   ],
   "totalDeployments":0,
   "costDetails":null,
   "networkTypes":[

   ],
   "networkTypeEnabled":false,
   "restrictedUser":false,
   "defaultRegionId":"1",
   "extensionId":null,
   "extension":null,
   "policySettings":{
      "agingPolicySettings":{
         "visibleState":"VISIBLE_ENABLED",
         "allPolicies":false,
         "mandatory":false,
         "policies":[
            {
               "policyId":1,
               "policy":{
                  "id":"1",
                  "resource":"https://<HOST>:<PORT>/v2/agingPolicies/1",
                  "name":"MyAgingPolicy",
                  "description":"",
                  "enabled":true,
                  "type":"TIME",
                  "limit":{
                     "amount":1,
                     "unit":"MONTHS"
                  },
                  "terminateWhenPolicyEnds":false,
                  "allowGracePeriodForTermination":false,
                  "graceLimit":null,
                  "allowPolicyExtension":false,
                  "extensionLimit":null,
                  "allowGracePeriodNotification":false,
                  "allowPolicyExpiryNotification":false,
                  "notifications":[

                  ],
                  "isPolicyActiveOnResources":false,
                  "created":1519864287534,
                  "lastUpdated":1519864287534,
                  "resources":[

                  ],
                  "priority":1,
                  "ownerId":2
               },
               "default":true
            },
            {
               "policyId":2,
               "policy":{
                  "id":"2",
                  "resource":"https://<HOST>:<PORT>/v2/agingPolicies/2",
                  "name":"MyAgingPolicy2",
                  "description":"",
                  "enabled":true,
                  "type":"TIME",
                  "limit":{
                     "amount":1,
                     "unit":"MONTHS"
                  },
                  "terminateWhenPolicyEnds":false,
                  "allowGracePeriodForTermination":false,
                  "graceLimit":null,
                  "allowPolicyExtension":false,
                  "extensionLimit":null,
                  "allowGracePeriodNotification":false,
                  "allowPolicyExpiryNotification":false,
                  "notifications":[

                  ],
                  "isPolicyActiveOnResources":false,
                  "created":1519864644672,
                  "lastUpdated":1519864644672,
                  "resources":[

                  ],
                  "priority":2,
                  "ownerId":2
               },
               "default":false
            },
            {
               "policyId":3,
               "policy":{
                  "id":"3",
                  "resource":"https://<HOST>:<PORT>/v2/agingPolicies/3",
                  "perms":[
                     "administration",
                     "write",
                     "read",
                     "delete"
                  ],
                  "name":"MyAging",
                  "description":"MyAging",
                  "enabled":true,
                  "type":"TIME",
                  "limit":{
                     "amount":1,
                     "unit":"MONTHS"
                  },
                  "terminateWhenPolicyEnds":false,
                  "allowGracePeriodForTermination":false,
                  "graceLimit":null,
                  "allowPolicyExtension":false,
                  "extensionLimit":null,
                  "allowGracePeriodNotification":false,
                  "allowPolicyExpiryNotification":false,
                  "notifications":[

                  ],
                  "isPolicyActiveOnResources":false,
                  "created":1521609028467,
                  "lastUpdated":1521609028467,
                  "resources":[

                  ],
                  "priority":3,
                  "ownerId":2
               },
               "default":false
            }
         ]
      },
      "suspensionPolicySettings":{
         "visibleState":"VISIBLE_ENABLED",
         "allPolicies":false,
         "mandatory":false,
         "policies":[
            {
               "policyId":1,
               "policy":{
                  "id":"1",
                  "resource":"https://<HOST>:<PORT>/v2/suspensionPolicies/1",
                  "name":"MySuspensionPolicy",
                  "description":"",
                  "enabled":true,
                  "schedules":[
                     {
                        "type":"DAILY",
                        "days":[

                        ],
                        "startTime":"08:00",
                        "endTime":"17:00",
                        "repeats":"1"
                     }
                  ],
                  "blockoutPeriods":[

                  ],
                  "isPolicyActiveOnResources":false,
                  "resourcesMaps":[

                  ],
                  "priority":1,
                  "created":1519864307976,
                  "lastUpdated":1519864307976,
                  "ownerId":2
               },
               "default":true
            },
            {
               "policyId":2,
               "policy":{
                  "id":"2",
                  "resource":"https://<HOST>:<PORT>/v2/suspensionPolicies/2",
                  "name":"sadfas",
                  "description":"",
                  "enabled":true,
                  "schedules":[
                     {
                        "type":"DAILY",
                        "days":[

                        ],
                        "startTime":"08:00",
                        "endTime":"17:00",
                        "repeats":"1"
                     }
                  ],
                  "blockoutPeriods":[

                  ],
                  "isPolicyActiveOnResources":false,
                  "resourcesMaps":[

                  ],
                  "priority":2,
                  "created":1521516000221,
                  "lastUpdated":1521516000221,
                  "ownerId":2
               },
               "default":false
            }
         ]
      },
      "securityPolicySettings":{
         "visibleState":"VISIBLE_ENABLED",
         "mandatory":false,
         "policies":[
            {
               "policyId":1,
               "policy":{
                  "id":"1",
                  "resource":"https://<HOST>:<PORT>/v1/securityProfiles/1",
                  "perms":[
                     "administration",
                     "write",
                     "read",
                     "delete"
                  ],
                  "name":"mysecurityprofile",
                  "description":"",
                  "securityProfileRules":[
                     {
                        "fromPort":1234,
                        "toPort":5678,
                        "comment":"",
                        "protocol":"TCP",
                        "ruleType":"INBOUND",
                        "remoteType":"CIDR",
                        "sourceIps":[
                           "0.0.0.0/0"
                        ],
                        "id":1
                     }
                  ]
               },
               "locked":true,
               "default":true
            },
            {
               "policyId":2,
               "policy":{
                  "id":"2",
                  "resource":"https://<HOST>:<PORT>/v1/securityProfiles/2",
                  "perms":[
                     "administration",
                     "write",
                     "read",
                     "delete"
                  ],
                  "name":"dsfa",
                  "description":"",
                  "securityProfileRules":[
                     {
                        "fromPort":1234,
                        "toPort":5678,
                        "comment":"",
                        "protocol":"TCP",
                        "ruleType":"INBOUND",
                        "remoteType":"CIDR",
                        "sourceIps":[
                           "0.0.0.0/0"
                        ],
                        "id":2
                     }
                  ]
               },
               "locked":false,
               "default":false
            }
         ]
      },
      "allowTerminateProtection":true
   }
}

Request Attributes

depEnvId
  • DescriptionUnique, system-generated identifier for the deployment environment. See the Deployment Environments section for the relevant release for additional details. This attribute is the same as the environmentId attribute.

  • 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 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
allowedClouds
  • Description: Identifies cloud infrastructures under the cloud accounts set up and shared by their parent tenant. If the tenant does not have any restriction, this attribute displays "null" to indicate the lack of restrictions.
  • Type: String
defaultSettings
  • Description: The default settings for the deployment environment
  • Type: String
requiresApproval
  • Description: A flag to indicate if approval is required to deploy in this environment
  • Type: Boolean

associatedClouds (click for additional details)

totalDeployments
  • Description: The total number of deployments associated with this deployment environment
  • Type: Long

costDetails
  • Description: A breakdown of multiple costs associated with this cloud.
  • Type: Sequence of cost details

     totalCloudCost 
    • Description: The cloud infrastructure costs charged by the cloud provider. See the Supported Public Clouds or the Supported Datacenters and Private Clouds section for the relevant release for all deployments, runs, users, VMs, instance types, and so forth. See the CloudCenter Cost and Fees section for the relevant release for additional context.
    • Type: Float

     totalAppCost 
    • Description: The total cost of using metered applications. See the CloudCenter Cost and Fees section and the Markterplace Application Fee section for the relevant release for additional context.
    • Type: Float
     totalJobsCost 
    • Description: The total cost associated with the cloud for a particular job, the management cost associated with the jobs run to date.
    • Type: Float

 networkTypes
  • Description: Identifies the network mapping details for the simplified networks features. See Deployment Environments and Cloud Network Settings for additional context.

  • Type: Sequence of network type 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
     numberOfNetworkMapped
    • Description: Identifies the number of cloud accounts that are set up and mapped to the network types – within the configured simplified networks.
    • Type: Long

networkTypeEnabled
  • Description: Identifies if the simplified network feature is enabled for this deployment environment. See Deployment Environments for additional context.
  • Type: Boolean:
    • true = Simplified networks is not enabled.
    • false = Default. Simplified networks is enabled.

restrictedUser
  • Description: Indicates whether users/tenants are restricted to performing tasks, using resources, and viewing configurations.
  • Type: Boolean
    • true = The user is restricted.
    • false = Default. The user is not restricted.

defaultRegionId
  • DescriptionUnique, system-generated identifier for the region
  • Type: String

extensionId
  • DescriptionUnique, system-generated identifier for the extension. See the Extensions section for the relevant release for additional details.
  • Type: String

extension
  • Description: Identifies the type of extension and associated details. See the Extensions section for the relevant release for additional details.
  • Type: Sequence of details about this extension type

policySettings (click for additional details)
© 2017-2019 Cisco Systems, Inc. All rights reserved