CliQr is now part of Cisco Learn More About Cisco

Validate Workflow

Details

API Details
Name

Validate Workflow

DescriptionValidates a workflow parameter for the Cisco UCSD.
MethodPOST
URI

/v1/apps/validations?serviceTierId=serviceTierId&depEnvId=depEnvId&cloudId=cloudId

CloudCenter Release
  • CloudCenter 3.x and 4.x
  • Enhanced in CloudCenter 3.2.6.6. to include the additionalParameters attribute
Notes
ESB Headeraction: create.apps.validations
actionparam: serviceTierId=serviceTierId&depEnvId=depEnvId&cloudId=cloudId

Example

curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/apps/validations?serviceTierId=CiscoUCSD-65&depEnvId=1&cloudId=UCSD-default" 

Response

The API suspends the VMs launched for this job:

Use the Get Operation Status to view the current status and continue trying until you eventually receive the following response once the parameters are validated:

Request Attributes

serviceTierId
  • Description: Type of application tier (for example, Loadbalancer, database, AppCluster, or other tiers). This value is a concatenation of the Application Profile Type Name and the App ID.
    • First job serviceTierId = appName + "-" +appId

    • Child tier serviceTierId = tierName + "-" +appId

  • 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

cloudId
  • Description: Unique identifier for this cloud representation.

    Icon

    You can obtain this information from the View Deployment Environments API.

  • 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

msg
  • Description: A response message reflecting the status of the operation.
  • Type: String
additionalParameters
  • Description: Parameters required to deploy the application
  • Type: Object