ConoHa API Documantation

ドメイン一覧取得 - Mail API v1.0

Description
ドメイン一覧を取得します。

Request URL

Mail API v1.0

GET /v1/domains

Request Paramters

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

Response Paramters

Parameter Value Style Type Description
domains - - list -
service_id - plain UUID サービスID
domain_id - plain UUID ドメインID
domain_name - plain string ドメイン名
total_count - plain int 全体件数
current_count - plain int 抽出件数
dkim enable/disable plain string DKIM設定有無

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" \
https://mail-hosting.tyo1.conoha.io/v1/domains?service_id=cef6c1a8-14ff-4553-a8b3-8f2fef16ba79
  • RES
HTTP/1.1 200 Success
Date: Tue, 09 Dec 2014 01:46:58 GMT
Server: Apache
Content-Length: 1003
Content-Type: application/json

{
    "domains": [
        {
            "service_id": "cef6c1a8-14ff-4553-a8b3-8f2fef16ba79",
            "domain_id": "08e16a49a",
            "domain_name": "example1.org",
            "dkim": "disable"
        },....
        {
            "service_id": "cef6c1a8-14ff-4553-a8b3-8f2fef16ba79",
            "domain_id": "6wcsf5vuzr",
            "domain_name": "example2.org",
            "dkim": "enable"
        }
    ],
    "total_count":100,
    "current_count":10
}