Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Get Replication Group

GET /vdc/data-service/vpools/{id}

Gets the details for the specified replication group.

idReplication group identifier for which details needs to be retrieved

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR

  • NAMESPACE_ADMIN


Response Body

Details of object virtual pools for the given identifier

Field Description Type Notes
data_service_vpool
description Description of the replication group String
name Unique name identifying this classification of replication group String
varrayMappings     0-* Elements
name Virtual data center id String
value Storage pool id String
is_replication_target is replication target Boolean Valid Values:
  •  Optional [true | false]
enable_rebalancing Parameter to check if the rebalancing is enabled Boolean
isAllowAllNamespaces Parameter to check if the Vpool can access all Namespace Boolean
isFullRep Parameter to check for full replication Boolean
use_replication_target 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/vdc/data-service/vpools/urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global

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"?>
<data_service_vpool>
    <creation_time>1425247698798</creation_time>
    <id>urn:storageos:ReplicationGroupInfo:b3bf2d47-d732-457c-bb9b-d260eb53a76b:global</id>
    <inactive>false</inactive>
    <tags/>
    <isAllowAllNamespaces>true</isAllowAllNamespaces>
    <description>sanity-rg1</description>
    <name>sanity-rg1</name>
    <varrayMappings>
        <name>urn:storageos:VirtualDataCenterData:04af4230-fcc3-4555-aaac-a23fbdd542a2</name>
        <value>urn:storageos:VirtualArray:c7fc54dc-6616-4b7e-a86c-0210ef9a8804</value>
    </varrayMappings>
</data_service_vpool>