Get Environment 2

Get Environment 2

Get a deployed LCM environment by ID.

Request
URI
GET
https://10.71.204.121:9443/api/v1/lcm/environment/{environmentId}
COPY
Path Parameters
string
environmentId
Required

ID of the environment


Responses
200

Details of LCM environment.

Returns EnvironmentSpec of type(s) */*
{
    "environmentName": "string",
    "environmentId": "string",
    "environmentState": "string",
    "products": [
        {
            "productType": "string",
            "productId": "string",
            "version": "string",
            "buildNumber": "string",
            "productInternalId": "string",
            "license": "string",
            "adminPassword": "string",
            "integrations": [
                {
                    "integrationId": "string",
                    "integrationUsername": "string",
                    "integrationPassword": "string",
                    "status": "string",
                    "ref": "string",
                    "version": "string"
                }
            ],
            "infraReference": "string",
            "nodes": [
                {
                    "nodeId": "integer",
                    "isPrimary": "boolean",
                    "cpuNum": "integer",
                    "ramMemory": "integer",
                    "hostName": "string",
                    "vmName": "string",
                    "deploymentOption": "string",
                    "datastoreName": "string",
                    "clusterName": "string",
                    "resourcePool": "string",
                    "datacenterName": "string",
                    "rootPassword": "string",
                    "gateway": "string",
                    "nics": [
                        {
                            "ipAddress": "string",
                            "networkName": "string",
                            "staticRoutes": [
                                "string"
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
object
properties
Optional

Additional properties

string
environmentName
Required

Name of an environment. If no ID is specified, this name will be normalized and used as ID.

string As [a-zA-Z0-9_\-.]{3,}
environmentId
Optional

ID of an environment.

string
environmentState
Optional

The state of the environment - will be discovered by VCP LCM.

object
deploymentInfrastructures
Required

The deployment infrastructure defining the target infrastructure to deploy in.

products
Required

products


401

Unauthorized access

Returns EnvironmentSpec of type(s) */*
{
    "environmentName": "string",
    "environmentId": "string",
    "environmentState": "string",
    "products": [
        {
            "productType": "string",
            "productId": "string",
            "version": "string",
            "buildNumber": "string",
            "productInternalId": "string",
            "license": "string",
            "adminPassword": "string",
            "integrations": [
                {
                    "integrationId": "string",
                    "integrationUsername": "string",
                    "integrationPassword": "string",
                    "status": "string",
                    "ref": "string",
                    "version": "string"
                }
            ],
            "infraReference": "string",
            "nodes": [
                {
                    "nodeId": "integer",
                    "isPrimary": "boolean",
                    "cpuNum": "integer",
                    "ramMemory": "integer",
                    "hostName": "string",
                    "vmName": "string",
                    "deploymentOption": "string",
                    "datastoreName": "string",
                    "clusterName": "string",
                    "resourcePool": "string",
                    "datacenterName": "string",
                    "rootPassword": "string",
                    "gateway": "string",
                    "nics": [
                        {
                            "ipAddress": "string",
                            "networkName": "string",
                            "staticRoutes": [
                                "string"
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
object
properties
Optional

Additional properties

string
environmentName
Required

Name of an environment. If no ID is specified, this name will be normalized and used as ID.

string As [a-zA-Z0-9_\-.]{3,}
environmentId
Optional

ID of an environment.

string
environmentState
Optional

The state of the environment - will be discovered by VCP LCM.

object
deploymentInfrastructures
Required

The deployment infrastructure defining the target infrastructure to deploy in.

products
Required

products


404

Requested environment not found

Returns EnvironmentSpec of type(s) */*
{
    "environmentName": "string",
    "environmentId": "string",
    "environmentState": "string",
    "products": [
        {
            "productType": "string",
            "productId": "string",
            "version": "string",
            "buildNumber": "string",
            "productInternalId": "string",
            "license": "string",
            "adminPassword": "string",
            "integrations": [
                {
                    "integrationId": "string",
                    "integrationUsername": "string",
                    "integrationPassword": "string",
                    "status": "string",
                    "ref": "string",
                    "version": "string"
                }
            ],
            "infraReference": "string",
            "nodes": [
                {
                    "nodeId": "integer",
                    "isPrimary": "boolean",
                    "cpuNum": "integer",
                    "ramMemory": "integer",
                    "hostName": "string",
                    "vmName": "string",
                    "deploymentOption": "string",
                    "datastoreName": "string",
                    "clusterName": "string",
                    "resourcePool": "string",
                    "datacenterName": "string",
                    "rootPassword": "string",
                    "gateway": "string",
                    "nics": [
                        {
                            "ipAddress": "string",
                            "networkName": "string",
                            "staticRoutes": [
                                "string"
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}
object
properties
Optional

Additional properties

string
environmentName
Required

Name of an environment. If no ID is specified, this name will be normalized and used as ID.

string As [a-zA-Z0-9_\-.]{3,}
environmentId
Optional

ID of an environment.

string
environmentState
Optional

The state of the environment - will be discovered by VCP LCM.

object
deploymentInfrastructures
Required

The deployment infrastructure defining the target infrastructure to deploy in.

products
Required

products