API documentation
一覧 ドメイン
ユーザーのドメイン一覧を取得します。ページネーション、並び替え、ステータスによる絞り込みに対応しています
Content-Type
application-json
カテゴリ
domain
アクション
domain_list
リクエストパラメータ
| パラメータ名 | タイプ | 説明 | 例 |
|---|---|---|---|
| sort | 文字列（任意） | 並び替え方法: name_asc（ドメイン名の昇順）, name_desc（ドメイン名の降順）, time_asc（登録日時の昇順）, time_desc（登録日時の降順、デフォルト） | time_desc |
| page_size | 整数（任意） | 1ページあたりの表示件数（デフォルト: 10、対応: 10, 20, 30, 50, 100） | 20 |
| page_index | 整数（任意） | ページ番号（デフォルト: 1） | 1 |
| status | 文字列（任意） | ドメインのステータス: all（すべてのドメイン、デフォルト）, active（有効なドメイン）, expired（期限切れのドメイン）, stop（停止中のドメイン） | active |
| hold | 文字列（任意） | ドメイン保留ステータス: 空文字列（フィルタなし、デフォルト）、0（保留以外のステータス）、1（保留ステータス） | 0 |
レスポンスパラメータ
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| code | 整数 | ステータスコード（200は成功を示します） |
| msg | 文字列 | メッセージ |
| data | オブジェクト | ドメイン一覧とオプションを含むデータオブジェクト |
| data.options | オブジェクト | 並べ替え、ページネーション、フィルタリング設定を含むクエリオプション |
| data.options.sort | 文字列 | クエリで使用される並べ替え方法 |
| data.options.page_size | 整数 | 1ページあたりの件数 |
| data.options.page_index | 整数 | 現在のページ番号 |
| data.options.status | 文字列 | クエリに適用されるステータスフィルター |
| data.options.total | 整数 | レコード総数 |
| data.options.total_pages | 整数 | 総ページ数 |
| data.domain_list | 配列 | ドメインオブジェクトの配列 |
| data.domain_list.domain | 文字列 | ドメイン名 |
| data.domain_list.created_date | 日付 | 作成日 (YYYY-MM-DD) |
| data.domain_list.expired_date | 日付 | 有効期限日 (YYYY-MM-DD) |
| data.domain_list.status | 文字列 | ドメインステータス (active/expired/stop) |
| data.domain_list.nameservers | 配列 | DNSサーバー配列 |
| data.domain_list.hold | 整数 | 保留ステータス (0=非保留, 1=保留) |
リクエスト例
{
curl https://api.nicenic.net/v2/?category=domain&action=domain_list&sort={sort}&page_size={page_size}&page_index={page_index}&status={status}&hold={hold}
-H "Authorization: username:api_secret"
-H "Content-Type: application/json"
}
返却結果
0 OK
成功レスポンス
{
"code": 0,
"msg" : "success",
"data" : {
"options": {
"sort": "time_desc",
"page_size": 20,
"page_index": 1,
"status": "active",
"total": 50,
"total_pages": 3
},
"domain_list": [
{
"domain": "example.com",
"created_date": "2023-01-15",
"expired_date": "2025-01-15",
"status": "active",
"nameservers": ["ns1.example.com", "ns2.example.com"],
"hold": 0
}
]
}
}
400 不正なリクエスト
{
"code": 400,
"msg" : "Request parameter error",
}
