Update Vcd Instance

Update Vcd Instance

Update a VCD instance.

This API is available to provider admins.

Request
URI
PUT
https://{environmentid}.cloud.vmware.com//environment/{environmentId}/instances/{vcdInstanceId}
COPY
Path Parameters
string
environmentId
Required

URN ID of an Environment

string
vcdInstanceId
Required

URN id of vCD instance

Request Body
VcdInstance of type(s) application/json
Required 
{
    "id": "string",
    "name": "string",
    "ownerId": "string",
    "environmentId": "string",
    "password": "string",
    "domain": "string",
    "publicCertificate": "string",
    "activeTask": {
        "id": "string",
        "name": "string",
        "entityId": "string",
        "entityName": "string",
        "ownerId": "string",
        "userId": "string",
        "steps": "string",
        "status": "string",
        "startTime": "string",
        "endTime": "string",
        "queuedTime": "string",
        "message": "string",
        "isolation": "string",
        "output": {
            "providerAdminUsername": "administrator",
            "providerAdminPassword": "mysecretpassword"
        },
        "activity": "string"
    },
    "environment": {
        "name": "name",
        "location": "us-west-2",
        "id": "id",
        "url": "url"
    },
    "environmentSettings": [
        {
            "id": "string",
            "name": "string",
            "type": "string",
            "subType": "string"
        }
    ],
    "statistics": [
        {
            "type": "string",
            "value": "number",
            "max": "number"
        }
    ],
    "upgradeAfter": "string",
    "upgradeCategory": "string",
    "oauthClientId": "string"
}
string
id
Optional

URN ID of vCD instance. This is immutable.

string
name
Optional

Name of vCD instance.

string
ownerId
Optional

URN ID of the organization for this task.

string
environmentId
Optional

URN ID of environment. This is immutable.

string As password As ((?=.*[a-z])(?=.*\d)(?=.*[ !#$%&\(\)*+,-./:;<=>?@\[\\\]^_`{\|}~])(?=.*[A-Z]).{6,128})
password
Optional

Provider administrator password for vCD instance. Password must follow the following rules:

  1. At least one lowercase letter.
  2. At least one digit i.e. 0-9.
  3. At least one special character
  4. At least one capital letter.
  5. Minimum 6 letters to maximum 128 This value is input only, the password cannot be retrieved via the API.
string As ^$|^((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}$
domain
Optional

The public domain of the instance (e.g. vcd.acme.example).

object
instanceParams
Optional

Free-form configuration object.

string
publicCertificate
Optional

Base64 encoded public certificate associated with this instance.

Task
activeTask
Optional

activeTask

Environment
environment
Optional

environment

array of VcdInstanceResource
environmentSettings
Optional

environmentSettings

array of VcdInstanceStatistic
statistics
Optional

statistics

string As date-time As date-time
upgradeAfter
Optional

Date which upgrade should be performed after

string
upgradeCategory
Optional

Category that defines the upgrade strategy

string
oauthClientId
Optional

ID of Oauth Client used by the instance's system org. Null if the instance's system org hasn't been integrated with CSP.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VcdInstance of type(s) application/json 
{
    "id": "string",
    "name": "string",
    "ownerId": "string",
    "environmentId": "string",
    "password": "string",
    "domain": "string",
    "publicCertificate": "string",
    "activeTask": {
        "id": "string",
        "name": "string",
        "entityId": "string",
        "entityName": "string",
        "ownerId": "string",
        "userId": "string",
        "steps": "string",
        "status": "string",
        "startTime": "string",
        "endTime": "string",
        "queuedTime": "string",
        "message": "string",
        "isolation": "string",
        "output": {
            "providerAdminUsername": "administrator",
            "providerAdminPassword": "mysecretpassword"
        },
        "activity": "string"
    },
    "environment": {
        "name": "name",
        "location": "us-west-2",
        "id": "id",
        "url": "url"
    },
    "environmentSettings": [
        {
            "id": "string",
            "name": "string",
            "type": "string",
            "subType": "string"
        }
    ],
    "statistics": [
        {
            "type": "string",
            "value": "number",
            "max": "number"
        }
    ],
    "upgradeAfter": "string",
    "upgradeCategory": "string",
    "oauthClientId": "string"
}
string
id
Optional

URN ID of vCD instance. This is immutable.

string
name
Optional

Name of vCD instance.

string
ownerId
Optional

URN ID of the organization for this task.

string
environmentId
Optional

URN ID of environment. This is immutable.

string As password As ((?=.*[a-z])(?=.*\d)(?=.*[ !#$%&\(\)*+,-./:;<=>?@\[\\\]^_`{\|}~])(?=.*[A-Z]).{6,128})
password
Optional

Provider administrator password for vCD instance. Password must follow the following rules:

  1. At least one lowercase letter.
  2. At least one digit i.e. 0-9.
  3. At least one special character
  4. At least one capital letter.
  5. Minimum 6 letters to maximum 128 This value is input only, the password cannot be retrieved via the API.
string As ^$|^((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}$
domain
Optional

The public domain of the instance (e.g. vcd.acme.example).

object
instanceParams
Optional

Free-form configuration object.

string
publicCertificate
Optional

Base64 encoded public certificate associated with this instance.

Task
activeTask
Optional

activeTask

Environment
environment
Optional

environment

array of VcdInstanceResource
environmentSettings
Optional

environmentSettings

array of VcdInstanceStatistic
statistics
Optional

statistics

string As date-time As date-time
upgradeAfter
Optional

Date which upgrade should be performed after

string
upgradeCategory
Optional

Category that defines the upgrade strategy

string
oauthClientId
Optional

ID of Oauth Client used by the instance's system org. Null if the instance's system org hasn't been integrated with CSP.


400

Bad Request

Returns Error of type(s) application/json
This response body class contains all of the following: BaseError , Error_allOf 
{
    "0": "E",
    "1": "r",
    "2": "r",
    "3": "o",
    "4": "r",
    "5": "_",
    "6": "a",
    "7": "l",
    "8": "l",
    "9": "O",
    "10": "f",
    "11": " ",
    "12": "O",
    "13": "b",
    "14": "j",
    "15": "e",
    "16": "c",
    "17": "t",
    "code": "string",
    "messageParameters": [
        {}
    ],
    "message": "string",
    "localizedMessage": "string"
}

404

Not Found

Returns Error of type(s) application/json
This response body class contains all of the following: BaseError , Error_allOf 
{
    "0": "E",
    "1": "r",
    "2": "r",
    "3": "o",
    "4": "r",
    "5": "_",
    "6": "a",
    "7": "l",
    "8": "l",
    "9": "O",
    "10": "f",
    "11": " ",
    "12": "O",
    "13": "b",
    "14": "j",
    "15": "e",
    "16": "c",
    "17": "t",
    "code": "string",
    "messageParameters": [
        {}
    ],
    "message": "string",
    "localizedMessage": "string"
}

On This Page
Instances Operations
POST
Create Vcd Instance
DELETE
Delete Vcd Instance
GET
Get Vcd Instance
GET
Get Vcd Instance Operations
POST
Invoke Operation
POST
Invoke Vcd Instance Operation
GET
List Operations
GET
Query Vcd Instances For Org
PUT
Update Vcd Instance
POST
Validate Vcd Instance Operation