Get Nsx V Cloud Account

Get Nsx V Cloud Account

Get an NSX-V cloud account with a given id

Request
URI
GET
https://{api_host}/iaas/api/cloud-accounts-nsx-v/{id}
COPY
Path Parameters
string
id
Required

The ID of the Cloud Account

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


Responses
200

successful operation

Returns CloudAccountNsxV of type(s) application/json
{
    "id": "9e49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "organizationId": "deprecated",
    "orgId": "9e49",
    "name": "my-name",
    "description": "my-description",
    "hostName": "nsxv.vmware.com",
    "dcid": "23959a1e-18bc-4f0c-ac49-b5aeb4b6eef4",
    "username": "[email protected]",
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ]
}
string
id
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
tags
Optional

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


403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure