DBサーバー一覧取得

Description

DBサーバーの一覧を取得します。

Request URL

Database API

GET /v1/services

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	データの形式(メディアタイプ)を指定します。
limit (Optional)	表示件数	query	取得する情報の表示件数を指定します。
offset (Optional)	開始位置	query	取得する情報の開始位置を指定します。「limit」と併せて使用します。
sort_key (Optional)	service_name status create_date	query	ソート対象の項目を指定します。デフォルトの項目は「create_date」です。
sort_type (Optional)	asc desc	query	ソート対象の並び順を指定します。並び順は、「asc(昇順) 」または「desc(降順)」が指定できます。デフォルトの項目は「asc」です。

Response Parameters

Parameter	Value	Style	Description
service_id	サービスID	plain	DBサーバーのサービスIDの情報になります。
service_name	サービス名	plain	DBサーバーのサービス名の情報になります。
create_date	作成日時	plain	DBサーバーの作成日時の情報になります。
quota	使用容量上限値	plain	DBサーバーの使用容量上限値の情報になります。単位は、GBになります。
total_usage	使用容量合算値	plain	DBサーバーの使用容量合算値の情報になります。単位は、GBになります。
status	active suspended pending creating deleting error	plain	DBサーバーの状態の情報になります。
backup	enable disable	plain	DBサーバーの自動バックアップの有効状態の情報になります。
prefix	データベース名の接頭辞	plain	DBサーバーで作成されるデータベースの名前の接頭辞の情報になります。
metadata	メタデータ	plain	メタデータキーと値の辞書オブジェクトの情報になります。
total_count	総件数	plain	DBサーバー情報の総件数の情報になります。
current_count	現在の取得件数	plain	DBサーバー情報の現在の取得件数の情報になります。

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/services

Response

HTTP/1.1 200 Success
Date: Tue, 09 Dec 2014 01:46:58 GMT
Server: Apache
Content-Length: 1003
Content-Type: application/json

{
    "services" : [
        {
            "service_id": "9d6441f6-c5a0-4dcf-a1a9-1a4d724e51fd",
            "service_name": "dbservice01",
            "create_date": "2012-11-02T19:56:26Z",
            "quota": 10,
            "total_usage": 2.25,
            "status": "active",
            "backup": "disable",
            "prefix" : "02p8y",
            "metadata" : {
                "key" : "value"
            }
        },
        {
            "service_id": "ff164ba8-42d1-49d3-a597-a98503f6fd45",
            "service_name": "dbservice02",
            "create_date": "2012-11-02T19:56:26Z",
            "quota": 30,
            "total_usage": 14,
            "status": "active",
            "backup": "enable",
            "prefix" : "8ypg0"
            "metadata" : {
                "key" : "value"
            }
        }
    ],
    "total_count":100,
    "current_count":10
}

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