Create DB snapshot (POST /v1.0/{tenantId}/snapshots)

Creates a DB snapshot.

Request URI

{tenantID}

Project ID of the owner of the instance

Data Type Cardinality
String 1..1

Request Parameters

snapshot

Data Type Cardinality Parent Element Child Element(s)
    None instanceId

id

name

instanceId

ID of the virtual database server for which the snapshot will be taken

Data Type Cardinality Parent Element Child Element(s)
None 1..1 snapshot None

id

ID of the DB snapshot
  • Only alphanumeric characters and hyphens can be used
  • The string must start with a letter
  • A hyphen cannot be used at the end of the string
  • Two or more consecutive hyphens cannot be used
  • Up to 63 characters

Default: random value

Data Type Cardinality Parent Element Child Element(s)
string 0..1 snapshot None

name

Name of the DB snapshot
  • Only alphanumeric characters and hyphens can be used
  • The string must start with a letter
  • A hyphen cannot be used at the end of the string
  • Two or more consecutive hyphens cannot be used
  • Up to 255 characters
Data Type Cardinality Parent Element Child Element(s)
string 1..1 snapshot None

description

Description of the DB snapshot

Data Type Cardinality Parent Element Child Element(s)
String 0..1 snapshot None

Response Headers

Status

Returns the status of the request.

One of the following values will be returned.
400:
badRequest
401:
unauthorized
403:
forbidden
404:
itemNotFound
413:
overLimit
422:
unprocessableEntity
500:
instanceFault
501:
notImplemented
503:
serviceUnavailable
504:
gatewayTimeout
Data Type Cardinality
Int 1..1

Response Elements

created

The creation date and time

Data Type Cardinality Parent Element Child Element(s)
Date      

name

Name of the DB snapshot

Data Type Cardinality Parent Element Child Element(s)
String      

id

ID of the DB snapshot

Data Type Cardinality Parent Element Child Element(s)
String      

instanceId

ID of the virtual database server that is the source of this snapshot

Data Type Cardinality Parent Element Child Element(s)
String      

snapshotType

Type of DB snapshot

Data Type Cardinality Parent Element Child Element(s)
String      

status

Status of the DB snapshot

Available | In_progress | Deleted | Error

Data Type Cardinality Parent Element Child Element(s)
String      

description

Description of the DB snapshot

Data Type Cardinality Parent Element Child Element(s)
String      

Example of Request


{
	"snapshot": {
		"instanceId": "dbinst1",
		"name": "json-rack-instance-bkup",
	}
}

Example of Response


{
    "snapshot": 
    {
         "created" : null,
        "name" : "snapshot1",
        "Id" : "snapshot-dfrtgy3h2uj5ik",
        "instanceId" : "instance-r67fg9uj0kfp"
        "status":"Available",
        "description":"sample snapshot"
    }
}