Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Create Replication Group

POST /vdc/data-service/vpools

Creates a replication group that includes the specified storage pools (VDC:storage pool tuple).


Required Roles

  • SYSTEM_ADMIN


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
data_service_vpool_create
id Identifier for this replication group String Valid Values:
  •  Should be uuid
name Unique name identifying this classification of replication group String Valid Values:
  •  Should not be empty
  •  Should not be null
  •  Does not contain spaces
  •  Contains only alphanumeric characters (a-z,A-Z,0-9)
  •  Cannot contain decimal point(.)
  •  Cannot be more than 1024 characters
description Description of this replication group String Valid Values:
  •  Should not be empty
  •  Should not be null
  •  Does not contain spaces
  •  Contains only alphanumeric characters (a-z,A-Z,0-9)
  •  Cannot contain decimal point(.)
  •  Cannot be more than 1024 characters
zone_mappings     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 set if geo rebalancing is enabled Boolean
isAllowAllNamespaces set if Vpool Allows access to all Namespaces for dataservices Boolean
isFullRep set full replication flag Boolean
use_replication_target Boolean

Response Body

Response indicating Success or Failure to delete replication group

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