ConoHa API Documantation

サービス一覧取得 - Database API v1

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

Request URL

Database API v1.0

GET /v1/services

Request Paramters

Parameter Value Style Type Description
X-Auth-Token - header string Userトークン
offset(Optional) - query int 取得開始位置 Default:0
limit(Optional) - query int 取得数 Default:1000
sort_key(Optional) service_name/status/create_date query string ソートキー Default:create_date
sort_type(Optional) asc/desc query string ソート順 Default:asc

Response Paramters

Parameter Value Style Type Description
services - - list -
service_id - plain UUID サービスID
service_name - plain string サービス名
create_date - plain string 作成日時
quota - plain int 使用容量上限値(単位GB)
total_usage - plain float 使用容量合算値(単位GB)、小数点第二位まで表示
status active/suspended/pending/creating/deleting/error plain string ステータス
backup enable/disable plain string バックアップ有効フラグ
prefix - plain string プレフィックス
metadata - plain dict メタデータ キーと値の辞書オブジェクト
total_count - plain int 総件数
current_count - plain int 現在の取得件数

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
※エンドポイントURLにつきましては、お客様環境によって異なりますので、コントロールパネルにてご確認の上ご利用ください。

  • REQ
curl -i -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Auth-Token: 39be9f8d53044388b7f2e867eba8b140" \
https://database-hosting.tyo1.conoha.io/v1/services
  • RES
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
}