Virtual Data Center:List All VDCs

Search (SHIFT+S)

ECS Management API

ECS Object Service API

ECS API Changes

List All VDCs

GET /object/vdcs/vdc/list

Gets all details of all configured VDCs.

Required Roles

Requires one of the following roles:

SYSTEM_ADMIN
SYSTEM_MONITOR
SECURITY_ADMIN

Response Body

List of VDC Information available in the system

Field	Description	Type	Notes
vdc_list
vdc			0-* Elements
vdcId	VDC id	String
vdcName	VDC name	String
interVdcEndPoints	VDC end points	String
interVdcCmdEndPoints	VDC cmd end points	String
secretKeys	Secret key for this VDC	String
permanentlyFailed	True of vdc is permanently failed, false otherwise.	Boolean
local	True of this vdc is local, false otherwise	Boolean
is_encryption_enabled	True of this vdc is enabled for encryption, false otherwise	Boolean
managementEndPoints	The management end points for the VDC	String
hosted		Boolean
name	Name assigned to this resource in ECS. The resource name is set by a user and can be changed at any time. It is not a unique identifier.	String
id	Identifier that is generated by ECS when the resource is created. The resource Id is guaranteed to be unique and immutable across all virtual data centers for all time.	URI	Valid Values: urn:storageos:resource-type:UUID:
link	Hyperlink to the details for this resource
creation_time	Timestamp that shows when this resource was created in ECS	DateTime	Valid Values: YYYY-MM-DDTHH:mm:ssZ Unix timestamp
inactive	Indicates whether the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ECS database.	Boolean	Valid Values: true false
global	Indicates whether the resource is global.	Boolean	Valid Values: true false
remote	Indicates whether the resource is remote.	Boolean	Valid Values: true false
vdc
id	ECS Id of the related object	URI
link	Hyperlink to the related object
internal	Indicated whether the resource is an internal resource	Boolean	Valid Values: true false

Examples

Request

GET https://192.168.0.0:4443/object/vdcs/vdc/list HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vdc_list>
    <vdc>
        <id>urn:storageos:VirtualDataCenterData:04af4230-fcc3-4555-aaac-a23fbdd542a2</id>
        <inactive>false</inactive>
        <link rel="self" href="/object/vdcs/vdc/vdc1"/>
        <name>vdc1</name>
        <tags/>
        <interVdcEndPoints>10.247.179.238</interVdcEndPoints>
        <permanentlyFailed>false</permanentlyFailed>
        <secretKeys>12345</secretKeys>
        <vdcId>urn:storageos:VirtualDataCenterData:04af4230-fcc3-4555-aaac-a23fbdd542a2</vdcId>
        <vdcName>vdc1</vdcName>
    </vdc>
</vdc_list>

Request

GET https://192.168.0.0:4443/object/vdcs/vdc/list.json HTTP/1.1

Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "vdc": [
        {
            "name": "vdc1",
            "id": "urn:storageos:VirtualDataCenterData:04af4230-fcc3-4555-aaac-a23fbdd542a2",
            "link": {
                "rel": "self",
                "href": "/object/vdcs/vdc/vdc1"
            },
            "inactive": false,
            "global": null,
            "remote": null,
            "vdc": null,
            "tags": [],
            "vdcId": "urn:storageos:VirtualDataCenterData:04af4230-fcc3-4555-aaac-a23fbdd542a2",
            "vdcName": "vdc1",
            "interVdcEndPoints": "10.247.179.238",
            "secretKeys": "12345",
            "permanentlyFailed": false
        }
    ]
}