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

https://in-memory-db.de-fra.ionos.comhttps://in-memory-db.de-txl.ionos.comhttps://in-memory-db.es-vit.ionos.comhttps://in-memory-db.gb-bhx.ionos.comhttps://in-memory-db.gb-lhr.ionos.comhttps://in-memory-db.us-ewr.ionos.comhttps://in-memory-db.us-las.ionos.comhttps://in-memory-db.us-mci.ionos.comhttps://in-memory-db.fr-par.ionos.com

/replicasets

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

Authorizations

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Query parameters

offsetinteger · int32Optional

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

Default: 0Example: 0

limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of elements to return. Use this parameter together with the 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

Pagination information. The offset and limit parameters are used to navigate the list of elements. The _links object contains URLs to navigate the different pages.

idstring · uuidRequired

ID of the list of ReplicaSet resources.

Example: 2ec26f24-9fca-5576-8cda-03d6a0156bbc

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the list of ReplicaSet resources.

Example: /replicasets

offsetintegerRead-onlyRequired

The offset specified in the request (if none was specified, the default offset is 0).

Example: 0

limitintegerRead-onlyRequired

The limit specified in the request (if none was specified, use the endpoint's default pagination limit).

Example: 42

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

/replicasets

HTTPcURLJavaScriptPython

GET /replicasets HTTP/1.1
Host: in-memory-db.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://in-memory-db.de-fra.ionos.comhttps://in-memory-db.de-txl.ionos.comhttps://in-memory-db.es-vit.ionos.comhttps://in-memory-db.gb-bhx.ionos.comhttps://in-memory-db.gb-lhr.ionos.comhttps://in-memory-db.us-ewr.ionos.comhttps://in-memory-db.us-las.ionos.comhttps://in-memory-db.us-mci.ionos.comhttps://in-memory-db.fr-par.ionos.com

/replicasets

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

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Body

application/json

metadataanyOptional

Metadata

Responses

201

ReplicaSet successfully created.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

415

Unsupported Media Type

The request has an unsupported media type.

application/json

422

Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

post

/replicasets

HTTPcURLJavaScriptPython

POST /replicasets HTTP/1.1
Host: in-memory-db.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://in-memory-db.de-fra.ionos.comhttps://in-memory-db.de-txl.ionos.comhttps://in-memory-db.es-vit.ionos.comhttps://in-memory-db.gb-bhx.ionos.comhttps://in-memory-db.gb-lhr.ionos.comhttps://in-memory-db.us-ewr.ionos.comhttps://in-memory-db.us-las.ionos.comhttps://in-memory-db.us-mci.ionos.comhttps://in-memory-db.fr-par.ionos.com

/replicasets/{replicasetId}

Returns the ReplicaSet by ID.

Authorizations

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

replicasetIdstring · uuidRequired

The ID (UUID) of the ReplicaSet.

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

Responses

200

Getting ReplicaSet was successful.

application/json

idstring · uuidRequired

The ID (UUID) of the ReplicaSet.

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

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the ReplicaSet.

Example: /replicasets/1046e9bf-dbc0-5bd3-9291-713d36ab77e9

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

get

/replicasets/{replicasetId}

HTTPcURLJavaScriptPython

GET /replicasets/{replicasetId} HTTP/1.1
Host: in-memory-db.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://in-memory-db.de-fra.ionos.comhttps://in-memory-db.de-txl.ionos.comhttps://in-memory-db.es-vit.ionos.comhttps://in-memory-db.gb-bhx.ionos.comhttps://in-memory-db.gb-lhr.ionos.comhttps://in-memory-db.us-ewr.ionos.comhttps://in-memory-db.us-las.ionos.comhttps://in-memory-db.us-mci.ionos.comhttps://in-memory-db.fr-par.ionos.com

/replicasets/{replicasetId}

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

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

replicasetIdstring · uuidRequired

The ID (UUID) of the ReplicaSet.

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

Body

application/json

idstring · uuidRequired

The ID (UUID) of the ReplicaSet.

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

metadataanyOptional

Metadata

Responses

200

ReplicaSet successfully updated.

application/json

idstring · uuidRequired

The ID (UUID) of the ReplicaSet.

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

typestring · enumRequired

The type of the resource.

Possible values:

hrefstringRequired

The URL of the ReplicaSet.

Example: /replicasets/1046e9bf-dbc0-5bd3-9291-713d36ab77e9

201

ReplicaSet successfully ensured.

application/json

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

409

Conflict

The UUID is already taken by another party, follow the guides to generate UUIDs uniquely.

application/json

415

Unsupported Media Type

The request has an unsupported media type.

application/json

422

Unprocessable Entity

The request was well-formed but was unable to be followed due to semantic errors.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

put

/replicasets/{replicasetId}

HTTPcURLJavaScriptPython

PUT /replicasets/{replicasetId} HTTP/1.1
Host: in-memory-db.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://in-memory-db.de-fra.ionos.comhttps://in-memory-db.de-txl.ionos.comhttps://in-memory-db.es-vit.ionos.comhttps://in-memory-db.gb-bhx.ionos.comhttps://in-memory-db.gb-lhr.ionos.comhttps://in-memory-db.us-ewr.ionos.comhttps://in-memory-db.us-las.ionos.comhttps://in-memory-db.us-mci.ionos.comhttps://in-memory-db.fr-par.ionos.com

/replicasets/{replicasetId}

Deletes the specified ReplicaSet.

Authorizations

tokenAuth

AuthorizationstringRequired

The token can be generated using the Authentication API.

Path parameters

replicasetIdstring · uuidRequired

The ID (UUID) of the ReplicaSet.

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

Responses

202

Deleting ReplicaSet was successful.

400

Bad Request

The request send to the API was malformed.

application/json

401

Unauthorized

The request is missing authorization information or the authorization information provided are expired.

application/json

403

Not Allowed

The user issuing the request does not have the needed permissions.

application/json

404

Not Found

The resource that was requested could not be found.

application/json

429

Too Many Requests

The user has sent too many requests in a given amount of time.

application/json

500

Internal Server Error

An internal error occurred. We apologize for the inconvenience!

application/json

503

Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

application/json

default

Unexpected Internal Server Error

An unexpected internal error occurred. We apologize for the inconvenience!

application/json

delete

/replicasets/{replicasetId}

HTTPcURLJavaScriptPython

DELETE /replicasets/{replicasetId} HTTP/1.1
Host: in-memory-db.de-fra.ionos.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content