Query Vcd Instances For Org | Cloud Director Service Environment API

Query Vcd Instances For Org

Get list of vCD instances in CSP organization.

This API is available to provider admins and support users.

Request

URI

GET

https://{environmentid}.cloud.vmware.com//environment/{environmentId}/organization/{organizationId}/instances

COPY

Path Parameters

string

environmentId

Required

URN ID of an Environment

string

organizationId

Required

URN ID of an organization

Query Parameters

string

filter

Optional

Filter for a query.

string

sortBy

Optional

Sort by field.

string

sortDir

Optional

The direction of sort

Possible values are : asc, desc,

integer

page

Optional

Page to fetch, ((page - 1) * pageSize) offset.

integer

limit

Optional

limit

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

A paged array of vCD instances

Returns VcdInstances of type(s) application/json

This response body class contains all of the following: Page , VcdInstances_allOf

{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "valueType": "string",
    "values": [
        {
            "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"
        }
    ]
}