DPF-APIリファレンスマニュアル (1.0)

Download OpenAPI specification:Download

1. はじめに

1.1 DPF-APIについて

IIJ DNSプラットフォームサービスでは、DNSレコードやゾーン情報などを、
お客様が用意したプログラムから自動的に操作するためのAPI機能を提供しています。
以降、IIJ DNSプラットフォームサービスを「DPF」、DPFが提供するAPIを「DPF-API」あるいは単に「API」と表記します。
DPF-APIの利用には、DPFの契約とIIJ IDサービスの契約が必要となります。

本リファレンスマニュアルはOpenAPIに準拠しています。

このWEBページはopenapi.jsonから自動生成しています。このWEBページとopenapi.jsonの内容が異なる場合は、openapi.jsonの内容を正とします。 openapi.jsonは、上部のDownloadボタンからダウンロードできます。

1.2 サポート範囲

DPF-APIを呼び出すためのプログラム、及びそのプログラムを稼働させるためのサーバは、お客様にてご用意ください。
お客様にご用意いただくプログラムの開発、利用、動作についてのお問い合わせは承ることができません。

以下の事項についてのお問い合わせは、弊社サポートセンターにて承ります。

  • DPF-APIの挙動が本リファレンスマニュアルと異なる場合
  • DPF-APIがシステムエラーを応答した場合

1.3 参考資料

2. 利用方法

DPF-APIは、URLとHTTPリクエストヘッダ、HTTPリクエストボディでパラメータを指定して利用します。
また、IIJ IDサービスのアクセストークンと管理対象の権限設定が必要です。

2.1 リクエスト仕様

項目 規格
プロトコル HTTP/1.1、HTTP/2(https)
HTTPメソッド GET、POST、PATCH、PUT、DELETE
フォーマット JSON
文字コード UTF-8
タイムアウト 300秒
  • httpでのリクエストは受け付けません。必ずhttpsを使用してください。
  • DPF-APIを呼び出すプログラムは、リクエスト先が正当なものであることを確認するため、SSL証明書を検証することを推奨します。
  • 短期間に極めて多数のリクエストが行われた場合、サービスの健全性を保つためにリクエストを制限する場合があります。

アクセストークン

APIリクエストの際にIIJ IDサービスによって発行されたアクセストークンをAuthorizationヘッダに指定する必要があります。
各APIにより必要となるアクセス権の範囲(許可するスコープ)が異なるのでご注意ください。

アクセストークン作成時に指定できる「許可するスコープ」は以下のとおりです。

許可するスコープ 実行できるAPI
dpf_read 参照系API
dpf_write 更新系、及び参照系API
dpf_contract 契約系API

発行済のアクセストークンは、IIJ IDサービスの「アクセストークンの管理」より確認できます。
DPF-APIを利用する場合は「利用するリソースサーバ」の設定で「IIJ DNSサービスAPI」を選択してください。
アクセストークン管理方法のマニュアルはこちらを参照してください。

管理対象の権限設定

DPFでは、管理対象となる契約単位での参照、編集権限を細かく設定できます。
アクセストークンの許可するスコープが適切であっても、管理対象の権限が付与されていない場合はAPIを実行できません。
管理対象の権限設定のマニュアルはこちらを参照してください。

2.2 HTTPリクエスト

<HTTPメソッド> /dpf/<version>/<APIパス> HTTP/1.1
Host: api.dns-platform.jp
Authorization: Bearer <access_token>
Content-Type: application/json; charset=UTF-8

<HTTPリクエストボディ: JSON形式のAPI固有のパラメータ>

リクエストパラメータ

DPF-APIで指定するパラメータは以下のとおりです。
リクエストパラメータに同一のキーが含まれる場合の動作は保証されません。

