AI Model Hub for free till June 30, 2025.
Try now
Test nowLog inShare Feedback

ReplicaSet

In-Memory DB replica set with support for a single instance or a In-Memory DB replication in leader follower mode. The mode is determined by the number of replicas. One replica is standalone, everything else an In-Memory DB replication as leader follower mode with one active and n-1 passive replicas.

This tag groups all operations for replicaset.

Retrieve all ReplicaSet

get

This endpoint enables retrieving all ReplicaSet using pagination and optional filters.

Authorizations
Query parameters
offsetinteger · int32Optional

The first element (of the total list of elements) to include in the response. Use together with limit for pagination.

Default: 0Example: 0
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of elements to return. Use together with offset for pagination.

Default: 100Example: 100
filter.namestringOptional

Response filter to list only items contain the specified name. The value is case insensitive and matched on the 'displayName' field.

Responses
200
Returned all requested ReplicaSet successfully.
application/json
Responseall of
and
get
GET /replicasets HTTP/1.1
Host: in-memory-db.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "2ec26f24-9fca-5576-8cda-03d6a0156bbc",
  "type": "collection",
  "href": "/replicasets",
  "items": [
    {
      "id": "1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
      "type": "replicaset",
      "href": "/replicasets/1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
      "metadata": {
        "createdDate": "2020-12-10T13:37:50+01:00",
        "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedDate": "2020-12-11T13:37:50+01:00",
        "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
        "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
        "state": "AVAILABLE",
        "message": "In progress.",
        "dnsName": "imdb01.example.com"
      },
      "properties": {
        "displayName": "In-Memory DB replica set",
        "version": "7.2",
        "replicas": 2,
        "resources": {
          "cores": 4,
          "ram": 4,
          "storage": 1
        },
        "persistenceMode": "None",
        "evictionPolicy": "allkeys-lru",
        "connections": [
          {
            "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
            "lanId": "2",
            "cidr": "192.168.1.100/24"
          }
        ],
        "maintenanceWindow": {
          "time": "16:30:59",
          "dayOfTheWeek": "Monday"
        },
        "backup": {
          "location": "de"
        },
        "credentials": {
          "username": "DatabaseAdmin"
        },
        "initialSnapshotId": "12345678-1234-1234-1234-123456789012"
      }
    }
  ],
  "offset": 0,
  "limit": 42,
  "_links": {
    "prev": "http://PREVIOUS-PAGE-URI",
    "self": "http://THIS-PAGE-URI",
    "next": "http://NEXT-PAGE-URI"
  }
}

Create ReplicaSet

post

Creates a new ReplicaSet.

The full ReplicaSet needs to be provided to create the object. Optional data will be filled with defaults or left empty.

Authorizations
Body
metadataanyOptional

Metadata

Responses
201
ReplicaSet successfully created.
application/json
post
POST /replicasets HTTP/1.1
Host: in-memory-db.de-fra.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 527

{
  "metadata": {},
  "properties": {
    "displayName": "In-Memory DB replica set",
    "version": "7.2",
    "replicas": 2,
    "resources": {
      "cores": 4,
      "ram": 4
    },
    "persistenceMode": "None",
    "evictionPolicy": "allkeys-lru",
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "cidr": "192.168.1.100/24"
      }
    ],
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "backup": {
      "location": "de"
    },
    "credentials": {
      "username": "DatabaseAdmin",
      "password": "my-t0p-secret-password"
    },
    "initialSnapshotId": "12345678-1234-1234-1234-123456789012"
  }
}
{
  "id": "1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  "type": "replicaset",
  "href": "/replicasets/1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE",
    "message": "In progress.",
    "dnsName": "imdb01.example.com"
  },
  "properties": {
    "displayName": "In-Memory DB replica set",
    "version": "7.2",
    "replicas": 2,
    "resources": {
      "cores": 4,
      "ram": 4,
      "storage": 1
    },
    "persistenceMode": "None",
    "evictionPolicy": "allkeys-lru",
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "cidr": "192.168.1.100/24"
      }
    ],
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "backup": {
      "location": "de"
    },
    "credentials": {
      "username": "DatabaseAdmin"
    },
    "initialSnapshotId": "12345678-1234-1234-1234-123456789012"
  }
}

Retrieve ReplicaSet

get

Returns the ReplicaSet by ID.

Authorizations
Path parameters
replicasetIdstring · uuidRequired

