List virtual database servers (GET /v1.0/{tenantId}/instances)

Lists information for all virtual database servers.

Request URI

{tenantID}

Project ID of the owner of the instance

Data Type Cardinality
String 1..1

Request parameters

limit

Number of elements to display

From 20 to 100

Default:20

Data Type Cardinality Parent Element Child Element(s)
Integer 0..1 none None

marker

A pagination token used to establish the starting point for retrieving the list.

Specify the ID of the last element returned in the previous list.

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

Response Headers

Status

Returns the status of the request.

One of the following values will be returned.
401:
unauthorized
403:
forbidden
500:
instanceFault
501:
notImplemented
503:
serviceUnavailable
504:
gatewayTimeout
Data Type Cardinality
Int 1..1

Response Elements

instances

List of virtual database servers

Data Type Cardinality Parent Element Child Element(s)
DBinstance structures list   None flavor

id

links

name

status

volume

flavor

Virtual server specifications

Data Type Cardinality Parent Element Child Element(s)
Flavor structures   instances None

id

ID of the virtual database server

Data Type Cardinality Parent Element Child Element(s)
String   instances None

links

URI to the virtual database server

Data Type Cardinality Parent Element Child Element(s)
String   instances None

name

Name of the virtual database server

Data Type Cardinality Parent Element Child Element(s)
String   instances None

status

Status

Data Type Cardinality Parent Element Child Element(s)
String   instances None

volume

Disk type and size of data storage

Data Type Cardinality Parent Element Child Element(s)
Volume structures   instances None

Example of Response


       { "instances": [
         {
          "instance":{
           "flavor": {
            "id": "1",
            "links": [
             {
              "href" : "http://database.{region-name}.tps5.fujitsu.com/v1.0/1234/flavors/1",
              "rel": "self"
             },  
            ]   
           },  
           "id": "098653ba-218b-47ce-936a-e0b749101f81",
           "links": [
            {   
             "href": "https:// database.{region-name}.tps5.fujitsu.com /v1.0/1234/instances/0986rack_instance",
             "rel":"self"
            }
           ],
           "name":"test-instance1",
           "status":"ACTIVE",
           "volume": {
            "size": 20,
            "type":"M1"
           }   
          },  
          "instance":{   
           "flavor": {
            "id": "1",
            "links": [
             {   
              "href": "https:// database.{region-name}.tps5.fujitsu.com /v1.0/1234/
              flavors/1",
              "rel": "self"
             },  
            ]   
           },  
           "id": "44b277eb-39be-4921-be31-3d61b43651d7",
           "links": [
            {   
             "href": "https://database.{region-name}.tps5.fujitsu.com/v1.0/1234/
             instances/44b277eb-39be-4921-be31-3d61b43651d7",
             "rel": "self"
            } 
           ],  
           "name": "json-rack-instance",
           "status": "ACTIVE",
           "volume": {
            "size": 20,
            "type":"M1"
           }
          }
         ]
        }