共通 指定箇所 パラメータ 意味
共通 HTTPメソッド HTTPメソッド HTTPメソッド(値:GET、POST、PATCH、PUT、DELETE)
共通 URL version DPF-APIバージョン(値:v1)
個別 URL APIパス API名称やAPI個別のパラメータの組み合わせ
共通 HTTPヘッダー access_token IIJ IDアクセストークン(参照:IIJ IDサービス
個別 HTTPボディ APIごとに異なる JSON形式のパラメータ

2.3 HTTPレスポンス

成功レスポンス

APIごとにレスポンスが異なります。

エラーレスポンス

HTTPステータスコード、及びレスポンスボディによってクライアントプログラムにエラーを通知します。

例:アクセストークンが誤っている

{
  "request_id": "782d746ac3cb46499b31708fa80e8660",
  "error_type": "ParameterError",
  "error_message": "There are invalid parameters.",
  "error_details": [
    {
      "code": "invalid",
      "attribute": "access_token"
    }
  ]
}

エラーコード一覧

HTTP Status Code error_type error_message code attribute 説明 対処方法
400 ParameterError There are invalid parameters. invalid access_token 指定したアクセストークンに誤りがあります アクセストークンを確認してください
400 ParameterError JSON parse error occurred. - - パラメータとして不正なJSON文字列が指定されました リクエストのパラメータを確認してください
400 ParameterError There are invalid parameters. (API個別) (API個別) 不正なパラメータが指定されました 各APIのエラーコードを確認してください
404 NotFound Specified resource not found. - - アクセスURLが正しくありません
存在しないAPIが指定されました
指定された以外のHTTPメソッドが指定されました
左記の内容を確認してください
429 TooManyRequests Too many requests. - - 大量のAPIリクエストが送信されました 単位時間当たりのAPIリクエスト数を確認してください
500 SystemError System error occurred. - - システム障害が発生しました サポートセンターへお問い合わせください
504 GatewayTimeout Gateway timeout. - - リクエストがタイムアウトしました しばらく待ってから再度リクエストしてください

2.4 非同期リクエスト

DPF-APIにおけるGET以外のAPIは全て非同期APIです。
非同期APIはリクエストを受け付けると即座にレスポンスを返却しますが、
リクエストに対する実際の処理は非同期で行われます。

非同期リクエストの受け付けに成功した場合のHTTPステータスコードは202で、
返却されたレスポンスボディには、処理進捗を確認するためのURL(jobs_url)が含まれます。
このjobs_urlに対してGETリクエストをすることで進捗状況を確認できます。

進捗状況を確認した際、非同期処理が正常に終了していた場合は、
返却されたレスポンスボディには、対象リソースを取得するためのURL(resources_url)が含まれます。
このresources_urlに対してGETリクエストをすることで実行結果を確認できます。

非同期リクエストのレスポンス

HTTP/1.1 202 Accepted
Date: Mon, 26 Mar 20XX hh:mm:dd GMT
Content-Type: application/json; charset=utf-8
〜 略 〜

{
  "request_id": "782d746ac3cb46499b31708fa80e8660",
  "jobs_url": "https://api.dns-platform.jp/dpf/<version>/jobs/<request_id>"
}

GETリクエスト

GET /dpf/<version>/jobs/<request_id> HTTP/1.1
Host: api.dns-platform.jp
Authorization: Bearer <access_token>
Content-Type: application/json; charset=UTF-8

{}

進捗状況のレスポンス

HTTP/1.1 200 OK
Date: Mon, 26 Mar 20XX hh:mm:dd GMT
Content-Type: application/json; charset=utf-8
〜 略 〜

{
  "request_id": "782d746ac3cb46499b31708fa80e8660",
  "resources_url": <resources_url>,
  "status": "SUCCESSFUL"
}

cc_notice_accounts

通知先アカウントの操作ができます。

通知先アカウント設定の一覧取得

通知先アカウントの設定の一覧を取得します。

Authorizations:
DPFViewer
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

通知先アカウント設定の作成

新しく通知先アカウントを作成します。

Authorizations:
DPFOperator
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Request Body schema: application/json
name
required
string (CcNoticeAccountName) [ 1 .. 80 ] characters

アカウント名

lang
required
string (CcNoticeAccountLang)
Enum: "ja" "en_US"

言語設定

resource_name
string (ResourceName) <= 253 characters

登録可能な文字列はこちらのホスト名の共通ルールを参照してください。

object (CcNoticeAccountProps)

Responses

Request samples

Content type
application/json
{
  • "resource_name": "a-1234567890-0abcd",
  • "name": "name1",
  • "lang": "ja",
  • "props": {
    }
}

Response samples

Content type
application/json
{}

通知先アカウントの取得

指定したCcNoticeAccountResourceNameの通知先アカウント設定を取得します。

Authorizations:
DPFViewer
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

CcNoticeAccountResourceName
required
string (ResourceName) <= 253 characters

GET cc_notice_accounts Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

通知先アカウント設定の更新

指定したCcNoticeAccountResourceNameの通知先アカウント設定を更新します。
アカウントに登録されたメールアドレスや電話番号を削除したい場合は、空文字を指定してください。

Authorizations:
DPFOperator
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

CcNoticeAccountResourceName
required
string (ResourceName) <= 253 characters

GET cc_notice_accounts Schemaにおける resource_name

Request Body schema: application/json
name
string (CcNoticeAccountName) [ 1 .. 80 ] characters

アカウント名

lang
string (CcNoticeAccountLang)
Enum: "ja" "en_US"

言語設定

object (CcNoticeAccountProps)

Responses

Request samples

Content type
application/json
{
  • "name": "name1",
  • "lang": "ja",
  • "props": {
    }
}

Response samples

Content type
application/json
{}

通知先アカウント設定の削除

指定したCcNoticeAccountResourceNameの通知先アカウント設定を削除します。

Authorizations:
DPFOperator
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

CcNoticeAccountResourceName
required
string (ResourceName) <= 253 characters

GET cc_notice_accounts Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{}

cc_primaries

プライマリネームサーバの操作ができます。
プライマリネームサーバの状態(enabled)は以下のとおりです。

enabled

意味 備考
0 無効
1 有効

プライマリネームサーバ設定の一覧取得

プライマリネームサーバの設定の一覧を取得します。

Authorizations:
DPFViewer
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

プライマリネームサーバ設定の作成

新しくプライマリネームサーバを作成します。
作成できる最大件数は5件です。

Authorizations:
DPFOperator
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Request Body schema: application/json
address
required
string (CcPrimaryAddress)

IPアドレス

tsig_id
integer or null <int64> (TsigId) >= 1

Responses

Request samples

Content type
application/json
{
  • "tsig_id": 1234,
  • "address": "192.0.2.0"
}

Response samples

Content type
application/json
{}

プライマリネームサーバ設定の取得

指定したCcPrimaryIdのプライマリネームサーバを取得します。

Authorizations:
DPFViewer
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

CcPrimaryId
required
integer <int64> (Id) >= 1

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

プライマリネームサーバ設定の更新

指定したCcPrimaryIdのプライマリネームサーバを更新します。

Authorizations:
DPFOperator
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

CcPrimaryId
required
integer <int64> (Id) >= 1

ID

Request Body schema: application/json
tsig_id
integer or null <int64> (TsigId) >= 1
address
string (CcPrimaryAddress)

IPアドレス

enabled
integer (CcPrimaryEnabled)
Enum: 0 1

詳細説明はこちら

Responses

Request samples

Content type
application/json
{
  • "enabled": 1
}

Response samples

Content type
application/json
{}

プライマリネームサーバ設定の削除

指定したCcPrimaryIdのプライマリネームサーバを削除します。

Authorizations:
DPFOperator
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

CcPrimaryId
required
integer <int64> (Id) >= 1

ID

Responses

Response samples

Content type
application/json
{}

cc_sec_notified_servers

DNS NOTIFYの操作ができます。

DNS NOTIFY設定の一覧取得

DNS NOTIFYの設定の一覧を取得します。

Authorizations:
DPFViewer
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

DNS NOTIFY設定の作成

新しくDNS NOFITYを作成します。
作成できる最大件数は256件です。

Authorizations:
DPFOperator
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Request Body schema: application/json
address
required
string (CcNotifiedServerAddress)

IPアドレス

tsig_id
integer or null <int64> (TsigId) >= 1

Responses

Request samples

Content type
application/json
{
  • "tsig_id": 1234,
  • "address": "192.0.2.0"
}

Response samples

Content type
application/json
{}

DNS NOTIFY設定の取得

指定したCcSecNotifiedServerIdのDNS NOTIFYを取得します。

Authorizations:
DPFViewer
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

CcSecNotifiedServerId
required
integer <int64> (Id) >= 1

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

DNS NOTIFY設定の更新

指定したCcSecNotifiedServerIdのDNS NOTIFYを更新します。

Authorizations:
DPFOperator
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

CcSecNotifiedServerId
required
integer <int64> (Id) >= 1

ID

Request Body schema: application/json
tsig_id
integer or null <int64> (TsigId) >= 1
address
string (CcNotifiedServerAddress)

IPアドレス

Responses

Request samples

Content type
application/json
{
  • "address": "198.51.100.0"
}

Response samples

Content type
application/json
{}

DNS NOTIFY設定の削除

指定したCcSecNotifiedServerIdのDNS NOTIFYを削除します。

Authorizations:
DPFOperator
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

CcSecNotifiedServerId
required
integer <int64> (Id) >= 1

ID

Responses

Response samples

Content type
application/json
{}

cc_sec_transfer_acls

ゾーン転送ACLの操作ができます。

ゾーン転送ACLの一覧取得

ゾーン転送ACLの設定の一覧を取得します。

Authorizations:
DPFViewer
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

ゾーン転送ACLの作成

新しくゾーン転送ACLを作成します。
作成できる最大件数は5件です。

Authorizations:
DPFOperator
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Request Body schema: application/json
network
required
string (CcSecTransferNetwork)

IPアドレス/プレフィックス長

tsig_id
integer or null <int64> (TsigId) >= 1

Responses

Request samples

Content type
application/json
{
  • "network": "192.0.2.0/24",
  • "tsig_id": 1234
}

Response samples

Content type
application/json
{}

ゾーン転送ACLの取得

指定したCcSecTransferAclIdのゾーン転送ACLを取得します。

Authorizations:
DPFViewer
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

CcSecTransferAclId
required
integer <int64> (Id) >= 1

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

ゾーン転送ACLの更新

指定したCcSecTransferAclIdのゾーン転送ACLを更新します。

Authorizations:
DPFOperator
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

CcSecTransferAclId
required
integer <int64> (Id) >= 1

ID

Request Body schema: application/json
tsig_id
integer or null <int64> (TsigId) >= 1
network
string (CcSecTransferNetwork)

IPアドレス/プレフィックス長

Responses

Request samples

Content type
application/json
{
  • "network": "192.0.2.0/24",
  • "tsig_id": 1234
}

Response samples

Content type
application/json
{}

ゾーン転送ACLの削除

指定したCcSecTransferAclIdのゾーン転送ACLを削除します。

Authorizations:
DPFOperator
path Parameters
CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

CcSecTransferAclId
required
integer <int64> (Id) >= 1

ID

Responses

Response samples

Content type
application/json
{}

common_configs

複数のゾーンおよびLBドメインで共通の設定内容を使用するための共通設定を操作できます。
マネージドDNSサーバの状態(managed_dns_enabled)、初期適用の共通設定(default)は以下のとおりです。

managed_dns_enabled

意味 備考
0 無効
1 有効

default

意味 備考
0 無効
1 有効

共通設定の一覧取得

共通設定の一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

共通設定の作成

新しく共通設定を作成します。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
name
required
string (CommonConfigName) [ 1 .. 80 ] characters

name

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "name": "name",
  • "description": ""
}

Response samples

Content type
application/json
{}

共通設定の件数取得

共通設定の件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

初期適用される共通設定の更新

ゾーンおよびLBドメインを新規追加した場合に、自動で適用される共通設定を切り替えます。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
common_config_id
required
integer <int64> (Id) >= 1

Responses

Request samples

Content type
application/json
{
  • "common_config_id": 1234
}

Response samples

Content type
application/json
{}

共通設定の取得

指定したCommonConfigIdの共通設定を取得します。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

共通設定の更新

指定したCommonConfigIdの共通設定を更新します。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Request Body schema: application/json
name
string (CommonConfigName) [ 1 .. 80 ] characters

name

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "name": "name"
}

Response samples

Content type
application/json
{}

共通設定の削除

指定したCommonConfigIdの共通設定を削除します。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Responses

Response samples

Content type
application/json
{}

共通設定のコピー

指定した共通設定と同じ内容の共通設定を別の共通設定名で作成します。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Request Body schema: application/json
name
required
string (CommonConfigName) [ 1 .. 80 ] characters

name

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "name": "name",
  • "description": ""
}

