CliQr is now part of Cisco Learn More About Cisco

View Deployment Environments

Details

API Details
NameView Deployment Environment(s)
Description

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

MethodGET
URI
  • v1/environments 
  • v1/environments/depEnvId
CloudCenter Release
  • Introduced in CloudCenter 3.2.5.
  • Updated to work with CloudCenter 4.x. See Create Deployment Environment for additional details.
  • 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 – see Deployment Environments for additional context.
    • Includes the regionId of each associated cloud account.
    • Contains new sections called cloudAssociationDefaults and default.
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.
ESB Header
  • action: get.environments 
  • action: get. environments.depEnvId

Example

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

Response

Request Attributes

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

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 

     totalAppCost 
    • Description: The total cost of using metered applications. See Cost and Fees and Markterplace Application Fee 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