Update Nsx V Cloud Account | vRealize Automation Cloud Infrastructure as a Service (IaaS) API

Update Nsx V Cloud Account

Update NSX-V cloud account

Request

URI

PATCH

https://{api_host}/iaas/api/cloud-accounts-nsx-v/{id}

COPY

Path Parameters

string

Required

Cloud account id

Query Parameters

string

apiVersion

Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about

Request Body

NSX-V cloud account details to be updated

UpdateCloudAccountSpecificationBase of type(s) application/json

Required

{
    "description": "string",
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

string

description

Optional

A human-friendly description.

array of Tag

tags

Optional

A set of tag keys and optional values to set on the Cloud Account

Responses

200

successful operation

Returns CloudAccountNsxV of type(s) application/json

{
    "id": "9e49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "csp@vmware.com",
    "organizationId": "deprecated",
    "orgId": "9e49",
    "name": "my-name",
    "description": "my-description",
    "hostName": "nsxv.vmware.com",
    "dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
    "username": "administrator@mycompany.com",
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}

string

Required

The id of this resource instance

string

createdAt

Optional

Date when the entity was created. The date is in ISO 6801 and UTC.

string

updatedAt

Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string

owner

Optional

Email of the user that owns the entity.

string

organizationId

Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string

orgId

Optional

The id of the organization this entity belongs to.

object

_links

Required

HATEOAS of the entity

string

name

Optional

A human-friendly name used as an identifier in APIs that support this option.

string

description

Optional

A human-friendly description.

string

hostName

Required

Host name for the Nsx-V cloud account

string

dcid

Optional

Identifier of a data collector vm deployed in the on premise infrastructure.

string

username

Required

Username to authenticate with the cloud account

object

customProperties

Optional

Additional properties that may be used to extend the base type.

array of Tag