How Do I Retrieve Information About a Specific VMware Cloud Director Instance

You can retrieve information about a specific VMware Cloud Director instance by using the VMware Cloud Director service API.

Prerequisites

Verify that you are assigned the Provider Administrator or the Provider Support role.
Obtain an API token from the organization you want to manage and exchange it for an access bearer token. Use the bearer token in the Authorization header when you run API calls. See How Do I Generate an API Token.
Obtain the environment ID (URN). See How Do I Retrieve the List of Environments in My Organization.
Obtain the instance ID (URN). See How Do I Retrieve a List of All VMware Cloud Director Instances in Your Organization.

Procedure

♦ Run a GET request.
```
GET https://operatorUrl/environment/environmentUrn/instances/vcdInstanceUrn
```
Here operatorUrl is the operator URL, for example vcdc-operator-prod-us-west-2.vdp.vmware.com.

Results

The response returns information about the VMware Cloud Director instance deployed in the environment.

Example: Retrieve Information About a VMware Cloud Director Instance

This example retrieves information about a VMware Cloud Director instance deployed in the environment.

GET https://vcdc-operator-prod-us-west-2.vdp.vmware.com/environments/urn:vcdc:environment:00000000-0000-0000-0000-00000000000/instances/urn:vcdc:vcdInstance:fdf57f4e-e8a8-4b47-8820-70945db21aac

Use the bearer token in the Authorization header of the request.

Authorization: 
Bearer eyJh…I1NiIs

The response returns information about the VMware Cloud Director instance.

{
  "id": "urn:vcdc:vcdInstance:33333333-3333-3333-3333-33333333333",
  "name": "VMware-Cloud-Director-test",
  "templateId": "urn:vcdc:deploymentTemplate:11111111-1111-1111-1111-11111111111",
  "environmentId": "urn:vcdc:environment:00000000-0000-0000-0000-00000000000",
  "password": null,
  "domain": "vcd-3333333-3333-3333-3333-33333333333.vdp-prod-us-west-2.vmware.com",
  "instanceParams": null,
  "activeTask": {
    "id": "urn:vcdc:task:22222222-2222-2222-2222-22222222",
    "name": "Creating instance VMware-Cloud-Director-test",
    "entityId": "urn:vcdc:vcdInstance:3333333-3333-3333-3333-33333333333",
    "entityName": "VMware-Cloud-Director-test",
    "ownerId": "urn:vcdc:organization:12345678-1234-1234-1234-123456789abc",
    "userId": "[email protected]",
    "steps": "16/16",
    "status": "SUCCESS",
    "startTime": "2020-06-09T12:56:25.319742Z",
    "endTime": "2020-06-09T13:04:32.248292Z",
    "queuedTime": "2020-06-09T12:56:25.083499Z",
    "message": "",
    "output": {}
  },
  "environment": null,
  "environmentSettings": null,
  "statistics": []
}