Response samples

Content type
application/json
{}

マネージドDNSサーバの状態更新

マネージドDNSサーバをプライマリネームサーバとして有効もしくは無効とするかの切り替えを行えます。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

CommonConfigId
required
integer <int64> (Id) >= 1

GET common_configs Schemaにおける id

Request Body schema: application/json
managed_dns_enabled
required
integer (ManagedDnsEnabled)
Enum: 0 1

詳細説明はこちら

Responses

Request samples

Content type
application/json
{
  • "managed_dns_enabled": 1
}

Response samples

Content type
application/json
{}

contracts

DPF契約の操作ができます。
契約プラン(plan)、契約の状態(state)、お気に入りの状態(favorite)は以下のとおりです。

plan

意味 備考
1 ベーシック
2 プレミアム

state

意味 備考
1 利用開始前
2 利用中

favorite

意味 備考
1 表示優先度高
2 表示優先度低

DPF契約情報の一覧取得

DPF契約情報の一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_service_code[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_plan[]
integer (ContractPlan)
Enum: 1 2

詳細説明はこちら

_keywords_state[]
integer (ContractState)
Enum: 1 2

詳細説明はこちら

_keywords_favorite[]
integer (ContractFavorite)
Enum: 1 2

詳細説明はこちら

_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

DPF契約情報の件数取得

DPF契約の件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_service_code[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_plan[]
integer (ContractPlan)
Enum: 1 2

詳細説明はこちら

_keywords_state[]
integer (ContractState)
Enum: 1 2

詳細説明はこちら

_keywords_favorite[]
integer (ContractFavorite)
Enum: 1 2

詳細説明はこちら

_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

DPF契約情報の取得

指定したContractIdのDPF契約を取得します。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

DPF契約情報の更新

指定したContractIdのDPF契約を更新します。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
favorite
integer (ContractFavorite)
Enum: 1 2

詳細説明はこちら

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "favorite": 2
}

Response samples

Content type
application/json
{}

DPF契約情報のラベル一覧取得

指定したContractIdのラベルの一覧を取得します。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

DPF契約情報のラベル一括更新

指定したContractIdのラベルを一括更新します。
エラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
required
object [ 0 .. 10 ] properties
Default: {}

ラベル

Responses

Request samples

Content type
application/json
{
  • "labels": {
    }
}

Response samples

Content type
application/json
{}

contract_partners

DPF契約の連携しているサービス情報の操作ができます。

DPF連携サービスの一覧取得

DPFが連携しているサービスの一覧を取得します。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

lb_domains (contracts)

DPF契約に紐付くLBドメインの操作ができます。
LBドメインの状態(state)、お気に入りの状態(favorite)の詳細な説明は、lb_domainsを参照してください。

DPF契約に紐付くLBドメインの一覧取得

指定したContractIdのDPF契約に紐付くLBドメインの一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。
エラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_service_code[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_state[]
Array of integers (KeywordsLbDomainState) >= 0 items
Default: []
Items Enum: 1 2

詳細説明はこちら

_keywords_favorite[]
Array of integers (KeywordsLbDomainFavorite) >= 0 items
Default: []
Items Enum: 1 2

詳細説明はこちら

_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_common_config_id[]
Array of integers <int64> (KeywordsId) >= 0 items [ items <int64 > >= 1 ]
Default: []
_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

DPF契約に紐付くLBドメインの共通設定の更新

指定したContractIdの共通設定を切り替えます。
エラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
common_config_id
required
integer <int64> (Id) >= 1
lb_domain_ids
required
Array of strings (SystemId) non-empty [ items = 14 characters ]

GET lb_domains Schemaにおける id の配列

Responses

Request samples

Content type
application/json
{
  • "common_config_id": 1234,
  • "lb_domain_ids": [
    ]
}

Response samples

Content type
application/json
{}

DPF契約に紐付くLBドメインの件数取得

指定したContractIdのDPF契約に紐付くLBドメインの件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。
エラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_service_code[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_state[]
Array of integers (KeywordsLbDomainState) >= 0 items
Default: []
Items Enum: 1 2

詳細説明はこちら

_keywords_favorite[]
Array of integers (KeywordsLbDomainFavorite) >= 0 items
Default: []
Items Enum: 1 2

詳細説明はこちら

_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_common_config_id[]
Array of integers <int64> (KeywordsId) >= 0 items [ items <int64 > >= 1 ]
Default: []
_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

logs (contracts)

DPF契約を操作したログを取得できます。
取得可能なログは90日前までとなります。
操作内容(operation)、ログの種別(log_type)、処理の状態(status)は以下のとおりです。

operation

意味 備考
add_cc_primary プライマリネームサーバ設定の作成
update_cc_primary プライマリネームサーバ設定の更新
delete_cc_primary プライマリネームサーバ設定の削除
add_cc_sec_notified_server DNS NOTIFY設定の作成
update_cc_sec_notified_server DNS NOTIFY設定の更新
delete_cc_sec_notified_server DNS NOTIFY設定の削除
add_cc_sec_transfer_acl ゾーン転送ACLの作成
update_cc_sec_transfer_acl ゾーン転送ACLの更新
delete_cc_sec_transfer_acl ゾーン転送ACLの削除
add_notification_account 通知先アカウント設定の追加
update_notification_account 通知先アカウント設定の更新
delete_notification_account 通知先アカウント設定の削除
mail_notification メール通知の実行
phone_notification 架電通知の実行
create_common_config 共通設定の作成
switch_default_common_config 初期適用される共通設定の更新
update_common_config 共通設定の更新
delete_common_config 共通設定の削除
copy_common_config 共通設定のコピー
update_managed_dns_state マネージドDNSサーバの状態更新
update_contract_description DPF契約情報のコメントの更新
update_contract_favorite DPF契約情報のお気に入り状態の更新
update_contract_labels DPF契約情報のラベルの更新
apply_common_config DPF契約に紐付くゾーンおよびLBドメインの共通設定の更新
create_contract_partnership IIJ IDサービスとの連携
delete_contract_partnership IIJ IDサービスとの連携解除
create_tsig TSIG鍵の作成
update_tsig TSIG鍵の更新
delete_tsig TSIG鍵の削除

log_type

意味 備考
service サービス設定の操作
common_config 共通設定の操作
notification 通知の実行

status

意味 備考
start 処理開始
success 処理正常終了
failure 処理失敗
retry リトライ

DPF契約操作ログの一覧取得

DPF契約を操作したログの一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchLogsOffset) [ 0 .. 9900 ]
Default: 0
limit
integer <int32> (SearchLogsLimit) [ 1 .. 100 ]
Default: 100
start_date
string <full-date> (SearchDate)
Default: ""

開始日

end_date
string <full-date> (SearchDate)
Default: ""

終了日

time_zone
string <time-numoffset> (SearchTimeZone)
Default: "+00:00"

タイムゾーン

order
string (SearchOrder)
Default: "ASC"
Enum: "ASC" "DESC"

ソート順

_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_log_type[]
string (ContractsLogsLogType)
Enum: "service" "common_config" "notification"

詳細説明はこちら

_keywords_operator[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_operation[]
string (ContractsLogsOperation)
Enum: "add_cc_primary" "update_cc_primary" "delete_cc_primary" "add_cc_sec_notified_server" "update_cc_sec_notified_server" "delete_cc_sec_notified_server" "add_cc_sec_transfer_acl" "update_cc_sec_transfer_acl" "delete_cc_sec_transfer_acl" "add_notification_account" "update_notification_account" "delete_notification_account" "mail_notification" "phone_notification" "create_common_config" "switch_default_common_config" "update_common_config" "delete_common_config" "copy_common_config" "update_managed_dns_state" "update_contract_description" "update_contract_favorite" "update_contract_labels" "apply_common_config" "create_contract_partnership" "delete_contract_partnership" "create_tsig" "update_tsig" "delete_tsig"

詳細説明はこちら

_keywords_target[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_detail[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_request_id[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_status[]
string (ContractsLogsStatus)
Enum: "start" "success" "failure" "retry"

詳細説明はこちら

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

DPF契約操作ログの件数取得

DPF契約を操作したログの件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
start_date
string <full-date> (SearchDate)
Default: ""

開始日

end_date
string <full-date> (SearchDate)
Default: ""

終了日

time_zone
string <time-numoffset> (SearchTimeZone)
Default: "+00:00"

タイムゾーン

_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_log_type[]
string (ContractsLogsLogType)
Enum: "service" "common_config" "notification"

詳細説明はこちら

_keywords_operator[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_operation[]
string (ContractsLogsOperation)
Enum: "add_cc_primary" "update_cc_primary" "delete_cc_primary" "add_cc_sec_notified_server" "update_cc_sec_notified_server" "delete_cc_sec_notified_server" "add_cc_sec_transfer_acl" "update_cc_sec_transfer_acl" "delete_cc_sec_transfer_acl" "add_notification_account" "update_notification_account" "delete_notification_account" "mail_notification" "phone_notification" "create_common_config" "switch_default_common_config" "update_common_config" "delete_common_config" "copy_common_config" "update_managed_dns_state" "update_contract_description" "update_contract_favorite" "update_contract_labels" "apply_common_config" "create_contract_partnership" "delete_contract_partnership" "create_tsig" "update_tsig" "delete_tsig"

詳細説明はこちら

_keywords_target[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_detail[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_request_id[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_status[]
string (ContractsLogsStatus)
Enum: "start" "success" "failure" "retry"

詳細説明はこちら

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

qps

月別のQPSの一覧取得

DPF契約の月別のQPSを取得できます。
DPF契約に紐付くゾーンおよびLBドメインの月別のQPSと、
ゾーンおよびLBドメインのクエリ数を元に集計したDPF契約の月別のQPSが取得できます。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

tsigs

TSIG鍵の操作ができます。
ハッシュアルゴリズム(algorithm)は以下のとおりです。

algorithm

意味 備考
0 HMAC-SHA256

TSIG鍵の一覧取得

TSIG鍵情報の一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

TSIG鍵の作成

新しくTSIG鍵を作成します。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
name
required
string (TsigsPostName) [ 1 .. 63 ] characters

先頭末尾がハイフン以外の[a-z0-9]とハイフンで構成された文字列が使用できます

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "name": "name",
  • "description": ""
}

Response samples

Content type
application/json
{}

TSIG鍵の件数取得

TSIG鍵の件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

TSIG鍵の取得

指定したTsigIdのTSIG鍵を取得します。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

TsigId
required
integer <int64> (Id) >= 1

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

TSIG鍵の更新

指定したTsigIdのTSIG鍵を更新します。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

TsigId
required
integer <int64> (Id) >= 1

ID

Request Body schema: application/json
description
required
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "description": "description"
}

Response samples

Content type
application/json
{}

TSIG鍵の削除

指定したTsigIdのTSIG鍵を削除します。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

TsigId
required
integer <int64> (Id) >= 1

ID

Responses

Response samples

Content type
application/json
{}

TSIG鍵を利用している共通設定の一覧取得

指定したTSIG鍵を使用している共通設定の一覧を取得します。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

TsigId
required
integer <int64> (Id) >= 1

ID

query Parameters
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

TSIG鍵を利用している共通設定の件数取得

指定したTSIG鍵を使用している共通設定の件数を取得します。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

TsigId
required
integer <int64> (Id) >= 1

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

zones (contracts)

DPF契約に紐付くゾーンの操作ができます。
ゾーンの状態(state)、お気に入りの状態(favorite)、ゾーンプロキシの状態(zone_proxy_enabled)の詳細な説明は、zonesを参照してください。

DPF契約に紐付くゾーンの一覧取得

指定したContractIdのDPF契約に紐付くゾーンの一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_service_code[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_network[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_state[]
integer (ZonesState)
Enum: 1 2

詳細説明はこちら

_keywords_favorite[]
integer (ZonesFavorite)
Enum: 1 2

詳細説明はこちら

_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_common_config_id[]
Array of integers <int64> (KeywordsId) >= 0 items [ items <int64 > >= 1 ]
Default: []
_keywords_zone_proxy_enabled[]
integer (ZoneProxyEnabled)
Enum: 0 1

詳細説明はこちら

_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

DPF契約に紐付くゾーンの共通設定の更新

指定したContractIdの共通設定を切り替えます。

Authorizations:
DPFOperator
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
common_config_id
required
integer <int64> (Id) >= 1
zone_ids
required
Array of strings (SystemId) non-empty [ items = 14 characters ]

Responses

Request samples

Content type
application/json
{
  • "common_config_id": 1234,
  • "zone_ids": [
    ]
}

Response samples

Content type
application/json
{}

DPF契約に紐付くゾーンの件数取得

指定したContractIdのDPF契約に紐付くゾーンの件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ContractId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_service_code[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_network[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_state[]
integer (ZonesState)
Enum: 1 2

詳細説明はこちら

_keywords_favorite[]
integer (ZonesFavorite)
Enum: 1 2

詳細説明はこちら

_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_common_config_id[]
Array of integers <int64> (KeywordsId) >= 0 items [ items <int64 > >= 1 ]
Default: []
_keywords_zone_proxy_enabled[]
integer (ZoneProxyEnabled)
Enum: 0 1

詳細説明はこちら

_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

default_ttl

契約に紐づくゾーンのデフォルトTTLの操作ができます。
デフォルトTTLの状態(state)は以下のとおりです。

state

意味 備考
0 反映済み
3 更新予定
5 更新前の状態

デフォルトTTLの取得

デフォルトTTLの一覧を取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

デフォルトTTLの更新

デフォルトTTLを更新します。
編集中レコードのゾーン反映を実行するまでは権威サーバには反映されません。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
value
required
integer (DefaultTtlValue) [ 1 .. 2147483647 ]

TTL

Responses

Request samples

Content type
application/json
{
  • "value": 28800
}

Response samples

Content type
application/json
{}

編集中デフォルトTTLの取消

デフォルトTTLの操作を取消します。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{}

デフォルトTTLの編集差分の取得

現在DNSに登録されているデフォルトTTLと反映予定のデフォルトTTLの差分一覧を取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

dnssec

DNSSECの操作ができます。
DNSSECの有効状態(enabled)、DNSSECの状態(state)、DSレコードの状態(ds_state)は以下のとおりです。

enabled

意味 備考
0 無効
1 有効

state

意味 備考
0 ゾーン公開前
1 有効化作業中
2 有効
3 無効化作業中
4 無効

ds_state

意味 備考
0 公開前
1 DSレコード登録待ち
3 DSレコード公開中
4 ロールオーバー準備中
5 DSレコード変更待ち
6 DSレコード変更反映待ち
7 DSレコード削除待ち
8 DSレコード削除反映待ち

DNSSEC情報の取得

DNSSEC情報の一覧を取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

DNSSEC情報の更新

DNSSECの情報を更新します。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
enabled
required
integer (DnssecEnabled)
Enum: 0 1

詳細説明はこちら

Responses

Request samples

Content type
application/json
{
  • "enabled": 1
}

Response samples

Content type
application/json
{}

KSKロールオーバーの開始

指定したゾーンに対してKSKロールオーバーを開始します。
ロールオーバーはds_stateが「3」の場合のみ開始できます。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{}

ds_records

DSレコードの一覧取得

上位のネームサーバに登録が必要なDSレコードを取得できます。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

logs (zones)

契約に紐付くゾーンを操作したログを取得できます。
取得可能なログは90日前までとなります。
操作内容(operation)、ログの種別(log_type)、処理の状態(status)は以下のとおりです。

operation

意味 備考
updating_default_ttl デフォルトTTLの更新
dismiss_default_ttl_change 編集中デフォルトTTLの取消
update_dnssec_configuration DNSSEC情報の更新
begin_ksk_rollover KSKロールオーバーの開始
adding_record レコードの作成
updating_record レコードの更新
deleting_record レコードの削除
dismiss_record_change 編集中レコードの取消
update_zone_proxy ゾーンプロキシ設定の更新
update_zone_description ゾーンのコメントの更新
update_zone_favorite ゾーンのお気に入り状態の更新
update_zone_labels ゾーンのラベルの更新
commit_zone 編集中レコードのゾーン反映
upload_zone ゾーンファイルのアップロード
dismiss_zone_edits 編集中レコードの一括取消
bulk_update_records レコードの一括更新
upsert_subdomain_ns_records サブドメインNSレコードの一括登録
create_delegations ネームサーバ申請

log_type

意味 備考
service サービス設定の操作
record レコードの操作
dnssec DNSSEC設定の操作

status

意味 備考
start 処理開始
success 処理正常終了
failure 処理失敗
retry リトライ

ゾーン操作ログの一覧取得

ゾーンを操作したログの一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchLogsOffset) [ 0 .. 9900 ]
Default: 0
limit
integer <int32> (SearchLogsLimit) [ 1 .. 100 ]
Default: 100
start_date
string <full-date> (SearchDate)
Default: ""

開始日

end_date
string <full-date> (SearchDate)
Default: ""

終了日

time_zone
string <time-numoffset> (SearchTimeZone)
Default: "+00:00"

タイムゾーン

order
string (SearchOrder)
Default: "ASC"
Enum: "ASC" "DESC"

ソート順

_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_log_type[]
string (ZonesLogsType)
Enum: "service" "record" "dnssec"

詳細説明はこちら

_keywords_operator[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_operation[]
string (ZonesLogsOperation)
Enum: "updating_default_ttl" "dismiss_default_ttl_change" "update_dnssec_configuration" "begin_ksk_rollover" "adding_record" "updating_record" "deleting_record" "dismiss_record_change" "update_zone_proxy" "update_zone_description" "update_zone_favorite" "update_zone_labels" "commit_zone" "upload_zone" "dismiss_zone_edits" "bulk_update_records" "upsert_subdomain_ns_records" "create_delegations"

詳細説明はこちら

_keywords_target[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_detail[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_request_id[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_status[]
string (ZonesLogsStatus)
Enum: "start" "success" "failure" "retry"

詳細説明はこちら

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

ゾーン操作ログの件数取得

ゾーンを操作したログの件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
start_date
string <full-date> (SearchDate)
Default: ""

開始日

end_date
string <full-date> (SearchDate)
Default: ""

終了日

time_zone
string <time-numoffset> (SearchTimeZone)
Default: "+00:00"

タイムゾーン

_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_log_type[]
string (ZonesLogsType)
Enum: "service" "record" "dnssec"

詳細説明はこちら

_keywords_operator[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_operation[]
string (ZonesLogsOperation)
Enum: "updating_default_ttl" "dismiss_default_ttl_change" "update_dnssec_configuration" "begin_ksk_rollover" "adding_record" "updating_record" "deleting_record" "dismiss_record_change" "update_zone_proxy" "update_zone_description" "update_zone_favorite" "update_zone_labels" "commit_zone" "upload_zone" "dismiss_zone_edits" "bulk_update_records" "upsert_subdomain_ns_records" "create_delegations"

詳細説明はこちら

_keywords_target[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_detail[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_request_id[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_status[]
string (ZonesLogsStatus)
Enum: "start" "success" "failure" "retry"

詳細説明はこちら

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

records

契約に紐付くゾーンのレコード操作ができます。
レコード操作の状態(state)は以下のとおりです。

state

意味 備考
0 反映済み
1 追加予定
2 削除予定
3 更新予定
5 更新前の状態

レコードの一覧取得

レコード情報の一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_ttl[]
integer or null (RecordsTtl) [ 1 .. 2147483647 ]
Default: null

TTL

_keywords_rrtype[]
string (RecordsRrtype)
Enum: "A" "AAAA" "ANAME" "CAA" "CNAME" "DS" "HTTPS" "MX" "NAPTR" "NS" "PTR" "SOA" "SRV" "SVCB" "TLSA" "TXT"

レコードタイプ

_keywords_rdata[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_operator[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

レコードの一括更新

レコードを一括更新します。
編集中レコードのゾーン反映を実行するまでは権威サーバには反映されません。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
required
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "records": [
    ]
}

Response samples

Content type
application/json
{}

レコードの作成

新しくレコードを作成します。
編集中レコードのゾーン反映を実行するまでは権威サーバには反映されません。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
name
required
string (RecordsName) [ 1 .. 255 ] characters

name

rrtype
required
string
Enum: "A" "AAAA" "CAA" "CNAME" "DS" "NS" "MX" "NAPTR" "SRV" "TXT" "TLSA" "ANAME" "PTR"

レコードタイプ

required
Array of objects (RecordsRdata) non-empty

レコードの値

ttl
integer or null (RecordsTtl) [ 1 .. 2147483647 ]
Default: null

TTL

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

object (RecordLabels) [ 0 .. 10 ] properties
Default: {}

ラベル

Responses

Request samples

Content type
application/json
{
  • "name": "example.com",
  • "rrtype": "A",
  • "rdata": [
    ],
  • "description": ""
}

Response samples

Content type
application/json
{}

レコードの件数取得

レコード情報の件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_ttl[]
integer or null (RecordsTtl) [ 1 .. 2147483647 ]
Default: null

TTL

_keywords_rrtype[]
string (RecordsRrtype)
Enum: "A" "AAAA" "ANAME" "CAA" "CNAME" "DS" "HTTPS" "MX" "NAPTR" "NS" "PTR" "SOA" "SRV" "SVCB" "TLSA" "TXT"

レコードタイプ

_keywords_rdata[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_operator[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

DNS反映済レコードの一覧取得

現在DNSに登録されているレコードの一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_ttl[]
integer or null (RecordsTtl) [ 1 .. 2147483647 ]
Default: null

TTL

_keywords_rrtype[]
string (RecordsRrtype)
Enum: "A" "AAAA" "ANAME" "CAA" "CNAME" "DS" "HTTPS" "MX" "NAPTR" "NS" "PTR" "SOA" "SRV" "SVCB" "TLSA" "TXT"

レコードタイプ

_keywords_rdata[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_operator[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

DNS反映済レコードの件数取得

現在DNSに登録されているレコードの件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_ttl[]
integer or null (RecordsTtl) [ 1 .. 2147483647 ]
Default: null

TTL

_keywords_rrtype[]
string (RecordsRrtype)
Enum: "A" "AAAA" "ANAME" "CAA" "CNAME" "DS" "HTTPS" "MX" "NAPTR" "NS" "PTR" "SOA" "SRV" "SVCB" "TLSA" "TXT"

レコードタイプ

_keywords_rdata[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_operator[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

レコードの編集差分の一覧取得

現在DNSに登録されているレコードと反映予定のレコードの差分一覧を取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_ttl[]
integer or null (RecordsTtl) [ 1 .. 2147483647 ]
Default: null

TTL

_keywords_rrtype[]
string (RecordsRrtype)
Enum: "A" "AAAA" "ANAME" "CAA" "CNAME" "DS" "HTTPS" "MX" "NAPTR" "NS" "PTR" "SOA" "SRV" "SVCB" "TLSA" "TXT"

レコードタイプ

_keywords_rdata[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

レコードの編集差分の件数取得

現在DNSに登録されているレコードと反映予定のレコードの差分数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_ttl[]
integer or null (RecordsTtl) [ 1 .. 2147483647 ]
Default: null

TTL

_keywords_rrtype[]
string (RecordsRrtype)
Enum: "A" "AAAA" "ANAME" "CAA" "CNAME" "DS" "HTTPS" "MX" "NAPTR" "NS" "PTR" "SOA" "SRV" "SVCB" "TLSA" "TXT"

レコードタイプ

_keywords_rdata[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

レコードの取得

指定したRecordIdのレコードを取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

RecordId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

レコードの更新

指定したRecordIdのレコードを更新します。
編集中レコードのゾーン反映を実行するまでは権威サーバには反映されません。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

RecordId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
ttl
integer or null (RecordsTtl) [ 1 .. 2147483647 ]
Default: null

TTL

Array of objects (RecordsRdata) non-empty

レコードの値

object (RecordLabels) [ 0 .. 10 ] properties
Default: {}

ラベル

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "ttl": 12345678
}

Response samples

Content type
application/json
{}

レコードの削除

指定したRecordIdのレコードを削除します。
編集中レコードのゾーン反映を実行するまでは権威サーバには反映されません。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

RecordId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{}

編集中レコードの取消

指定したRecordIdのレコードの操作を取消します。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

RecordId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{}

CDS経由のDSレコードの取得

指定したRecordIdのレコードによって取り込まれるCDS経由のDSレコードを取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

RecordId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

zone_histories

当日を含めて90日前までのゾーン反映の履歴を確認できます。
確認のタイミングにより、それ以前の履歴を確認できる場合があります。

ゾーン反映履歴の一覧取得

ゾーン反映の履歴の一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_operator[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
order
string (SearchOrder)
Default: "ASC"
Enum: "ASC" "DESC"

ソート順

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

ゾーン反映履歴の件数取得

ゾーン反映の履歴の件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_operator[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

ゾーン反映時のRFC1035形式のテキストの取得

ゾーン反映の履歴をRFC1035形式のテキストファイルで取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

ZoneHistoryId
required
integer <int64> (Id) >= 1

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

zone_proxy

ゾーンプロキシの操作ができます。
ゾーンプロキシの状態(enabled)、ゾーン転送の状態(state)は以下のとおりです。

enabled

意味 備考
0 無効
1 有効

state

意味 備考
OK ゾーン転送成功
NG ゾーン転送失敗

ゾーンプロキシ設定の取得

ゾーンプロキシの設定を取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

ゾーンプロキシ設定の更新

ゾーンプロキシの設定を更新します。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
enabled
required
integer (ZoneProxyEnabled)
Enum: 0 1

詳細説明はこちら

Responses

Request samples

Content type
application/json
{
  • "enabled": 0
}

Response samples

Content type
application/json
{}

プライマリネームサーバのヘルスチェック結果の取得

ゾーン転送のヘルスチェック結果の一覧を取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

zones

DPF契約に紐付くゾーンの操作ができます。
ゾーンの状態(state)、お気に入りの状態(favorite)、ゾーンプロキシの状態(zone_proxy_enabled)は以下のとおりです。

state

意味 備考
1 公開前
2 公開

favorite

意味 備考
1 表示優先度高
2 表示優先度低

zone_proxy_enabled

意味 備考
0 無効
1 有効

ゾーンの一覧取得

DPF契約に紐付くゾーンの一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_service_code[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_network[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_state[]
integer (ZonesState)
Enum: 1 2

詳細説明はこちら

_keywords_favorite[]
integer (ZonesFavorite)
Enum: 1 2

詳細説明はこちら

_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_common_config_id[]
Array of integers <int64> (KeywordsId) >= 0 items [ items <int64 > >= 1 ]
Default: []
_keywords_zone_proxy_enabled[]
integer (ZoneProxyEnabled)
Enum: 0 1

詳細説明はこちら

_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

ゾーンの件数取得

DPF契約に紐付くゾーンの件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_service_code[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_network[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_state[]
integer (ZonesState)
Enum: 1 2

詳細説明はこちら

_keywords_favorite[]
integer (ZonesFavorite)
Enum: 1 2

詳細説明はこちら

_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_common_config_id[]
Array of integers <int64> (KeywordsId) >= 0 items [ items <int64 > >= 1 ]
Default: []
_keywords_zone_proxy_enabled[]
integer (ZoneProxyEnabled)
Enum: 0 1

詳細説明はこちら

_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

ゾーンの取得

指定したZoneIdのゾーンを取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

ゾーンの更新

指定したZoneIdのゾーンを更新します。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
favorite
integer (ZonesFavorite)
Enum: 1 2

詳細説明はこちら

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "favorite": 2
}

Response samples

Content type
application/json
{}

ゾーンのラベル一覧取得

指定したZoneIdのラベルの一覧を取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

ゾーンのラベル一括更新

指定したZoneIdのラベルを一括更新します。
エラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
required
object [ 0 .. 10 ] properties
Default: {}

ラベル

Responses

Request samples

Content type
application/json
{
  • "labels": {
    }
}

Response samples

Content type
application/json
{}

編集中レコードのゾーン反映

編集中のレコードの操作を反映します。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Request Body schema: application/json
description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "description": "description"
}

Response samples

Content type
application/json
{}

編集中レコードの一括取消

編集中のレコードの操作を一括で取り消します。

Authorizations:
DPFOperator
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{}

ゾーンに紐付くDPF契約情報の取得

指定したZoneIdのゾーンに紐付くDPF契約情報を取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

マネージドDNSサーバの一覧取得

指定したZoneIdのマネージドDNSサーバの一覧を取得します。

Authorizations:
DPFViewer
path Parameters
ZoneId
required
string (SystemId) = 14 characters

ID

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

config

LBドメインに紐付く設定と状態の操作ができます。

設定の一覧取得

設定の一覧を取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

設定の一括更新

設定を一括更新します。
エラー発生時はErrorDetailsにJSONPath形式のtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Request Body schema: application/json
required
Array of objects [ 0 .. 50 ] items
required
Array of objects [ 0 .. 50 ] items
required
Array of objects [ 1 .. 10 ] items

Responses

Request samples

Content type
application/json
{
  • "monitorings": [
    ],
  • "sites": [
    ],
  • "rules": [
    ]
}

Response samples

Content type
application/json
{}

endpoints

サイトに紐付くエンドポイントの操作ができます。

エンドポイントの一覧取得

エンドポイントの一覧を取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

SiteResourceName
required
string (ResourceName) <= 253 characters

GET sites Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

エンドポイントの作成

新しくエンドポイントを作成します。
作成できる最大件数は50件です。
エラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

SiteResourceName
required
string (ResourceName) <= 253 characters

GET sites Schemaにおける resource_name

Request Body schema: application/json
name
required
string (EndpointName) [ 1 .. 80 ] characters

エンドポイント名

weight
required
integer (EndpointWeight) [ 1 .. 255 ]

weight

required
Array of objects (EndpointRdata) [ 1 .. 10 ] items

RDATA

resource_name
string (ResourceName) <= 253 characters

登録可能な文字列はこちらのホスト名の共通ルールを参照してください。

monitoring_target
string (EndpointMonitoringTarget) <= 254 characters
Default: ""

監視ターゲット(IPアドレス形式かホスト名形式)

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

manual_failback
boolean (EndpointManualFailback)
Default: false

手動切り戻し設定値

manual_failover
boolean (EndpointManualFailover)
Default: false

手動切り離し設定値

enabled
boolean (EndpointEnabled)
Default: false

状態

Array of objects
Default: []

Responses

Request samples

Content type
application/json
{
  • "name": "endpoint002",
  • "weight": 1,
  • "description": "",
  • "rdata": [
    ]
}

Response samples

Content type
application/json
{}

エンドポイントの取得

指定したEndpointResourceNameのエンドポイントを取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

SiteResourceName
required
string (ResourceName) <= 253 characters

GET sites Schemaにおける resource_name

EndpointResourceName
required
string (ResourceName) <= 253 characters

GET endpoints Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

エンドポイントの更新

指定したEndpointResourceNameのエンドポイントを更新します。
エラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

SiteResourceName
required
string (ResourceName) <= 253 characters

GET sites Schemaにおける resource_name

EndpointResourceName
required
string (ResourceName) <= 253 characters

GET endpoints Schemaにおける resource_name

Request Body schema: application/json
name
string (EndpointName) [ 1 .. 80 ] characters

エンドポイント名

monitoring_target
string <= 254 characters

監視ターゲット(IPアドレス形式かホスト名形式)

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

weight
integer (EndpointWeight) [ 1 .. 255 ]

weight

manual_failback
boolean

手動切り戻し設定値

manual_failover
boolean

手動切り離し設定値

enabled
boolean

状態

Array of objects (EndpointRdata) [ 1 .. 10 ] items

RDATA

Array of objects

Responses

Request samples

Content type
application/json
{
  • "weight": 255
}

Response samples

Content type
application/json
{}

エンドポイントの削除

指定したEndpointResourceNameのエンドポイントを削除します。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

SiteResourceName
required
string (ResourceName) <= 253 characters

GET sites Schemaにおける resource_name

EndpointResourceName
required
string (ResourceName) <= 253 characters

GET endpoints Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{}

エンドポイントの手動切り離し

指定したEndpointResourceNameのエンドポイントの手動切り離しを実行します。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

SiteResourceName
required
string (ResourceName) <= 253 characters

GET sites Schemaにおける resource_name

EndpointResourceName
required
string (ResourceName) <= 253 characters

GET endpoints Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{}

エンドポイントの手動切り戻し

指定したEndpointResourceNameのエンドポイントの手動切り戻しを実行します。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

SiteResourceName
required
string (ResourceName) <= 253 characters

GET sites Schemaにおける resource_name

EndpointResourceName
required
string (ResourceName) <= 253 characters

GET endpoints Schemaにおける resource_name

Request Body schema: application/json
force
boolean (EndpointForce)
Default: false

指定することで Live Status が down であっても手動切り戻しが可能

Responses

Request samples

Content type
application/json
{
  • "force": true
}

Response samples

Content type
application/json
{}

lb_domains

DPF契約に紐付くLBドメインの操作ができます。
LBドメインの状態(state)、お気に入りの状態(favorite)は以下のとおりです。

state

意味 備考
1 公開前
2 公開

favorite

意味 備考
1 表示優先度高
2 表示優先度低

LBドメインの一覧取得

DPF契約に紐付くLBドメインの一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。
エラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFViewer
query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_service_code[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_state[]
Array of integers (KeywordsLbDomainState) >= 0 items
Default: []
Items Enum: 1 2

詳細説明はこちら

_keywords_favorite[]
Array of integers (KeywordsLbDomainFavorite) >= 0 items
Default: []
Items Enum: 1 2

詳細説明はこちら

_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_common_config_id[]
Array of integers <int64> (KeywordsId) >= 0 items [ items <int64 > >= 1 ]
Default: []
_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

LBドメインの件数取得

DPF契約に紐付くLBドメインの件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。
エラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFViewer
query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_service_code[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_state[]
Array of integers (KeywordsLbDomainState) >= 0 items
Default: []
Items Enum: 1 2

詳細説明はこちら

_keywords_favorite[]
Array of integers (KeywordsLbDomainFavorite) >= 0 items
Default: []
Items Enum: 1 2

詳細説明はこちら

_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_common_config_id[]
Array of integers <int64> (KeywordsId) >= 0 items [ items <int64 > >= 1 ]
Default: []
_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

LBドメインの取得

指定したLbDomainIdのLBドメインを取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

LBドメインの更新

指定したLbDomainIdのLBドメインを更新します。
RuleResourceNameを指定することで適用ルールの切り替えができます。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Request Body schema: application/json
favorite
integer (LbDomainFavorite)
Enum: 1 2

詳細説明はこちら

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

rule_resource_name
string (ResourceName) <= 253 characters

登録可能な文字列はこちらのホスト名の共通ルールを参照してください。

Responses

Request samples

Content type
application/json
{
  • "favorite": 2
}

Response samples

Content type
application/json
{}

LBドメインのラベル一覧取得

指定したLbDomainIdのラベルの一覧を取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

LBドメインのラベル一括更新

指定したLbDomainIdのラベルを一括更新します。
エラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Request Body schema: application/json
required
object
Default: {}

ラベル

Responses

Request samples

Content type
application/json
{
  • "labels": {
    }
}

Response samples

Content type
application/json
{}

LBドメインに紐付くDPF契約情報の取得

指定したLbDomainIdのLBドメインに紐付くDPF契約情報を取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

logs (lb_domains)

契約に紐付くLBドメインを操作したログを取得できます。
取得可能なログは90日前までとなります。
操作内容(operation)、ログの種別(log_type)、処理の状態(status)は以下のとおりです。

operation

意味 備考
update_lb_domain_description トラフィックコントロール契約のコメントの更新
update_lb_domain_favorite トラフィックコントロール契約のお気に入り状態の切り替え
update_lb_domain_labels トラフィックコントロール契約のラベルの更新
update_lb_domain_rule 適用ルールの切り替え
add_rule ルールの追加
update_rule ルールの更新
delete_rule ルールの削除
add_rule_method ルールメソッドの追加
update_rule_method ルールメソッドの更新
delete_rule_method ルールメソッドの削除
add_site サイトの追加
update_site サイトの更新
delete_site サイトの削除
add_endpoint エンドポイントの追加
update_endpoint エンドポイントの更新
delete_endpoint エンドポイントの削除
manual_failover エンドポイントの手動切り離し
manual_failback エンドポイントの手動切り戻し
add_monitoring 監視の追加
update_monitoring 監視の更新
delete_monitoring 監視の削除
file_import ファイルインポート
monitoring_result_changed 監視結果の更新
endpoint_live_status_changed エンドポイントLiveStatusの更新
endpoint_ready_status_changed エンドポイントReadyStatusの更新
site_live_status_changed サイトLiveStatusの更新

log_type

意味 備考
service サービス設定の操作
rule ルールの操作
site サイトの操作
monitoring 監視の操作
file ファイル設定の操作
monitoring_event 監視イベントの操作

status

意味 備考
start 処理開始
success 処理正常終了
failure 処理失敗
retry リトライ

LBドメイン操作ログの一覧取得

LBドメインを操作したログの一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchLogsOffset) [ 0 .. 9900 ]
Default: 0
limit
integer <int32> (SearchLogsLimit) [ 1 .. 100 ]
Default: 100
start_date
string <full-date> (SearchDate)
Default: ""

開始日

end_date
string <full-date> (SearchDate)
Default: ""

終了日

time_zone
string <time-numoffset> (SearchTimeZone)
Default: "+00:00"

タイムゾーン

order
string (SearchOrder)
Default: "ASC"
Enum: "ASC" "DESC"

ソート順

_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_log_type[]
Array of strings (SearchLbDomainsLogsType) >= 0 items
Default: []
Items Enum: "service" "rule" "site" "monitoring" "file" "monitoring_event"

詳細説明はこちら

_keywords_operator[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_operation[]
Array of strings (SearchLbDomainsLogsOperation) >= 0 items
Default: []
Items Enum: "update_lb_domain_description" "update_lb_domain_favorite" "update_lb_domain_labels" "update_lb_domain_rule" "add_rule" "update_rule" "delete_rule" "add_rule_method" "update_rule_method" "delete_rule_method" "add_site" "update_site" "delete_site" "add_endpoint" "update_endpoint" "delete_endpoint" "manual_failover" "manual_failback" "add_monitoring" "update_monitoring" "delete_monitoring" "file_import" "monitoring_result_changed" "endpoint_live_status_changed" "endpoint_ready_status_changed" "site_live_status_changed"

詳細説明はこちら

_keywords_target[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_detail[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_request_id[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_status[]
Array of strings (SearchLbDomainsLogsStatus) >= 0 items
Default: []
Items Enum: "start" "success" "failure" "retry"

詳細説明はこちら

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

LBドメイン操作ログの件数取得

LBドメインを操作したログの件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
start_date
string <full-date> (SearchDate)
Default: ""

開始日

end_date
string <full-date> (SearchDate)
Default: ""

終了日

time_zone
string <time-numoffset> (SearchTimeZone)
Default: "+00:00"

タイムゾーン

_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_log_type[]
Array of strings (SearchLbDomainsLogsType) >= 0 items
Default: []
Items Enum: "service" "rule" "site" "monitoring" "file" "monitoring_event"

詳細説明はこちら

_keywords_operator[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_operation[]
Array of strings (SearchLbDomainsLogsOperation) >= 0 items
Default: []
Items Enum: "update_lb_domain_description" "update_lb_domain_favorite" "update_lb_domain_labels" "update_lb_domain_rule" "add_rule" "update_rule" "delete_rule" "add_rule_method" "update_rule_method" "delete_rule_method" "add_site" "update_site" "delete_site" "add_endpoint" "update_endpoint" "delete_endpoint" "manual_failover" "manual_failback" "add_monitoring" "update_monitoring" "delete_monitoring" "file_import" "monitoring_result_changed" "endpoint_live_status_changed" "endpoint_ready_status_changed" "site_live_status_changed"

詳細説明はこちら

_keywords_target[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_detail[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_request_id[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_status[]
Array of strings (SearchLbDomainsLogsStatus) >= 0 items
Default: []
Items Enum: "start" "success" "failure" "retry"

詳細説明はこちら

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

monitorings

LBドメインに紐付く監視の操作ができます。

監視の一覧取得

監視の一覧を取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

監視の作成

新しく監視を作成します。
作成できる最大件数は50件です。
エラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Request Body schema: application/json
Any of
name
required
string (MonitoringName) [ 1 .. 80 ] characters

監視名

mtype
required
string
Value: "ping"
resource_name
string (ResourceName) <= 253 characters

登録可能な文字列はこちらのホスト名の共通ルールを参照してください。

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

object

Responses

Request samples

Content type
application/json
Example
{
  • "name": "monitoring-ping",
  • "mtype": "ping",
  • "props": {
    }
}

Response samples

Content type
application/json
{}

監視の取得

指定したMonitoringResourceNameの監視を取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

MonitoringResourceName
required
string (ResourceName) <= 253 characters

GET monitorings Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

監視の更新

指定したMonitoringResourceNameの監視を更新します。
エラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

MonitoringResourceName
required
string (ResourceName) <= 253 characters

GET monitorings Schemaにおける resource_name

Request Body schema: application/json
Any of
name
string (MonitoringName) [ 1 .. 80 ] characters

監視名

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

object

Responses

Request samples

Content type
application/json
Example
{
  • "props": {
    }
}

Response samples

Content type
application/json
{}

監視の削除

指定したMonitoringResourceNameの監視を削除します。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

MonitoringResourceName
required
string (ResourceName) <= 253 characters

GET monitorings Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{}

rule_methods

ルールに紐付くルールメソッドの操作ができます。

ルールメソッドの一覧取得

ルールメソッドの一覧を取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

RuleResourceName
required
string (ResourceName) <= 253 characters

GET rules Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

ルールメソッドの作成

新しくルールメソッドを作成します。
作成できるメソッドは最大6階層です。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

RuleResourceName
required
string (ResourceName) <= 253 characters

GET rules Schemaにおける resource_name

Request Body schema: application/json
required
object
priority
integer (RuleMethodPriority) [ 0 .. 255 ]

優先度(親メソッドが failover の場合のみ指定)

Responses

Request samples

Content type
application/json
{
  • "method": {
    }
}

Response samples

Content type
application/json
{}

ルールメソッドの取得

指定したRuleMethodResourceNameのルールメソッドを取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

RuleResourceName
required
string (ResourceName) <= 253 characters

GET rules Schemaにおける resource_name

RuleMethodResourceName
required
string (ResourceName) <= 253 characters

GET rule_methods Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

ルールメソッドの更新

指定したRuleMethodResourceNameのルールメソッドを更新します。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

RuleResourceName
required
string (ResourceName) <= 253 characters

GET rules Schemaにおける resource_name

RuleMethodResourceName
required
string (ResourceName) <= 253 characters

GET rule_methods Schemaにおける resource_name

Request Body schema: application/json
priority
integer (RuleMethodPriority) [ 0 .. 255 ]

優先度(親メソッドが failover の場合のみ指定)

object

Responses

Request samples

Content type
application/json
{
  • "method": {
    }
}

Response samples

Content type
application/json
{}

ルールメソッドの削除

指定したRuleMethodResourceNameのルールメソッドを削除します。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

RuleResourceName
required
string (ResourceName) <= 253 characters

GET rules Schemaにおける resource_name

RuleMethodResourceName
required
string (ResourceName) <= 253 characters

GET rule_methods Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{}

rules

LBドメインに紐付くルールの操作ができます。
適用ルールはLBドメインの更新で切り替えができます。

ルールの一覧取得

ルールの一覧を取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

ルールの作成

新しくルールを作成します。
作成できる最大件数は10件です。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Request Body schema: application/json
name
required
string (RuleName) [ 1 .. 80 ] characters

ルール名

resource_name
string (ResourceName) <= 253 characters

登録可能な文字列はこちらのホスト名の共通ルールを参照してください。

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "name": "rule001",
  • "description": ""
}

Response samples

Content type
application/json
{}

ルールの取得

指定したRuleResourceNameのルールを取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

RuleResourceName
required
string (ResourceName) <= 253 characters

GET rules Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

ルールの更新

指定したRuleResourceNameのルールを更新します。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

RuleResourceName
required
string (ResourceName) <= 253 characters

GET rules Schemaにおける resource_name

Request Body schema: application/json
name
string (RuleName) [ 1 .. 80 ] characters

ルール名

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "name": "rule002"
}

Response samples

Content type
application/json
{}

ルールの削除

指定したRuleResourceNameのルールを削除します。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

RuleResourceName
required
string (ResourceName) <= 253 characters

GET rules Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{}

sites

LBドメインに紐付くサイトの操作ができます。

サイトの一覧取得

サイトの一覧を取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

サイトの作成

新しくサイトを作成します。
作成できる最大件数は50件です。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

Request Body schema: application/json
name
required
string (SiteName) [ 1 .. 80 ] characters

サイト名

rrtype
required
string (SiteRrtype)
Enum: "A" "AAAA" "CNAME"

レコードタイプ

resource_name
string (ResourceName) <= 253 characters

登録可能な文字列はこちらのホスト名の共通ルールを参照してください。

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "name": "site001",
  • "rrtype": "A",
  • "description": ""
}

Response samples

Content type
application/json
{}

サイトの取得

指定したSiteResourceNameのサイトを取得します。

Authorizations:
DPFViewer
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

SiteResourceName
required
string (ResourceName) <= 253 characters

GET sites Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

サイトの更新

指定したSiteResourceNameのサイトを更新します。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

SiteResourceName
required
string (ResourceName) <= 253 characters

GET sites Schemaにおける resource_name

Request Body schema: application/json
name
string (SiteName) [ 1 .. 80 ] characters

サイト名

description
string (Description) [ 0 .. 80 ] characters
Default: ""

コメント

Responses

Request samples

Content type
application/json
{
  • "name": "site002"
}

Response samples

Content type
application/json
{}

サイトの削除

指定したSiteResourceNameのサイトを削除します。

Authorizations:
DPFOperator
path Parameters
LbDomainId
required
string (SystemId) = 14 characters

GET lb_domains Schemaにおける id

SiteResourceName
required
string (ResourceName) <= 253 characters

GET sites Schemaにおける resource_name

Responses

Response samples

Content type
application/json
{}

delegations

ネームサーバ申請の操作ができます。
お気に入りの状態(favorite)、ネームサーバの状態(requested)は以下のとおりです。

favorite

意味 備考
1 表示優先度高
2 表示優先度低

requested

意味 備考
0 未申請
1 申請済み

ネームサーバ申請候補の一覧取得

ネームサーバとして申請可能なゾーンの候補の一覧を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
offset
integer <int32> (SearchOffset) [ 0 .. 10000000 ]
Default: 0
limit
integer <int32> (SearchLimit) [ 1 .. 10000 ]
Default: 100
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_service_code[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_network[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_favorite[]
integer (ZonesFavorite)
Enum: 1 2

詳細説明はこちら

_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_requested[]
integer (DelegationsRequested)
Enum: 0 1

詳細説明はこちら

_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "results": [
    ]
}

ネームサーバ申請

指定したゾーンを申請します。

Authorizations:
DPFOperator
Request Body schema: application/json
zone_ids
required
Array of strings (SystemId) non-empty [ items = 14 characters ]

Responses

Request samples

Content type
application/json
{
  • "zone_ids": [
    ]
}

Response samples

Content type
application/json
{}

ネームサーバ申請候補の件数取得

ネームサーバとして申請可能なゾーンの候補の件数を取得します。
"_keywords" から始まるパラメータは、合計で30個まで指定可能です。

Authorizations:
DPFViewer
query Parameters
type
string (SearchType)
Default: "AND"
Enum: "AND" "OR"
_keywords_full_text[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_service_code[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_name[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_network[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_favorite[]
integer (ZonesFavorite)
Enum: 1 2

詳細説明はこちら

_keywords_description[]
Array of strings (KeywordsString) >= 0 items [ items <= 381 characters ]
Default: []
_keywords_requested[]
integer (DelegationsRequested)
Enum: 0 1

詳細説明はこちら

_keywords_label[]
Array of strings (KeywordsLabel) >= 0 items [ items <= 381 characters ]
Default: []

Valueは「labelのKey=labelのValue」のようにイコール区切りで指定

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "result": {
    }
}

jobs

非同期リクエストの状態確認ができます。
リクエストの状態(status)は以下のとおりです。

status

意味 備考
RUNNING 処理中
SUCCESSFUL 正常終了
FAILED 異常終了

非同期リクエストの状態確認

ジョブの進捗状況を取得します。
このAPIの詳しい利用方法は、非同期リクエストを参照してください。

Authorizations:
DPFViewer
path Parameters
RequestId
required
string (RequestId) = 32 characters

ID

Responses

Response samples

Content type
application/json
Example
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660",
  • "status": "RUNNING"
}

ping

API疎通確認

APIへの疎通を確認できます。

Authorizations:
DPFViewerDPFOperatorContractOperator

Responses

Response samples

Content type
application/json
{
  • "request_id": "782d746ac3cb46499b31708fa80e8660"
}
to top