DB一覧取得

Description

データベースの一覧を取得します。

Request URL

Database API

GET /v1/databases

Request Json

This operation does not accept a request body.

Request Parameters

Parameter	Value	Style	Description
X-Auth-Token	トークンID	header	トークンIDを指定します。
Content-Type	application/json	header	データの形式(メディアタイプ)を指定します。
service_id (Optional)	サービスID	query	DBサーバーのサービスIDを指定します。サービスIDを指定しない場合は、ご契約環境に紐付くすべてのDBサーバーのデータベースがレスポンスされます。
limit (Optional)	表示件数	query	取得する情報の表示件数を指定します。
offset (Optional)	開始位置	query	取得する情報の開始位置を指定します。「limit」と併せて使用します。
sort_key (Optional)	db_name status create_date memo	query	ソート対象の項目を指定します。デフォルトの項目は「create_date」です。
sort_type (Optional)	asc desc	query	ソート対象の並び順を指定します。並び順は、「asc(昇順) 」または「desc(降順)」が指定できます。デフォルトの項目は「asc」です。

Response Parameters

Parameter	Value	Style	Description
service_id	サービスID	plain	DBサーバーのサービスIDの情報になります。
database_id	データベースID	plain	データベースのデータベースIDの情報になります。
internal_hostname	ホスト名	plain	ローカルネットワーク接続用のホスト名の情報になります。
external_hostname	ホスト名	plain	グローバルネットワーク接続用のホスト名の情報になります。
db_name	データベース名	plain	データベースのデータベース名の情報になります。
db_size	使用容量	plain	データベースの使用容量の情報になります。
memo	メモ	plain	データベースのメモの情報になります。
type	種類	plain	データベースの種類の情報になります。
charset	文字コード	plain	データベースの文字コードの情報になります。
status	active pending creating deleting error	plain	データベースの状態の情報になります。
total_count	総件数	plain	データベースの総件数の情報になります。
current_count	現在の取得件数	plain	データベースの現在の取得件数の情報になります。

Response Code

Success

Example

Request

curl -i -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Auth-Token: トークンID" \
https://database-hosting.tyo1.conoha.io/v1/databases?service_id=サービスID

Response

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.conoha.io",
            "external_hostname": "public.02p8y.tyo1.database-hosting.conoha.io",
            "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.conoha.io",
            "external_hostname": "public.02p8y.tyo1.database-hosting.conoha.io",
            "db_name": "02p8y_dbname02",
            "db_size": 32.25,
            "memo": "memo",
            "type": "mysql",
            "charset": "utf8",
            "status": "pending"
        }
    ],
    "total_count":100,
    "current_count":10
}

ConoHaにて提供しておりますAPIにつきましては、クラウド基盤として採用しておりますOpenStackの機能にて実装しておりますので、詳細な情報や使い方はOpenStackのドキュメントにてご確認ください。