The ID (UUID) of the ReplicaSet.

Example: 1046e9bf-dbc0-5bd3-9291-713d36ab77e9
Responses
200
Getting ReplicaSet was successful.
application/json
get
GET /replicasets/{replicasetId} HTTP/1.1
Host: in-memory-db.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  "type": "replicaset",
  "href": "/replicasets/1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE",
    "message": "In progress.",
    "dnsName": "imdb01.example.com"
  },
  "properties": {
    "displayName": "In-Memory DB replica set",
    "version": "7.2",
    "replicas": 2,
    "resources": {
      "cores": 4,
      "ram": 4,
      "storage": 1
    },
    "persistenceMode": "None",
    "evictionPolicy": "allkeys-lru",
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "cidr": "192.168.1.100/24"
      }
    ],
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "backup": {
      "location": "de"
    },
    "credentials": {
      "username": "DatabaseAdmin"
    },
    "initialSnapshotId": "12345678-1234-1234-1234-123456789012"
  }
}

Ensure ReplicaSet

put

Ensures that the ReplicaSet with the provided ID is created or modified. The full ReplicaSet needs to be provided to ensure (either update or create) the ReplicaSet. Non present data will only be filled with defaults or left empty, but not take previous values into consideration.

Authorizations
Path parameters
replicasetIdstring · uuidRequired

The ID (UUID) of the ReplicaSet.

Example: 1046e9bf-dbc0-5bd3-9291-713d36ab77e9
Body
idstring · uuidRequired

The ID (UUID) of the ReplicaSet.

Example: 1046e9bf-dbc0-5bd3-9291-713d36ab77e9
metadataanyOptional

Metadata

Responses
200
ReplicaSet successfully updated.
application/json
put
PUT /replicasets/{replicasetId} HTTP/1.1
Host: in-memory-db.de-fra.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 571

{
  "id": "1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  "metadata": {},
  "properties": {
    "displayName": "In-Memory DB replica set",
    "version": "7.2",
    "replicas": 2,
    "resources": {
      "cores": 4,
      "ram": 4
    },
    "persistenceMode": "None",
    "evictionPolicy": "allkeys-lru",
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "cidr": "192.168.1.100/24"
      }
    ],
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "backup": {
      "location": "de"
    },
    "credentials": {
      "username": "DatabaseAdmin",
      "password": "my-t0p-secret-password"
    },
    "initialSnapshotId": "12345678-1234-1234-1234-123456789012"
  }
}
{
  "id": "1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  "type": "replicaset",
  "href": "/replicasets/1046e9bf-dbc0-5bd3-9291-713d36ab77e9",
  "metadata": {
    "createdDate": "2020-12-10T13:37:50+01:00",
    "createdBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "createdByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedDate": "2020-12-11T13:37:50+01:00",
    "lastModifiedBy": "ionos:identity:::users/87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "lastModifiedByUserId": "87f9a82e-b28d-49ed-9d04-fba2c0459cd3",
    "resourceURN": "ionos:<product>:<location>:<contract>:<resource-path>",
    "state": "AVAILABLE",
    "message": "In progress.",
    "dnsName": "imdb01.example.com"
  },
  "properties": {
    "displayName": "In-Memory DB replica set",
    "version": "7.2",
    "replicas": 2,
    "resources": {
      "cores": 4,
      "ram": 4,
      "storage": 1
    },
    "persistenceMode": "None",
    "evictionPolicy": "allkeys-lru",
    "connections": [
      {
        "datacenterId": "5a029f4a-72e5-11ec-90d6-0242ac120003",
        "lanId": "2",
        "cidr": "192.168.1.100/24"
      }
    ],
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "backup": {
      "location": "de"
    },
    "credentials": {
      "username": "DatabaseAdmin"
    },
    "initialSnapshotId": "12345678-1234-1234-1234-123456789012"
  }
}

Delete ReplicaSet

delete

Deletes the specified ReplicaSet.

Authorizations
Path parameters
replicasetIdstring · uuidRequired

The ID (UUID) of the ReplicaSet.

Example: 1046e9bf-dbc0-5bd3-9291-713d36ab77e9
Responses
202
Deleting ReplicaSet was successful.
delete
DELETE /replicasets/{replicasetId} HTTP/1.1
Host: in-memory-db.de-fra.ionos.com
Authorization: Bearer JWT
Accept: */*

No content
PreviousIn-Memory DBNextSnapshot

Was this helpful?