Unlock a VDB Group.

Request

Security

ApiKeyAuth

Path

vdbGroupIdstring, [ 1 .. 256 ] charactersrequired

The ID or name of the VDBGroup.

curl -i -X POST \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/22.0.0/continuous-data-apis-dct-22.0.0/vdb-groups/{vdbGroupId}/unlock' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

VDB Group is unlocked.

Bodyapplication/json

idstring, [ 1 .. 256 ] charactersread-onlyrequired

A unique identifier for the entity.

Example:"123"

namestring, [ 1 .. 256 ] charactersrequired

A unique name for the entity.

Example:"my-first-vdb-group"

vdb_idsArray of strings

The list of VDB IDs in this VDBGroup.

Example:

[
  "vdb-123",
  "vdb-456"
]

is_lockedboolean

Indicates whether the VDBGroup is locked.

Example:false

locked_byinteger, (int64)

The Id of the account that locked the VDBGroup.

Example:1

locked_by_namestring

The name of the account that locked the VDBGroup.

Example:"admin"

vdb_group_sourcestring

Source of the vdb group, default is DCT. In case of self-service container, this value would be ENGINE.

Enum:"DCT""ENGINE"

ss_data_layout_idstring

Data-layout Id for engine-managed vdb groups.

vdbsArray of objects(VDBOrder)

Dictates order of operations on VDBs. Operations can be performed in parallel
for all VDBs or sequentially. Below are possible valid and invalid orderings given an example
VDB group with 3 vdbs (A, B, and C).
Valid:
{"vdb_id":"vdb-1", "order":"1"} {"vdb_id":"vdb-2", order:"1"} {vdb_id:"vdb-3", order:"1"} (parallel)
{vdb_id:"vdb-1", order:"1"} {vdb_id:"vdb-2", order:"2"} {vdb_id:"vdb-3", order:"3"} (sequential)
Invalid:
{vdb_id:"vdb-1", order:"A"} {vdb_id:"vdb-2", order:"B"} {vdb_id:"vdb-3", order:"C"} (sequential)

In the sequential case the vdbs with priority 1 is the first to be started and the last to
be stopped. This value is set on creation of VDB groups.

database_typestring

The database type of the VDBGroup. If all VDBs in the group are of the same database_type, this field will be set to that type. If the VDBs are of different database_type, this field will be set to 'Mixed'.

Example:"Oracle"

statusstring

The status of the VDBGroup. If all VDBs in the VDBGroup have the same status, this field will be set to that status. If the VDBs have different statuses, this field will be set to 'Mixed'.

Example:"RUNNING"

last_successful_refresh_to_bookmark_idstring

The bookmark ID to which the VDBGroup was last successfully refreshed.

Example:"bookmark-123"

last_successful_refresh_timestring, (date-time)

The time at which the VDBGroup was last successfully refreshed.

Example:"2021-05-01T08:51:34.148Z"

tagsArray of objects(Tag)

Response

{
  "id": "123",
  "name": "my-first-vdb-group",
  "vdb_ids": [
    "vdb-123",
    "vdb-456"
  ],
  "is_locked": false,
  "locked_by": 1,
  "locked_by_name": "admin",
  "vdb_group_source": "DCT",
  "ss_data_layout_id": "string",
  "vdbs": [
    { … }
  ],
  "database_type": "Oracle",
  "status": "RUNNING",
  "last_successful_refresh_to_bookmark_id": "bookmark-123",
  "last_successful_refresh_time": "2021-05-01T08:51:34.148Z",
  "tags": [
    { … }
  ]
}