Description
List databases.

Request URL 

Database API v1.0

GET /v1/databases

Request Paramters

Parameter Value Style Type Description
X-Auth-Token - header string User Token
service_id(Optional) - query UUID Service ID If unspecifyed, all databases associate to tenants will be returned.
offset(Optional) - query int Index Number to Start a Proceeding Default:0
limit(Optional) - query int Maximum Number of Results Default:1000
sort_key(Optional) db_name/status/create_date/memo query string Sort Key Default:create_date
sort_type(Optional) asc/desc query string Sort Type Default:asc

Response Paramters

Parameter Value Style Type Description
databases - - list -
service_id - plain UUID Service ID
database_id - plain UUID Database ID
internal_hostname - plain string Internal Hostname (private)
external_hostname - plain string External Hostname (global)
db_name - plain string Database Name
db_size - plain float Size of Database(unit:GB）It displays the number with two decimal point.
memo - plain string Memo
type - plain string Database Type
charset - plain string Character Cord for Database
status active/pending/creating/deleting/error plain string Status
total_count - plain int Total Count
current_count - plain int Current Count

Request Json

This operation does not accept a request body.

Normal response codes

200 - Success

Error response codes

400 - Bad Request
401 - Access Denied

Repeatable

Yes

Example 

curl -i -X GET \
-H "Accept: application/json" \
-H "X-Auth-Token: 39be9f8d53044388b7f2e867eba8b140" \
https://database-hosting.tyo1.cloud.z.com/v1/databases?service_id=9d6441f6-c5a0-4dcf-a1a9-1a4d724e51fd
HTTP/1.1 200 Success
Date: Tue, 09 Dec 2014 01:46:58 GMT
Server: Apache
Content-Length: 1003
Content-Type: application/json

{
    "databases": [
        {
            "service_id": "9d6441f6-c5a0-4dcf-a1a9-1a4d724e51fd",
            "database_id": "148147ba-8999-4901-9cd6-634db82f80ea",
            "internal_hostname": "private.02p8y.tyo1.database-hosting.cloud.z.com",
            "external_hostname": "public.02p8y.tyo1.database-hosting.cloud.z.com",
            "db_name": "02p8y_dbname01",
            "db_size": 2,
            "memo": "memo",
            "type": "mysql",
            "charset": "utf8",
            "status": "active"
        },
        {
            "service_id": "9d6441f6-c5a0-4dcf-a1a9-1a4d724e51fd",
            "database_id": "f2d55856-ee66-4efb-9663-a501f3f29edb",
            "internal_hostname": "private.02p8y.tyo1.database-hosting.cloud.z.com",
            "external_hostname": "public.02p8y.tyo1.database-hosting.cloud.z.com",
            "db_name": "02p8y_dbname02",
            "db_size": 32.25,
            "memo": "memo",
            "type": "mysql",
            "charset": "utf8",
            "status": "pending"
        }
    ],
    "total_count":100,
    "current_count":10
}