[an error occurred while processing this directive]
Virtual Data Center:Get VDC By Name

Search (SHIFT+S)




New in this release

Get VDC By Name

GET /object/vdcs/vdc/{vdcName}

Gets the details for a VDC the identify of which is specified by its name.

vdcNameVDC name for which VDC Information is to be retrieved

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR


Prerequisites

The following conditions must be met in order to call this operation.

  • VDC must exist


Response Body

VDC information for the specified name

Field Description Type Notes
<vdc>
<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
<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
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<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
</vdc>      
<internal> Indicated whether the resource is an internal resource Boolean Valid Values:
  •  true
  •  false
</vdc>

Examples

Request
GET https://192.168.0.0:4443/object/vdcs/vdc/vdc1 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>
    <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>
Notes:
[an error occurred while processing this directive]