ConoHa API Documantation

サービス一覧取得 - Mail API v1.0

Description
メールサービスの一覧を取得します。

Request URL

Mail 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) create_date/service_name/status query string ソートキー、Default:create_date
sort_type(Optional) asc/desc query string ソート順、Default:asc

Response Paramters

Parameter Value Style Type Description
services - - list -
status active/suspended/pending/creating/deleting/error plain string サービスの状態
service_id - plain UUID サービスID
service_name - plain string サービス名
smtp - plain string SMTPホスト名
pop - plain string POPホスト名
imap - plain string IMAPホスト名
mx - plain string MXホスト名
quota - plain int 使用容量上限値(単位GB)
total_usage - plain float 使用容量合算値(単位GB)、小数点第二位まで表示
default_domain - plain string デフォルトドメイン
backup enable/disable plain string バックアップ可否、enable:有効、disable:無効
backup_imap - plain dict backupがenableの時項目として出現
1day_ago - plain string IMAPバックアップ(前日分)
2day_ago - plain string IMAPバックアップ(一昨日分)
3day_ago - plain string IMAPバックアップ(一昨昨日分)
metadata - plain dict メタデータ キーと値の辞書オブジェクト
create_date - plain string サービス作成日付
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

401 - Access Denied
404 - Not Found

Repeatable

Yes

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

  • REQ
curl -i -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Auth-Token: 39be9f8d53044388b7f2e867eba8b140" \
https://mail-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": [
        {
            "status": "active",
            "service_id": "53044388b7f2e867e",
            "service_name": "testservice01",
            "smtp": "nweo4h1ge.stmp.conoha.io",
            "pop": "nweo4h1ge.pop.conoha.io",
            "imap": "nweo4h1ge.imap.conoha.io",
            "mx": "mx.unit01.paasmail.tyo1.conoha.io",
            "quota": 540,
            "total_usage": 100,
            "default_domain": "default.conoha.io",
            "backup": "enable",
            "backup_imap": {
                "1day_ago":"nweo4h1ge1.imap.conoha.io",
                "2day_ago":"nweo4h1ge2.imap.conoha.io",
                "3day_ago":"nweo4h1ge3.imap.conoha.io"
            },
            "metadata" : {
                "key" : "value"
            },
            "create_date": "2015-04-07T04:19:05Z"
        },
        {
            "status": "active",
            "service_id": "4oatx0v7xqd8b0au19yc",
            "service_name": "testservice02",
            "smtp": "nweo4h1ge.stmp.conoha.io",
            "pop": "nweo4h1ge.pop.conoha.io",
            "imap": "nweo4h1ge.imap.conoha.io",
            "mx": "mx.unit01.paasmail.tyo1.conoha.io",
            "quota": 540,
            "total_usage": 100,
            "default_domain": "default.conoha.io",
            "backup": "disable",
            "metadata" : {},
            "create_date": "2015-04-07T04:19:05Z"
        }
    ],
    "total_count":100,
    "current_count":2
}