Search (SHIFT+S)
ECS Management API
ECS Object Service API
-
Amazon S3
- S3 Bucket
- S3 Bucket ACL
- S3 Bucket Cors
- S3 Bucket Empty Status Operations
- S3 Bucket Is Stale Allowed
- S3 Bucket Lifecycle
- S3 Bucket List Fanout (Cloud DVR)
- S3 Bucket List Uploads
- S3 Bucket Location
- S3 Bucket Lock Configuration Operations
- S3 Bucket Object Lock Operations
- S3 Bucket Policy
- S3 Bucket Versioning
- S3 Bucket Versions
- S3 Data Node
- S3 Metadata Key List
- S3 Metadata Key System List
- S3 Metadata Search
- S3 Multi Object Delete
- S3 Object
- S3 Object ACL
- S3 Object Detailed Replication Status Operations
- S3 Object Init Uploads
- S3 Object Legal Hold Operations
- S3 Object Replication Info Operations
- S3 Object Retention Operations
- S3 Object Tagging Operations
- S3 Object Uploads
- S3 Options
- S3 Ping
- S3 Retention Update Operation
- S3 Select Operations
- EMC Atmos
- OpenStack Swift
ECS API Changes
Get VDC By Name
GET /object/vdcs/vdc/{vdcName}
Gets the details for a VDC the identify of which is specified by its name.
| vdcName | VDC name for which VDC Information is to be retrieved |
Required Roles
Requires one of the following roles:
SYSTEM_ADMIN
SYSTEM_MONITOR
SERVICE
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 | |
| 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:
|
| link | Hyperlink to the details for this resource | ||
| creation_time | Timestamp that shows when this resource was created in ECS | DateTime |
Valid Values:
|
| 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:
|
| global | Indicates whether the resource is global. | Boolean |
Valid Values:
|
| remote | Indicates whether the resource is remote. | Boolean |
Valid Values:
|
| 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:
|
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>