From 3a1eee703a98720879405bc1db2f7913ef614bd3 Mon Sep 17 00:00:00 2001 From: manabu-s Date: Wed, 25 Oct 2023 15:31:07 +0900 Subject: [PATCH] update to phase 3.2.0 --- swagger.json | 4140 ++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 3209 insertions(+), 931 deletions(-) diff --git a/swagger.json b/swagger.json index 2b50fb9..42cd14a 100644 --- a/swagger.json +++ b/swagger.json @@ -3,7 +3,11 @@ "info": { "title": "DPF-APIリファレンスマニュアル", "version": "1.0", - "description": "# 1. はじめに\n\n## 1.1 DPF-APIについて\nIIJ DNSプラットフォームサービスでは、DNSレコードやゾーン情報などを、\\\nお客様が用意したプログラムから自動的に操作するためのAPI機能を提供しています。\\\n以降、IIJ DNSプラットフォームサービスを「DPF」、DPFが提供するAPIを「DPF-API」あるいは単に「API」と表記します。\\\nDPF-APIの利用には、DPFの契約とIIJ IDサービスの契約が必要となります。\n\n本リファレンスマニュアルは**[OpenAPI](https://www.openapis.org/)**に準拠しています。\n\n## 1.2 サポート範囲\nDPF-APIを呼び出すためのプログラム、及びそのプログラムを稼働させるためのサーバは、お客様にてご用意ください。\\\nお客様にご用意いただくプログラムの開発、利用、動作についてのお問い合わせは承ることができません。\n\n以下の事項についてのお問い合わせは、弊社**[サポートセンター](https://help.iij.ad.jp/)**にて承ります。\n- DPF-APIの挙動が本リファレンスマニュアルと異なる場合\n- DPF-APIがシステムエラーを応答した場合\n\n## 1.3 参考資料\n- IIJ DNSプラットフォームサービス オンラインマニュアル\n - [https://manual.iij.jp/dpf/help/](https://manual.iij.jp/dpf/help/)\n\n- IIJ IDサービス オンラインマニュアル\n - [https://manual.iij.jp/iid/admin-help/](https://manual.iij.jp/iid/admin-help/)\n\n# 2. 利用方法\nDPF-APIは、URLとHTTPリクエストヘッダ、HTTPリクエストボディでパラメータを指定して利用します。\\\nまた、IIJ IDサービスのアクセストークンと管理対象の権限設定が必要です。\n\n## 2.1 リクエスト仕様\n\n項目 | 規格\n-----|-----\nプロトコル | HTTP/1.1、HTTP/2（https）\nHTTPメソッド | GET、POST、PATCH、PUT、DELETE\nフォーマット | JSON\n文字コード | UTF-8\nタイムアウト | 300秒\n\n- httpでのリクエストは受け付けません。必ずhttpsを使用してください。\n- DPF-APIを呼び出すプログラムは、リクエスト先が正当なものであることを確認するため、SSL証明書を検証することを推奨します。\n- 短期間に極めて多数のリクエストが行われた場合、サービスの健全性を保つためにリクエストを制限する場合があります。\n\n### アクセストークン\nAPIリクエストの際にIIJ IDサービスによって発行されたアクセストークンをAuthorizationヘッダに指定する必要があります。\\\n各APIにより必要となるアクセス権の範囲（許可するスコープ）が異なるのでご注意ください。\n\nアクセストークン作成時に指定できる「許可するスコープ」は以下のとおりです。\n\n許可するスコープ | 実行できるAPI\n-----------------|------------\ndpf_read | 参照系API\ndpf_write | 更新系、及び参照系API\ndpf_contract | 契約系API\n\n発行済のアクセストークンは、**[IIJ IDサービス](https://www.auth.iij.jp/console/)**の「アクセストークンの管理」より確認できます。\\\nDPF-APIを利用する場合は「利用するリソースサーバ」の設定で「IIJ DNSサービスAPI」を選択してください。\\\nアクセストークン管理方法のマニュアルは**[こちら](https://manual.iij.jp/iid/admin-help/9054382.html)**を参照してください。\n\n### 管理対象の権限設定\nDPFでは、管理対象となる契約単位での参照、編集権限を細かく設定できます。\\\nアクセストークンの許可するスコープが適切であっても、管理対象の権限が付与されていない場合はAPIを実行できません。\\\n管理対象の権限設定のマニュアルは**[こちら](https://manual.iij.jp/dpf/help/19004706.html#IIJID%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%81%A8%E9%80%A3%E6%90%BA%E3%81%99%E3%82%8B-IIJID%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88%E3%81%B8%E7%AE%A1%E7%90%86%E6%A8%A9%E9%99%90%E3%82%92%E4%BB%98%E4%B8%8E%E3%81%99%E3%82%8B)**を参照してください。\n\n## 2.2 HTTPリクエスト\n\n### 例\n```\n /dpf// HTTP/1.1\nHost: api.dns-platform.jp\nAuthorization: Bearer \nContent-Type: application/json; charset=UTF-8\n\n\n```\n\n### リクエストパラメータ\nDPF-APIで指定するパラメータは以下のとおりです。\\\nリクエストパラメータに同一のキーが含まれる場合の動作は保証されません。\n\n共通 | 指定箇所 | パラメータ | 意味\n-----|----------|------------|-----\n共通 | HTTPメソッド | HTTPメソッド | HTTPメソッド（値：GET、POST、PATCH、PUT、DELETE）\n共通 | URL | version | DPF-APIバージョン（値：v1）\n個別 | URL | APIパス | API名称やAPI個別のパラメータの組み合わせ（参照：**[API一覧](#section/3.-API)**）\n共通 | HTTPヘッダー | access_token | IIJ IDアクセストークン（参照：**[IIJ IDサービス](https://www.auth.iij.jp/console/)**）\n個別 | HTTPボディ | APIごとに異なる | JSON形式のパラメータ（参照：**[API一覧](#section/3.-API)**）\n\n## 2.3 HTTPレスポンス\n\n### 成功レスポンス\nAPIごとにレスポンスが異なりますので、**[該当のAPI](#section/3.-API)**を参照してください。\n\n### エラーレスポンス\nHTTPステータスコード、及びレスポンスボディによってクライアントプログラムにエラーを通知します。\n\n#### 例：アクセストークンが誤っている\n```\n{\n \"request_id\": \"782d746ac3cb46499b31708fa80e8660\",\n \"error_type\": \"ParameterError\",\n \"error_message\": \"There are invalid parameters.\",\n \"error_details\": [\n {\n \"code\": \"invalid\",\n \"attribute\": \"access_token\"\n }\n ]\n}\n```\n\n#### エラーコード一覧\nHTTP Status Code | error_type | error_message | code | attribute | 説明 | 対処方法\n-----------------|------------|---------------|------|-----------|------|---------\n400 | ParameterError | There are invalid parameters. | invalid | access_token | 指定したアクセストークンに誤りがあります | アクセストークンを確認してください\n400 | ParameterError | JSON parse error occurred. | - | - | パラメータとして不正なJSON文字列が指定されました | リクエストのパラメータを確認してください\n400 | ParameterError | There are invalid parameters. | （API個別） | （API個別） | 不正なパラメータが指定されました | 各APIのエラーコードを確認してください\n404 | NotFound | Specified resource not found. | - | - | アクセスURLが正しくありません
存在しないAPIが指定されました
指定された以外のHTTPメソッドが指定されました | 左記の内容を確認してください\n429 | TooManyRequests | Too many requests. | - | - | 大量のAPIリクエストが送信されました | 単位時間当たりのAPIリクエスト数を確認してください\n500 | SystemError | System error occurred. | - | - | システム障害が発生しました | **[サポートセンター](https://help.iij.ad.jp/)**へお問い合わせください\n504 | GatewayTimeout | Gateway timeout. | - | - | リクエストがタイムアウトしました | しばらく待ってから再度リクエストしてください\n\n## 2.4 非同期リクエスト\n\nDPF-APIにおけるGET以外のAPIは全て非同期APIです。\\\n非同期APIはリクエストを受け付けると即座にレスポンスを返却しますが、\\\nリクエストに対する実際の処理は非同期で行われます。\n\n非同期リクエストの受け付けに成功した場合のHTTPステータスコードは202で、\\\n返却されたレスポンスボディには、処理進捗を確認するためのURL（jobs_url）が含まれます。\\\nこのjobs_urlに対してGETリクエストをすることで進捗状況を確認できます。\n\n進捗状況を確認した際、非同期処理が正常に終了していた場合は、\\\n返却されたレスポンスボディには、対象リソースを取得するためのURL（resources_url）が含まれます。\\\nこのresources_urlに対してGETリクエストをすることで実行結果を確認できます。\n\n### 例\n#### 非同期リクエストのレスポンス\n```\nHTTP/1.1 202 Accepted\nDate: Mon, 26 Mar 20XX hh:mm:dd GMT\nContent-Type: application/json; charset=utf-8\n〜 略 〜\n\n{\n \"request_id\": \"782d746ac3cb46499b31708fa80e8660\",\n \"jobs_url\": \"https://api.dns-platform.jp/dpf//jobs/\"\n}\n```\n\n#### GETリクエスト\n```\nGET /dpf//jobs/ HTTP/1.1\nHost: api.dns-platform.jp\nAuthorization: Bearer \nContent-Type: application/json; charset=UTF-8\n\n{}\n```\n\n#### 進捗状況のレスポンス\n```\nHTTP/1.1 200 OK\nDate: Mon, 26 Mar 20XX hh:mm:dd GMT\nContent-Type: application/json; charset=utf-8\n〜 略 〜\n\n{\n \"request_id\": \"782d746ac3cb46499b31708fa80e8660\",\n \"resources_url\": ,\n \"status\": \"SUCCESSFUL\"\n}\n```\n\n# 3. API一覧\nDPF-APIではIIJ DNSプラットフォームサービスに関する以下の操作を行うことができます。\n\n## 3.1 IIJ DNSプラットフォームサービス\n\n### cc_notice_accounts\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/common_configs/{CommonConfigId}/cc_notice_accounts](#tag/cc_notice_accounts/paths/~1common_configs~1{CommonConfigId}~1cc_notice_accounts/get) | 通知先アカウント設定の一覧取得 | dpf_read\n POST | [/common_configs/{CommonConfigId}/cc_notice_accounts](#tag/cc_notice_accounts/paths/~1common_configs~1{CommonConfigId}~1cc_notice_accounts/post) | 通知先アカウント設定の作成 | dpf_write\n GET | [/common_configs/{CommonConfigId}/cc_notice_accounts/{CcNoticeAccountResourceName}](#tag/cc_notice_accounts/paths/~1common_configs~1{CommonConfigId}~1cc_notice_accounts~1{CcNoticeAccountResourceName}/get) | 通知先アカウント設定の取得 | dpf_read\n PATCH | [/common_configs/{CommonConfigId}/cc_notice_accounts/{CcNoticeAccountResourceName}](#tag/cc_notice_accounts/paths/~1common_configs~1{CommonConfigId}~1cc_notice_accounts~1{CcNoticeAccountResourceName}/patch) | 通知先アカウント設定の更新 | dpf_write\n DELETE | [/common_configs/{CommonConfigId}/cc_notice_accounts/{CcNoticeAccountResourceName}](#tag/cc_notice_accounts/paths/~1common_configs~1{CommonConfigId}~1cc_notice_accounts~1{CcNoticeAccountResourceName}/delete) | 通知先アカウント設定の削除 | dpf_write\n\n### cc_primaries\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/common_configs/{CommonConfigId}/cc_primaries](#tag/cc_primaries/paths/~1common_configs~1{CommonConfigId}~1cc_primaries/get) | プライマリネームサーバ設定の一覧取得 | dpf_read\n POST | [/common_configs/{CommonConfigId}/cc_primaries](#tag/cc_primaries/paths/~1common_configs~1{CommonConfigId}~1cc_primaries/post) | プライマリネームサーバ設定の作成 | dpf_write\n GET | [/common_configs/{CommonConfigId}/cc_primaries/{CcPrimaryId}](#tag/cc_primaries/paths/~1common_configs~1{CommonConfigId}~1cc_primaries~1{CcPrimaryId}/get) | プライマリネームサーバ設定の取得 | dpf_read\n PATCH | [/common_configs/{CommonConfigId}/cc_primaries/{CcPrimaryId}](#tag/cc_primaries/paths/~1common_configs~1{CommonConfigId}~1cc_primaries~1{CcPrimaryId}/patch) | プライマリネームサーバ設定の更新 | dpf_write\n DELETE | [/common_configs/{CommonConfigId}/cc_primaries/{CcPrimaryId}](#tag/cc_primaries/paths/~1common_configs~1{CommonConfigId}~1cc_primaries~1{CcPrimaryId}/delete) | プライマリネームサーバ設定の削除 | dpf_write\n\n### cc_sec_notified_servers\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/common_configs/{CommonConfigId}/cc_sec_notified_servers](#tag/cc_sec_notified_servers/paths/~1common_configs~1{CommonConfigId}~1cc_sec_notified_servers/get) | DNS NOTIFY設定の一覧取得 | dpf_read\n POST | [/common_configs/{CommonConfigId}/cc_sec_notified_servers](#tag/cc_sec_notified_servers/paths/~1common_configs~1{CommonConfigId}~1cc_sec_notified_servers/post) | DNS NOTIFY設定の作成 | dpf_write\n GET | [/common_configs/{CommonConfigId}/cc_sec_notified_servers/{CcSecNotifiedServerId}](#tag/cc_sec_notified_servers/paths/~1common_configs~1{CommonConfigId}~1cc_sec_notified_servers~1{CcSecNotifiedServerId}/get) | DNS NOTIFY設定の取得 | dpf_read\n PATCH | [/common_configs/{CommonConfigId}/cc_sec_notified_servers/{CcSecNotifiedServerId}](#tag/cc_sec_notified_servers/paths/~1common_configs~1{CommonConfigId}~1cc_sec_notified_servers~1{CcSecNotifiedServerId}/patch) | DNS NOTIFY設定の更新 | dpf_write\n DELETE | [/common_configs/{CommonConfigId}/cc_sec_notified_servers/{CcSecNotifiedServerId}](#tag/cc_sec_notified_servers/paths/~1common_configs~1{CommonConfigId}~1cc_sec_notified_servers~1{CcSecNotifiedServerId}/delete) | DNS NOTIFY設定の削除 | dpf_write\n\n### cc_sec_transfer_acls\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/common_configs/{CommonConfigId}/cc_sec_transfer_acls](#tag/cc_sec_transfer_acls/paths/~1common_configs~1{CommonConfigId}~1cc_sec_transfer_acls/get) | ゾーン転送ACLの一覧取得 | dpf_read\n POST | [/common_configs/{CommonConfigId}/cc_sec_transfer_acls](#tag/cc_sec_transfer_acls/paths/~1common_configs~1{CommonConfigId}~1cc_sec_transfer_acls/post) | ゾーン転送ACLの作成 | dpf_write\n GET | [/common_configs/{CommonConfigId}/cc_sec_transfer_acls/{CcSecTransferAclId}](#tag/cc_sec_transfer_acls/paths/~1common_configs~1{CommonConfigId}~1cc_sec_transfer_acls~1{CcSecTransferAclId}/get) | ゾーン転送ACLの取得 | dpf_read\n PATCH | [/common_configs/{CommonConfigId}/cc_sec_transfer_acls/{CcSecTransferAclId}](#tag/cc_sec_transfer_acls/paths/~1common_configs~1{CommonConfigId}~1cc_sec_transfer_acls~1{CcSecTransferAclId}/patch) | ゾーン転送ACLの更新 | dpf_write\n DELETE | [/common_configs/{CommonConfigId}/cc_sec_transfer_acls/{CcSecTransferAclId}](#tag/cc_sec_transfer_acls/paths/~1common_configs~1{CommonConfigId}~1cc_sec_transfer_acls~1{CcSecTransferAclId}/delete) | ゾーン転送ACLの削除 | dpf_write\n\n### common_configs\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/contracts/{ContractId}/common_configs](#tag/common_configs/paths/~1contracts~1{ContractId}~1common_configs/get) | 共通設定の一覧取得 | dpf_read\n POST | [/contracts/{ContractId}/common_configs](#tag/common_configs/paths/~1contracts~1{ContractId}~1common_configs/post) | 共通設定の作成 | dpf_write\n GET | [/contracts/{ContractId}/common_configs/count](#tag/common_configs/paths/~1contracts~1{ContractId}~1common_configs~1count/get) | 共通設定の件数取得 | dpf_read\n PATCH | [/contracts/{ContractId}/common_configs/default](#tag/common_configs/paths/~1contracts~1{ContractId}~1common_configs~1default/patch) | 初期適用される共通設定の更新 | dpf_write\n GET | [/contracts/{ContractId}/common_configs/{CommonConfigId}](#tag/common_configs/paths/~1contracts~1{ContractId}~1common_configs~1{CommonConfigId}/get) | 共通設定の取得 | dpf_read\n PATCH | [/contracts/{ContractId}/common_configs/{CommonConfigId}](#tag/common_configs/paths/~1contracts~1{ContractId}~1common_configs~1{CommonConfigId}/patch) | 共通設定の更新 | dpf_write\n DELETE | [/contracts/{ContractId}/common_configs/{CommonConfigId}](#tag/common_configs/paths/~1contracts~1{ContractId}~1common_configs~1{CommonConfigId}/delete) | 共通設定の削除 | dpf_write\n POST | [/contracts/{ContractId}/common_configs/{CommonConfigId}/copy](#tag/common_configs/paths/~1contracts~1{ContractId}~1common_configs~1{CommonConfigId}~1copy/post) | 共通設定のコピー | dpf_write\n PATCH | [/contracts/{ContractId}/common_configs/{CommonConfigId}/managed_dns](#tag/common_configs/paths/~1contracts~1{ContractId}~1common_configs~1{CommonConfigId}~1managed_dns/patch) | マネージドDNSサーバの状態更新 | dpf_write\n\n### contracts\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/contracts](#tag/contracts/paths/~1contracts/get) | DPF契約情報の一覧取得 | dpf_read\n GET | [/contracts/count](#tag/contracts/paths/~1contracts~1count/get) | DPF契約情報の件数取得 | dpf_read\n GET | [/contracts/{ContractId}](#tag/contracts/paths/~1contracts~1{ContractId}/get) | DPF契約情報の取得 | dpf_read\n PATCH | [/contracts/{ContractId}](#tag/contracts/paths/~1contracts~1{ContractId}/patch) | DPF契約情報の更新 | dpf_write\n\n### contract_partners\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/contracts/{ContractId}/contract_partners](#tag/contract_partners/paths/~1contracts~1{ContractId}~1contract_partners/get) | DPF連携サービスの一覧取得 | dpf_read\n\n### lb_domains (contracts)\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/contracts/{ContractId}/lb_domains](#tag/lb_domains-(contracts)/paths/~1contracts~1{ContractId}~1lb_domains/get) | DPF契約に紐付くLBドメインの一覧取得 | dpf_read\n PATCH | [/contracts/{ContractId}/lb_domains/common_configs](#tag/lb_domains-(contracts)/paths/~1contracts~1{ContractId}~1lb_domains~1common_configs/patch) | DPF契約に紐付くLBドメインの共通設定の更新 | dpf_write\n GET | [/contracts/{ContractId}/lb_domains/count](#tag/lb_domains-(contracts)/paths/~1contracts~1{ContractId}~1lb_domains~1count/get) | DPF契約に紐付くLBドメインの件数取得 | dpf_read\n\n### logs (contracts)\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/contracts/{ContractId}/logs](#tag/logs-(contracts)/paths/~1contracts~1{ContractId}~1logs/get) | DPF契約操作ログの一覧取得 | dpf_read\n GET | [/contracts/{ContractId}/logs/count](#tag/logs-(contracts)/paths/~1contracts~1{ContractId}~1logs~1count/get) | DPF契約操作ログの件数取得 | dpf_read\n\n### qps\nHTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/contracts/{ContractId}/qps/histories](#tag/qps/paths/~1contracts~1{ContractId}~1qps~1histories/get) | 月別のQPSの一覧取得 | dpf_read\n\n### tsigs\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/contracts/{ContractId}/tsigs](#tag/tsigs/paths/~1contracts~1{ContractId}~1tsigs/get) | TSIG鍵の一覧取得 | dpf_read\n POST | [/contracts/{ContractId}/tsigs](#tag/tsigs/paths/~1contracts~1{ContractId}~1tsigs/post) | TSIG鍵の作成 | dpf_write\n GET | [/contracts/{ContractId}/tsigs/count](#tag/tsigs/paths/~1contracts~1{ContractId}~1tsigs~1count/get) | TSIG鍵の件数取得 | dpf_read\n GET | [/contracts/{ContractId}/tsigs/{TsigId}](#tag/tsigs/paths/~1contracts~1{ContractId}~1tsigs~1{TsigId}/get) | TSIG鍵の取得 | dpf_read\n PATCH | [/contracts/{ContractId}/tsigs/{TsigId}](#tag/tsigs/paths/~1contracts~1{ContractId}~1tsigs~1{TsigId}/patch) | TSIG鍵の更新 | dpf_write\n DELETE | [/contracts/{ContractId}/tsigs/{TsigId}](#tag/tsigs/paths/~1contracts~1{ContractId}~1tsigs~1{TsigId}/delete) | TSIG鍵の削除 | dpf_write\n GET | [/contracts/{ContractId}/tsigs/{TsigId}/common_configs](#tag/tsigs/paths/~1contracts~1{ContractId}~1tsigs~1{TsigId}~1common_configs/get) | TSIG鍵を利用している共通設定の一覧取得 | dpf_read\n GET | [/contracts/{ContractId}/tsigs/{TsigId}/common_configs/count](#tag/tsigs/paths/~1contracts~1{ContractId}~1tsigs~1{TsigId}~1common_configs~1count/get) | TSIG鍵を利用している共通設定の件数取得 | dpf_read\n\n### zones (contracts)\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/contracts/{ContractId}/zones](#tag/zones-(contracts)/paths/~1contracts~1{ContractId}~1zones/get) | DPF契約に紐付くゾーンの一覧取得 | dpf_read\n PATCH | [/contracts/{ContractId}/zones/common_configs](#tag/zones-(contracts)/paths/~1contracts~1{ContractId}~1zones~1common_configs/patch) | DPF契約に紐付くゾーンの共通設定の更新 | dpf_write\n GET | [/contracts/{ContractId}/zones/count](#tag/zones-(contracts)/paths/~1contracts~1{ContractId}~1zones~1count/get) | DPF契約に紐付くゾーンの件数取得 | dpf_read\n\n## 3.2 IIJマネージドDNSサービス\n\n### default_ttl\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/zones/{ZoneId}/default_ttl](#tag/default_ttl/paths/~1zones~1{ZoneId}~1default_ttl/get) | デフォルトTTLの取得 | dpf_read\n PATCH | [/zones/{ZoneId}/default_ttl](#tag/default_ttl/paths/~1zones~1{ZoneId}~1default_ttl/patch) | デフォルトTTLの更新 | dpf_write\n DELETE | [/zones/{ZoneId}/default_ttl/changes](#tag/default_ttl/paths/~1zones~1{ZoneId}~1default_ttl~1changes/delete) | 編集中デフォルトTTLの取消 | dpf_write\n GET | [/zones/{ZoneId}/default_ttl/diffs](#tag/default_ttl/paths/~1zones~1{ZoneId}~1default_ttl~1diffs/get) | デフォルトTTLの編集差分の取得 | dpf_read\n\n### dnssec\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/zones/{ZoneId}/dnssec](#tag/dnssec/paths/~1zones~1{ZoneId}~1dnssec/get) | DNSSEC情報の取得 | dpf_read\n PATCH | [/zones/{ZoneId}/dnssec](#tag/dnssec/paths/~1zones~1{ZoneId}~1dnssec/patch) | DNSSEC情報の更新 | dpf_write\n PATCH | [/zones/{ZoneId}/dnssec/ksk_rollover](#tag/dnssec/paths/~1zones~1{ZoneId}~1dnssec~1ksk_rollover/patch) | KSKロールオーバーの開始 | dpf_write\n\n### ds_records\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/zones/{ZoneId}/ds_records](#tag/ds_records/paths/~1zones~1{ZoneId}~1ds_records/get) | DSレコードの一覧取得 | dpf_read\n\n### logs (zones)\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/zones/{ZoneId}/logs](#tag/logs-(zones)/paths/~1zones~1{ZoneId}~1logs/get) | ゾーン操作ログの一覧取得 | dpf_read\n GET | [/zones/{ZoneId}/logs/count](#tag/logs-(zones)/paths/~1zones~1{ZoneId}~1logs~1count/get) | ゾーン操作ログの件数取得 | dpf_read\n\n### records\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/zones/{ZoneId}/records](#tag/records/paths/~1zones~1{ZoneId}~1records/get) | レコードの一覧取得 | dpf_read\n POST | [/zones/{ZoneId}/records](#tag/records/paths/~1zones~1{ZoneId}~1records/post) | レコードの作成 | dpf_write\n GET | [/zones/{ZoneId}/records/count](#tag/records/paths/~1zones~1{ZoneId}~1records~1count/get) | レコードの件数取得 | dpf_read\n GET | [/zones/{ZoneId}/records/currents](#tag/records/paths/~1zones~1{ZoneId}~1records~1currents/get) | DNS反映済レコードの一覧取得 | dpf_read\n GET | [/zones/{ZoneId}/records/currents/count](#tag/records/paths/~1zones~1{ZoneId}~1records~1currents~1count/get) | DNS反映済レコードの件数取得 | dpf_read\n GET | [/zones/{ZoneId}/records/diffs](#tag/records/paths/~1zones~1{ZoneId}~1records~1diffs/get) | レコードの編集差分の一覧取得 | dpf_read\n GET | [/zones/{ZoneId}/records/diffs/count](#tag/records/paths/~1zones~1{ZoneId}~1records~1diffs~1count/get) | レコードの編集差分の件数取得 | dpf_read\n GET | [/zones/{ZoneId}/records/{RecordId}](#tag/records/paths/~1zones~1{ZoneId}~1records~1{RecordId}/get) | レコードの取得 | dpf_read\n PATCH | [/zones/{ZoneId}/records/{RecordId}](#tag/records/paths/~1zones~1{ZoneId}~1records~1{RecordId}/patch) | レコードの更新 | dpf_write\n DELETE | [/zones/{ZoneId}/records/{RecordId}](#tag/records/paths/~1zones~1{ZoneId}~1records~1{RecordId}/delete) | レコードの削除 | dpf_write\n DELETE | [/zones/{ZoneId}/records/{RecordId}/changes](#tag/records/paths/~1zones~1{ZoneId}~1records~1{RecordId}~1changes/delete) | 編集中レコードの取消 | dpf_write\n\n### zone_histories\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/zones/{ZoneId}/zone_histories](#tag/zone_histories/paths/~1zones~1{ZoneId}~1zone_histories/get) | ゾーン反映履歴の一覧取得 | dpf_read\n GET | [/zones/{ZoneId}/zone_histories/count](#tag/zone_histories/paths/~1zones~1{ZoneId}~1zone_histories~1count/get) | ゾーン反映履歴の件数取得 | dpf_read\n GET | [/zones/{ZoneId}/zone_histories/{ZoneHistoryId}/text](#tag/zone_histories/paths/~1zones~1{ZoneId}~1zone_histories~1{ZoneHistoryId}~1text/get) | ゾーン反映時のRFC1035形式のテキストの取得 | dpf_read\n\n### zone_proxy\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/zones/{ZoneId}/zone_proxy](#tag/zone_proxy/paths/~1zones~1{ZoneId}~1zone_proxy/get) | ゾーンプロキシ設定の取得 | dpf_read\n PATCH | [/zones/{ZoneId}/zone_proxy](#tag/zone_proxy/paths/~1zones~1{ZoneId}~1zone_proxy/patch) | ゾーンプロキシ設定の更新 | dpf_write\n GET | [/zones/{ZoneId}/zone_proxy/health_check](#tag/zone_proxy/paths/~1zones~1{ZoneId}~1zone_proxy~1health_check/get) | プライマリネームサーバのヘルスチェック結果の取得 | dpf_read\n\n### zones\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/zones](#tag/zones/paths/~1zones/get) | ゾーンの一覧取得 | dpf_read\n GET | [/zones/count](#tag/zones/paths/~1zones~1count/get) | ゾーンの件数取得 | dpf_read\n GET | [/zones/{ZoneId}](#tag/zones/paths/~1zones~1{ZoneId}/get) | ゾーンの取得 | dpf_read\n PATCH | [/zones/{ZoneId}](#tag/zones/paths/~1zones~1{ZoneId}/patch) | ゾーンの更新 | dpf_write\n PATCH | [/zones/{ZoneId}/changes](#tag/zones/paths/~1zones~1{ZoneId}~1changes/patch) | 編集中レコードのゾーン反映 | dpf_write\n DELETE | [/zones/{ZoneId}/changes](#tag/zones/paths/~1zones~1{ZoneId}~1changes/delete) | 編集中レコードの一括取消 | dpf_write\n GET | [/zones/{ZoneId}/contract](#tag/zones/paths/~1zones~1{ZoneId}~1contract/get) | ゾーンに紐付くDPF契約情報の取得 | dpf_read\n GET | [/zones/{ZoneId}/managed_dns_servers](#tag/zones/paths/~1zones~1{ZoneId}~1managed_dns_servers/get) | マネージドDNSサーバの一覧取得 | dpf_read\n\n## 3.3 IIJ DNSトラフィックマネージメントサービス\n\n### config\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/lb_domains/{LbDomainId}/config](#tag/config/paths/~1lb_domains~1{LbDomainId}~1config/get) | 設定の一覧取得 | dpf_read\n PUT | [/lb_domains/{LbDomainId}/config](#tag/config/paths/~1lb_domains~1{LbDomainId}~1config/put) | 設定の一括更新 | dpf_write\n\n### endpoints\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/lb_domains/{LbDomainId}/sites/{SiteResourceName}/endpoints](#tag/endpoints/paths/~1lb_domains~1{LbDomainId}~1sites~1{SiteResourceName}~1endpoints/get) | エンドポイントの一覧取得 | dpf_read\n POST | [/lb_domains/{LbDomainId}/sites/{SiteResourceName}/endpoints](#tag/endpoints/paths/~1lb_domains~1{LbDomainId}~1sites~1{SiteResourceName}~1endpoints/post) | エンドポイントの作成 | dpf_write\n GET | [/lb_domains/{LbDomainId}/sites/{SiteResourceName}/endpoints/{EndpointResourceName}](#tag/endpoints/paths/~1lb_domains~1{LbDomainId}~1sites~1{SiteResourceName}~1endpoints~1{EndpointResourceName}/get) | エンドポイントの取得 | dpf_read\n PATCH | [/lb_domains/{LbDomainId}/sites/{SiteResourceName}/endpoints/{EndpointResourceName}](#tag/endpoints/paths/~1lb_domains~1{LbDomainId}~1sites~1{SiteResourceName}~1endpoints~1{EndpointResourceName}/patch) | エンドポイントの更新 | dpf_write\n DELETE | [/lb_domains/{LbDomainId}/sites/{SiteResourceName}/endpoints/{EndpointResourceName}](#tag/endpoints/paths/~1lb_domains~1{LbDomainId}~1sites~1{SiteResourceName}~1endpoints~1{EndpointResourceName}/delete) | エンドポイントの削除 | dpf_write\n POST | [/lb_domains/{LbDomainId}/sites/{SiteResourceName}/endpoints/{EndpointResourceName}/failover](#tag/endpoints/paths/~1lb_domains~1{LbDomainId}~1sites~1{SiteResourceName}~1endpoints~1{EndpointResourceName}~1failover/post) | エンドポイントの手動切り離し | dpf_write\n POST | [/lb_domains/{LbDomainId}/sites/{SiteResourceName}/endpoints/{EndpointResourceName}/failback](#tag/endpoints/paths/~1lb_domains~1{LbDomainId}~1sites~1{SiteResourceName}~1endpoints~1{EndpointResourceName}~1failback/post) | エンドポイントの手動切り戻し | dpf_write\n\n### lb_domains\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/lb_domains](#tag/lb_domains/paths/~1lb_domains/get) | LBドメインの一覧取得 | dpf_read\n GET | [/lb_domains/count](#tag/lb_domains/paths/~1lb_domains~1count/get) | LBドメインの件数取得 | dpf_read\n GET | [/lb_domains/{LbDomainId}](#tag/lb_domains/paths/~1lb_domains~1{LbDomainId}/get) | LBドメインの取得 | dpf_read\n PATCH | [/lb_domains/{LbDomainId}](#tag/lb_domains/paths/~1lb_domains~1{LbDomainId}/patch) | LBドメインの更新 | dpf_write\n GET | [/lb_domains/{LbDomainId}/labels](#tag/lb_domains/paths/~1lb_domains~1{LbDomainId}~1labels/get) | ラベルの一覧取得 | dpf_read\n PUT | [/lb_domains/{LbDomainId}/labels](#tag/lb_domains/paths/~1lb_domains~1{LbDomainId}~1labels/put) | ラベルの一括更新 | dpf_write\n GET | [/lb_domains/{LbDomainId}/contract](#tag/lb_domains/paths/~1lb_domains~1{LbDomainId}~1contract/get) | LBドメインに紐付くDPF契約情報の取得 | dpf_read\n\n### logs (lb_domains)\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/lb_domains/{LbDomainId}/logs](#tag/logs-(lb_domains)/paths/~1lb_domains~1{LbDomainId}~1logs/get) | LBドメイン操作ログの一覧取得 | dpf_read\n GET | [/lb_domains/{LbDomainId}/logs/count](#tag/logs-(lb_domains)/paths/~1lb_domains~1{LbDomainId}~1logs~1count/get) | LBドメイン操作ログの件数取得 | dpf_read\n\n### monitorings\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/lb_domains/{LbDomainId}/monitorings](#tag/monitorings/paths/~1lb_domains~1{LbDomainId}~1monitorings/get) | 監視の一覧取得 | dpf_read\n POST | [/lb_domains/{LbDomainId}/monitorings](#tag/monitorings/paths/~1lb_domains~1{LbDomainId}~1monitorings/post) | 監視の作成 | dpf_write\n GET | [/lb_domains/{LbDomainId}/monitorings/{MonitoringResourceName}](#tag/monitorings/paths/~1lb_domains~1{LbDomainId}~1monitorings~1{MonitoringResourceName}/get) | 監視の取得 | dpf_read\n PATCH | [/lb_domains/{LbDomainId}/monitorings/{MonitoringResourceName}](#tag/monitorings/paths/~1lb_domains~1{LbDomainId}~1monitorings~1{MonitoringResourceName}/patch) | 監視の更新 | dpf_write\n DELETE | [/lb_domains/{LbDomainId}/monitorings/{MonitoringResourceName}](#tag/monitorings/paths/~1lb_domains~1{LbDomainId}~1monitorings~1{MonitoringResourceName}/delete) | 監視の削除 | dpf_write\n\n### rule_methods\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/lb_domains/{LbDomainId}/rules/{RuleResourceName}/rule_methods](#tag/rule_methods/paths/~1lb_domains~1{LbDomainId}~1rules~1{RuleResourceName}~1rule_methods/get) | ルールメソッドの一覧取得 | dpf_read\n POST | [/lb_domains/{LbDomainId}/rules/{RuleResourceName}/rule_methods](#tag/rule_methods/paths/~1lb_domains~1{LbDomainId}~1rules~1{RuleResourceName}~1rule_methods/post) | ルールメソッドの作成 | dpf_write\n GET | [/lb_domains/{LbDomainId}/rules/{RuleResourceName}/rule_methods/{RuleMethodResourceName}](#tag/rule_methods/paths/~1lb_domains~1{LbDomainId}~1rules~1{RuleResourceName}~1rule_methods~1{RuleMethodResourceName}/get) | ルールメソッドの取得 | dpf_read\n PATCH | [/lb_domains/{LbDomainId}/rules/{RuleResourceName}/rule_methods/{RuleMethodResourceName}](#tag/rule_methods/paths/~1lb_domains~1{LbDomainId}~1rules~1{RuleResourceName}~1rule_methods~1{RuleMethodResourceName}/patch) | ルールメソッドの更新 | dpf_write\n DELETE | [/lb_domains/{LbDomainId}/rules/{RuleResourceName}/rule_methods/{RuleMethodResourceName}](#tag/rule_methods/paths/~1lb_domains~1{LbDomainId}~1rules~1{RuleResourceName}~1rule_methods~1{RuleMethodResourceName}/delete) | ルールメソッドの削除 | dpf_write\n\n### rules\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/lb_domains/{LbDomainId}/rules](#tag/rules/paths/~1lb_domains~1{LbDomainId}~1rules/get) | ルールの一覧取得 | dpf_read\n POST | [/lb_domains/{LbDomainId}/rules](#tag/rules/paths/~1lb_domains~1{LbDomainId}~1rules/post) | ルールの作成 | dpf_write\n GET | [/lb_domains/{LbDomainId}/rules/{RuleResourceName}](#tag/rules/paths/~1lb_domains~1{LbDomainId}~1rules~1{RuleResourceName}/get) | ルールの取得 | dpf_read\n PATCH | [/lb_domains/{LbDomainId}/rules/{RuleResourceName}](#tag/rules/paths/~1lb_domains~1{LbDomainId}~1rules~1{RuleResourceName}/patch) | ルールの更新 | dpf_write\n DELETE | [/lb_domains/{LbDomainId}/rules/{RuleResourceName}](#tag/rules/paths/~1lb_domains~1{LbDomainId}~1rules~1{RuleResourceName}/delete) | ルールの削除 | dpf_write\n\n### sites\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/lb_domains/{LbDomainId}/sites](#tag/sites/paths/~1lb_domains~1{LbDomainId}~1sites/get) | サイトの一覧取得 | dpf_read\n POST | [/lb_domains/{LbDomainId}/sites](#tag/sites/paths/~1lb_domains~1{LbDomainId}~1sites/post) | サイトの作成 | dpf_write\n GET | [/lb_domains/{LbDomainId}/sites/{SiteResourceName}](#tag/sites/paths/~1lb_domains~1{LbDomainId}~1sites~1{SiteResourceName}/get) | サイトの取得 | dpf_read\n PATCH | [/lb_domains/{LbDomainId}/sites/{SiteResourceName}](#tag/sites/paths/~1lb_domains~1{LbDomainId}~1sites~1{SiteResourceName}/patch) | サイトの更新 | dpf_write\n DELETE | [/lb_domains/{LbDomainId}/sites/{SiteResourceName}](#tag/sites/paths/~1lb_domains~1{LbDomainId}~1sites~1{SiteResourceName}/delete) | サイトの削除 | dpf_write\n\n## 3.4 サービス共通\n\n### delegations\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/delegations](#tag/delegations/paths/~1delegations/get) | ネームサーバ申請候補の一覧取得 | dpf_read\n POST | [/delegations](#tag/delegations/paths/~1delegations/post) | ネームサーバ申請 | dpf_write\n GET | [/delegations/count](#tag/delegations/paths/~1delegations~1count/get) | ネームサーバ申請候補の件数取得 | dpf_read\n\n### jobs\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/jobs/{RequestId}](#tag/jobs/paths/~1jobs~1{RequestId}/get) | 非同期リクエストの状態確認 | dpf_read\n\n### ping\n HTTPメソッド | API | 機能 | 許可するスコープ\n -----------|-----|-----|--------------\n GET | [/ping](#tag/ping/paths/~1ping/get) | API疎通確認 | dpf_read, dpf_write, dpf_contract\n" + "contact": { + "name": "IIJ サポートセンター", + "url": "https://help.iij.ad.jp/" + }, + "description": "# 1. はじめに\n\n## 1.1 DPF-APIについて\nIIJ DNSプラットフォームサービスでは、DNSレコードやゾーン情報などを、\\\nお客様が用意したプログラムから自動的に操作するためのAPI機能を提供しています。\\\n以降、IIJ DNSプラットフォームサービスを「DPF」、DPFが提供するAPIを「DPF-API」あるいは単に「API」と表記します。\\\nDPF-APIの利用には、DPFの契約とIIJ IDサービスの契約が必要となります。\n\n本リファレンスマニュアルは[**OpenAPI**](https://www.openapis.org/)に準拠しています。\n\nこのWEBページはopenapi.jsonから自動生成しています。**このWEBページとopenapi.jsonの内容が異なる場合は、openapi.jsonの内容を正とします。**\nopenapi.jsonは、上部のDownloadボタンからダウンロードできます。\n\n## 1.2 サポート範囲\nDPF-APIを呼び出すためのプログラム、及びそのプログラムを稼働させるためのサーバは、お客様にてご用意ください。\\\nお客様にご用意いただくプログラムの開発、利用、動作についてのお問い合わせは承ることができません。\n\n以下の事項についてのお問い合わせは、弊社[**サポートセンター**](https://help.iij.ad.jp/)にて承ります。\n- DPF-APIの挙動が本リファレンスマニュアルと異なる場合\n- DPF-APIがシステムエラーを応答した場合\n\n## 1.3 参考資料\n- IIJ DNSプラットフォームサービス オンラインマニュアル\n - [https://manual.iij.jp/dpf/help/](https://manual.iij.jp/dpf/help/)\n\n- IIJ IDサービス オンラインマニュアル\n - [https://manual.iij.jp/iid/admin-help/](https://manual.iij.jp/iid/admin-help/)\n\n# 2. 利用方法\nDPF-APIは、URLとHTTPリクエストヘッダ、HTTPリクエストボディでパラメータを指定して利用します。\\\nまた、IIJ IDサービスのアクセストークンと管理対象の権限設定が必要です。\n\n## 2.1 リクエスト仕様\n\n項目 | 規格\n-----|-----\nプロトコル | HTTP/1.1、HTTP/2（https）\nHTTPメソッド | GET、POST、PATCH、PUT、DELETE\nフォーマット | JSON\n文字コード | UTF-8\nタイムアウト | 300秒\n\n- httpでのリクエストは受け付けません。必ずhttpsを使用してください。\n- DPF-APIを呼び出すプログラムは、リクエスト先が正当なものであることを確認するため、SSL証明書を検証することを推奨します。\n- 短期間に極めて多数のリクエストが行われた場合、サービスの健全性を保つためにリクエストを制限する場合があります。\n\n### アクセストークン\nAPIリクエストの際にIIJ IDサービスによって発行されたアクセストークンをAuthorizationヘッダに指定する必要があります。\\\n各APIにより必要となるアクセス権の範囲（許可するスコープ）が異なるのでご注意ください。\n\nアクセストークン作成時に指定できる「許可するスコープ」は以下のとおりです。\n\n許可するスコープ | 実行できるAPI\n-----------------|------------\ndpf_read | 参照系API\ndpf_write | 更新系、及び参照系API\ndpf_contract | 契約系API\n\n発行済のアクセストークンは、[**IIJ IDサービス**](https://www.auth.iij.jp/console/)の「アクセストークンの管理」より確認できます。\\\nDPF-APIを利用する場合は「利用するリソースサーバ」の設定で「IIJ DNSサービスAPI」を選択してください。\\\nアクセストークン管理方法のマニュアルは[**こちら**](https://manual.iij.jp/iid/admin-help/9054382.html)を参照してください。\n\n### 管理対象の権限設定\nDPFでは、管理対象となる契約単位での参照、編集権限を細かく設定できます。\\\nアクセストークンの許可するスコープが適切であっても、管理対象の権限が付与されていない場合はAPIを実行できません。\\\n管理対象の権限設定のマニュアルは[**こちら**](https://manual.iij.jp/dpf/help/19004706.html#IIJID%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%81%A8%E9%80%A3%E6%90%BA%E3%81%99%E3%82%8B-IIJID%E3%82%B5%E3%83%BC%E3%83%93%E3%82%B9%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88%E3%81%B8%E7%AE%A1%E7%90%86%E6%A8%A9%E9%99%90%E3%82%92%E4%BB%98%E4%B8%8E%E3%81%99%E3%82%8B)を参照してください。\n\n## 2.2 HTTPリクエスト\n\n### 例\n```\n /dpf// HTTP/1.1\nHost: api.dns-platform.jp\nAuthorization: Bearer \nContent-Type: application/json; charset=UTF-8\n\n\n```\n\n### リクエストパラメータ\nDPF-APIで指定するパラメータは以下のとおりです。\\\nリクエストパラメータに同一のキーが含まれる場合の動作は保証されません。\n\n共通 | 指定箇所 | パラメータ | 意味\n-----|----------|------------|-----\n共通 | HTTPメソッド | HTTPメソッド | HTTPメソッド（値：GET、POST、PATCH、PUT、DELETE）\n共通 | URL | version | DPF-APIバージョン（値：v1）\n個別 | URL | APIパス | API名称やAPI個別のパラメータの組み合わせ\n共通 | HTTPヘッダー | access_token | IIJ IDアクセストークン（参照：[**IIJ IDサービス**](https://www.auth.iij.jp/console/)）\n個別 | HTTPボディ | APIごとに異なる | JSON形式のパラメータ\n\n## 2.3 HTTPレスポンス\n\n### 成功レスポンス\nAPIごとにレスポンスが異なります。\n\n### エラーレスポンス\nHTTPステータスコード、及びレスポンスボディによってクライアントプログラムにエラーを通知します。\n\n#### 例：アクセストークンが誤っている\n```\n{\n \"request_id\": \"782d746ac3cb46499b31708fa80e8660\",\n \"error_type\": \"ParameterError\",\n \"error_message\": \"There are invalid parameters.\",\n \"error_details\": [\n {\n \"code\": \"invalid\",\n \"attribute\": \"access_token\"\n }\n ]\n}\n```\n\n#### エラーコード一覧\nHTTP Status Code | error_type | error_message | code | attribute | 説明 | 対処方法\n-----------------|------------|---------------|------|-----------|------|---------\n400 | ParameterError | There are invalid parameters. | invalid | access_token | 指定したアクセストークンに誤りがあります | アクセストークンを確認してください\n400 | ParameterError | JSON parse error occurred. | - | - | パラメータとして不正なJSON文字列が指定されました | リクエストのパラメータを確認してください\n400 | ParameterError | There are invalid parameters. | （API個別） | （API個別） | 不正なパラメータが指定されました | 各APIのエラーコードを確認してください\n404 | NotFound | Specified resource not found. | - | - | アクセスURLが正しくありません
存在しないAPIが指定されました
指定された以外のHTTPメソッドが指定されました | 左記の内容を確認してください\n429 | TooManyRequests | Too many requests. | - | - | 大量のAPIリクエストが送信されました | 単位時間当たりのAPIリクエスト数を確認してください\n500 | SystemError | System error occurred. | - | - | システム障害が発生しました | [**サポートセンター**](https://help.iij.ad.jp/)へお問い合わせください\n504 | GatewayTimeout | Gateway timeout. | - | - | リクエストがタイムアウトしました | しばらく待ってから再度リクエストしてください\n\n## 2.4 非同期リクエスト\n\nDPF-APIにおけるGET以外のAPIは全て非同期APIです。\\\n非同期APIはリクエストを受け付けると即座にレスポンスを返却しますが、\\\nリクエストに対する実際の処理は非同期で行われます。\n\n非同期リクエストの受け付けに成功した場合のHTTPステータスコードは202で、\\\n返却されたレスポンスボディには、処理進捗を確認するためのURL（jobs_url）が含まれます。\\\nこのjobs_urlに対してGETリクエストをすることで進捗状況を確認できます。\n\n進捗状況を確認した際、非同期処理が正常に終了していた場合は、\\\n返却されたレスポンスボディには、対象リソースを取得するためのURL（resources_url）が含まれます。\\\nこのresources_urlに対してGETリクエストをすることで実行結果を確認できます。\n\n### 例\n#### 非同期リクエストのレスポンス\n```\nHTTP/1.1 202 Accepted\nDate: Mon, 26 Mar 20XX hh:mm:dd GMT\nContent-Type: application/json; charset=utf-8\n〜 略 〜\n\n{\n \"request_id\": \"782d746ac3cb46499b31708fa80e8660\",\n \"jobs_url\": \"https://api.dns-platform.jp/dpf//jobs/\"\n}\n```\n\n#### GETリクエスト\n```\nGET /dpf//jobs/ HTTP/1.1\nHost: api.dns-platform.jp\nAuthorization: Bearer \nContent-Type: application/json; charset=UTF-8\n\n{}\n```\n\n#### 進捗状況のレスポンス\n```\nHTTP/1.1 200 OK\nDate: Mon, 26 Mar 20XX hh:mm:dd GMT\nContent-Type: application/json; charset=utf-8\n〜 略 〜\n\n{\n \"request_id\": \"782d746ac3cb46499b31708fa80e8660\",\n \"resources_url\": ,\n \"status\": \"SUCCESSFUL\"\n}\n```\n" }, "servers": [ { @@ -11,185 +15,6 @@ "description": "API endpoint" } ], - "tags": [ - { - "name": "cc_primaries", - "description": "プライマリネームサーバの操作ができます。\\\nプライマリネームサーバの状態（enabled）は以下のとおりです。\n\n### enabled\n値 | 意味 | 備考\n---|------|-----\n0 | 無効 |\n1 | 有効 |\n" - }, - { - "name": "cc_sec_notified_servers", - "description": "DNS NOTIFYの操作ができます。\n" - }, - { - "name": "cc_sec_transfer_acls", - "description": "ゾーン転送ACLの操作ができます。\n" - }, - { - "name": "cc_notice_accounts", - "description": "通知先アカウントの操作ができます。\n" - }, - { - "name": "common_configs", - "description": "複数のゾーンおよびLBドメインで共通の設定内容を使用するための共通設定を操作できます。\\\nマネージドDNSサーバの状態（managed_dns_enabled）、初期適用の共通設定（default）は以下のとおりです。\n\n### managed_dns_enabled\n値 | 意味 | 備考\n---|------|-----\n0 | 無効 |\n1 | 有効 |\n\n### default\n値 | 意味 | 備考\n---|------|-----\n0 | 無効 |\n1 | 有効 |\n" - }, - { - "name": "contracts", - "description": "DPF契約の操作ができます。\\\n契約プラン（plan）、契約の状態（state）、お気に入りの状態（favorite）は以下のとおりです。\n\n### plan\n値 | 意味 | 備考\n---|------|-----\n 1 | ベーシック |\n 2 | プレミアム |\n\n### state\n値 | 意味 | 備考\n---|------|-----\n 1 | 利用開始前 |\n 2 | 利用中 |\n\n### favorite\n値 | 意味 | 備考\n---|------|-----\n 1 | 表示優先度高 |\n 2 | 表示優先度低 |\n" - }, - { - "name": "contract_partners", - "description": "DPF契約の連携しているサービス情報の操作ができます。\n" - }, - { - "name": "logs (contracts)", - "description": "DPF契約を操作したログを取得できます。\\\n取得可能なログは90日前までとなります。\\\n操作内容（operation）、ログの種別（log_type）、処理の状態（status）は以下のとおりです。\n\n### operation\n値 | 意味 | 備考\n---|------|-----\nadd_cc_primary | プライマリネームサーバ設定の作成 |\nupdate_cc_primary | プライマリネームサーバ設定の更新 |\ndelete_cc_primary | プライマリネームサーバ設定の削除 |\nadd_cc_sec_notified_server | DNS NOTIFY設定の作成 |\nupdate_cc_sec_notified_server | DNS NOTIFY設定の更新 |\ndelete_cc_sec_notified_server | DNS NOTIFY設定の削除 |\nadd_cc_sec_transfer_acl | ゾーン転送ACLの作成 |\nupdate_cc_sec_transfer_acl | ゾーン転送ACLの更新 |\ndelete_cc_sec_transfer_acl | ゾーン転送ACLの削除 |\nadd_notification_account | 通知先アカウント設定の追加 |\nupdate_notification_account | 通知先アカウント設定の更新 |\ndelete_notification_account | 通知先アカウント設定の削除 |\nmail_notification | メール通知の実行 |\nphone_notification | 架電通知の実行 |\ncreate_common_config | 共通設定の作成 |\nswitch_default_common_config | 初期適用される共通設定の更新 |\nupdate_common_config | 共通設定の更新 |\ndelete_common_config | 共通設定の削除 |\ncopy_common_config | 共通設定のコピー |\nupdate_managed_dns_state | マネージドDNSサーバの状態更新 |\nupdate_contract_description | DPF契約情報のコメントの更新 |\nupdate_contract_favorite | DPF契約情報のお気に入り状態の更新 |\napply_common_config | DPF契約に紐付くゾーンおよびLBドメインの共通設定の更新 |\ncreate_contract_partnership | IIJ IDサービスとの連携 |\ndelete_contract_partnership | IIJ IDサービスとの連携解除 |\ncreate_tsig | TSIG鍵の作成 |\nupdate_tsig | TSIG鍵の更新 |\ndelete_tsig | TSIG鍵の削除 |\n\n### log_type\n値 | 意味 | 備考\n---|------|-----\nservice | サービス設定の操作 |\ncommon_config | 共通設定の操作 |\nnotification | 通知の実行 |\n\n### status\n値 | 意味 | 備考\n---|------|-----\nstart | 処理開始 |\nsuccess | 処理正常終了 |\nfailure | 処理失敗 |\nretry | リトライ |\n" - }, - { - "name": "qps", - "description": "" - }, - { - "name": "tsigs", - "description": "TSIG鍵の操作ができます。\\\nハッシュアルゴリズム（algorithm）は以下のとおりです。\n\n### algorithm\n値 | 意味 | 備考\n---|------|-----\n0 | HMAC-SHA256 |\n" - }, - { - "name": "zones (contracts)", - "description": "DPF契約に紐付くゾーンの操作ができます。\\\nゾーンの状態（state）、お気に入りの状態（favorite）、ゾーンプロキシの状態（zone_proxy_enabled）の詳細な説明は、**[zones](#tag/zones)**を参照してください。\n" - }, - { - "name": "lb_domains (contracts)", - "description": "DPF契約に紐付くLBドメインの操作ができます。\\\nLBドメインの状態（state）、お気に入りの状態（favorite）の詳細な説明は、**[lb_domains](#tag/lb_domains)**を参照してください。\n" - }, - { - "name": "default_ttl", - "description": "契約に紐づくゾーンのデフォルトTTLの操作ができます。\\\nデフォルトTTLの状態（state）は以下のとおりです。\n\n### state\n値 | 意味 | 備考\n---|------|-----\n 0 | 反映済み |\n 3 | 更新予定 |\n 5 | 更新前の状態 |\n" - }, - { - "name": "dnssec", - "description": "DNSSECの操作ができます。\\\nDNSSECの有効状態（enabled）、DNSSECの状態（state）、DSレコードの状態（ds_state）は以下のとおりです。\n\n### enabled\n値 | 意味 | 備考\n---|------|-----\n0 | 無効 |\n1 | 有効 |\n\n### state\n値 | 意味 | 備考\n---|------|-----\n0 | ゾーン公開前 |\n1 | 有効化作業中 |\n2 | 有効 |\n3 | 無効化作業中 |\n4 | 無効 |\n\n### ds_state\n値 | 意味 | 備考\n---|------|-----\n0 | 公開前 |\n1 | DSレコード登録待ち |\n2 | DSレコード登録反映待ち |\n3 | DSレコード公開中 |\n4 | ロールオーバー準備中 |\n5 | DSレコード変更待ち |\n6 | DSレコード変更反映待ち |\n7 | DSレコード削除待ち |\n8 | DSレコード削除反映待ち |\n" - }, - { - "name": "ds_records", - "description": "" - }, - { - "name": "logs (zones)", - "description": "契約に紐付くゾーンを操作したログを取得できます。\\\n取得可能なログは90日前までとなります。\\\n操作内容（operation）、ログの種別（log_type）、処理の状態（status）は以下のとおりです。\n\n### operation\n値 | 意味 | 備考\n---|------|-----\nupdating_default_ttl | デフォルトTTLの更新 |\ndismiss_default_ttl_change | 編集中デフォルトTTLの取消 |\nupdate_dnssec_configuration | DNSSEC情報の更新 |\nbegin_ksk_rollover | KSKロールオーバーの開始 |\nadding_record | レコードの作成 |\nupdating_record | レコードの更新 |\ndeleting_record | レコードの削除 |\ndismiss_record_change | 編集中レコードの取消 |\nupdate_zone_proxy | ゾーンプロキシ設定の更新 |\nupdate_zone_description | ゾーンのコメントの更新 |\nupdate_zone_favorite | ゾーンのお気に入り状態の更新 |\ncommit_zone | 編集中レコードのゾーン反映 |\nupload_zone | ゾーンファイルのアップロード |\ndismiss_zone_edits | 編集中レコードの一括取消 |\ncreate_delegations | ネームサーバ申請 |\n\n### log_type\n値 | 意味 | 備考\n---|------|-----\nservice | サービス設定の操作 |\nrecord | レコードの操作 |\ndnssec | DNSSEC設定の操作 |\n\n### status\n値 | 意味 | 備考\n---|------|-----\nstart | 処理開始 |\nsuccess | 処理正常終了 |\nfailure | 処理失敗 |\nretry | リトライ |\n" - }, - { - "name": "records", - "description": "契約に紐付くゾーンのレコード操作ができます。\\\nレコード操作の状態（state）は以下のとおりです。\n\n### state\n値 | 意味 | 備考\n---|------|-----\n 0 | 反映済み |\n 1 | 追加予定 |\n 2 | 削除予定 |\n 3 | 更新予定 |\n 5 | 更新前の状態 |\n" - }, - { - "name": "zone_histories", - "description": "当日を含めて90日前までのゾーン反映の履歴を確認できます。\\\n確認のタイミングにより、それ以前の履歴を確認できる場合があります。\n" - }, - { - "name": "zone_proxy", - "description": "ゾーンプロキシの操作ができます。\\\nゾーンプロキシの状態（enabled）、ゾーン転送の状態（state）は以下のとおりです。\n\n### enabled\n値 | 意味 | 備考\n---|------|-----\n 0 | 無効 |\n 1 | 有効 |\n\n### state\n値 | 意味 | 備考\n---|------|-----\n OK | ゾーン転送成功 |\n NG | ゾーン転送失敗 |\n" - }, - { - "name": "zones", - "description": "DPF契約に紐付くゾーンの操作ができます。\\\nゾーンの状態（state）、お気に入りの状態（favorite）、ゾーンプロキシの状態（zone_proxy_enabled）は以下のとおりです。\n\n### state\n値 | 意味 | 備考\n---|------|-----\n 1 | 公開前 |\n 2 | 公開 |\n\n### favorite\n値 | 意味 | 備考\n---|------|-----\n 1 | 表示優先度高 |\n 2 | 表示優先度低 |\n\n### zone_proxy_enabled\n値 | 意味 | 備考\n---|------|-----\n 0 | 無効 |\n 1 | 有効 |\n" - }, - { - "name": "lb_domains", - "description": "DPF契約に紐付くLBドメインの操作ができます。\\\nLBドメインの状態（state）、お気に入りの状態（favorite）は以下のとおりです。\n\n### state\n値 | 意味 | 備考\n---|------|-----\n 1 | 公開前 |\n 2 | 公開 |\n\n### favorite\n値 | 意味 | 備考\n---|------|-----\n 1 | 表示優先度高 |\n 2 | 表示優先度低 |\n\n### ラベル\nラベルは契約に割り当てられるKeyとValueのペアです。\\\n登録したKeyとValueを用いて契約を検索できます。\\\nKeyはプレフィックス部（任意）と名前部（必須）の2つのセグメントで構成されており、\\\nプレフィックス部を利用する場合はスラッシュ区切りでプレフィックス部、名前部の順に入力してください。\\\n「iij.jp」「dns-platform.jp」をプレフィックス部に指定することはできません。\n\n詳しくは「**[オンラインマニュアル](https://manual.iij.jp/dpf/help/35207451.html#id-%E3%82%B5%E3%82%A4%E3%83%88%E7%AE%A1%E7%90%86-%E5%A5%91%E7%B4%84%E6%83%85%E5%A0%B1)**」をご覧ください。\n" - }, - { - "name": "monitorings", - "description": "LBドメインに紐付く監視の操作ができます。\n" - }, - { - "name": "sites", - "description": "LBドメインに紐付くサイトの操作ができます。\n" - }, - { - "name": "endpoints", - "description": "サイトに紐付くエンドポイントの操作ができます。\n" - }, - { - "name": "rules", - "description": "LBドメインに紐付くルールの操作ができます。\\\n適用ルールは**[LBドメインの更新](#tag/lb_domains/paths/~1lb_domains~1{LbDomainId}/patch)**で切り替えができます。\n" - }, - { - "name": "rule_methods", - "description": "ルールに紐付くルールメソッドの操作ができます。\n" - }, - { - "name": "config", - "description": "LBドメインに紐付く設定と状態の操作ができます。\n" - }, - { - "name": "logs (lb_domains)", - "description": "契約に紐付くLBドメインを操作したログを取得できます。\\\n取得可能なログは90日前までとなります。\\\n操作内容（operation）、ログの種別（log_type）、処理の状態（status）は以下のとおりです。\n\n### operation\n値 | 意味 | 備考\n---|------|-----\nupdate_lb_domain_description | トラフィックコントロール契約のコメントの更新 |\nupdate_lb_domain_favorite | トラフィックコントロール契約のお気に入り状態の切り替え |\nupdate_lb_domain_labels | トラフィックコントロール契約のラベルの更新 |\nupdate_lb_domain_rule | 適用ルールの切り替え |\nadd_rule | ルールの追加 |\nupdate_rule | ルールの更新 |\ndelete_rule | ルールの削除 |\nadd_rule_method | ルールメソッドの追加 |\nupdate_rule_method | ルールメソッドの更新 |\ndelete_rule_method | ルールメソッドの削除 |\nadd_site | サイトの追加 |\nupdate_site | サイトの更新 |\ndelete_site | サイトの削除 |\nadd_endpoint | エンドポイントの追加 |\nupdate_endpoint | エンドポイントの更新 |\ndelete_endpoint | エンドポイントの削除 |\nmanual_failover | エンドポイントの手動切り離し |\nmanual_failback | エンドポイントの手動切り戻し |\nadd_monitoring | 監視の追加 |\nupdate_monitoring | 監視の更新 |\ndelete_monitoring | 監視の削除 |\nfile_import | ファイルインポート |\nmonitoring_result_changed | 監視結果の更新 |\nendpoint_live_status_changed | エンドポイントLiveStatusの更新 |\nendpoint_ready_status_changed | エンドポイントReadyStatusの更新 |\nsite_live_status_changed | サイトLiveStatusの更新 |\n\n### log_type\n値 | 意味 | 備考\n---|------|-----\nservice | サービス設定の操作 |\nrule | ルールの操作 |\nsite | サイトの操作 |\nmonitoring | 監視の操作 |\nfile | ファイル設定の操作 |\nmonitoring_event | 監視イベントの操作 |\n\n### status\n値 | 意味 | 備考\n---|------|-----\nstart | 処理開始 |\nsuccess | 処理正常終了 |\nfailure | 処理失敗 |\nretry | リトライ |\n" - }, - { - "name": "delegations", - "description": "ネームサーバ申請の操作ができます。\\\nお気に入りの状態（favorite）、ネームサーバの状態（requested）は以下のとおりです。\n\n### favorite\n値 | 意味 | 備考\n---|------|-----\n1 | 表示優先度高 |\n2 | 表示優先度低 |\n\n### requested\n値 | 意味 | 備考\n---|------|-----\n0 | 未申請 |\n1 | 申請済み |\n" - }, - { - "name": "jobs", - "description": "非同期リクエストの状態確認ができます。\\\nリクエストの状態（status）は以下のとおりです。\n\n### status\n値 | 意味 | 備考\n---|------|-----\nRUNNING | 処理中 |\nSUCCESSFUL | 正常終了 |\nFAILED | 異常終了 |\n" - }, - { - "name": "ping", - "description": "" - } - ], - "x-tagGroups": [ - { - "name": "IIJ DNSプラットフォームサービス", - "tags": [ - "cc_notice_accounts", - "cc_primaries", - "cc_sec_notified_servers", - "cc_sec_transfer_acls", - "common_configs", - "contracts", - "contract_partners", - "lb_domains (contracts)", - "logs (contracts)", - "qps", - "tsigs", - "zones (contracts)" - ] - }, - { - "name": "IIJマネージドDNSサービス", - "tags": [ - "default_ttl", - "dnssec", - "ds_records", - "logs (zones)", - "records", - "zone_histories", - "zone_proxy", - "zones" - ] - }, - { - "name": "IIJ DNSトラフィックマネージメントサービス", - "tags": [ - "config", - "endpoints", - "lb_domains", - "logs (lb_domains)", - "monitorings", - "rule_methods", - "rules", - "sites" - ] - }, - { - "name": "サービス共通", - "tags": [ - "delegations", - "jobs", - "ping" - ] - } - ], "paths": { "/common_configs/{CommonConfigId}/cc_primaries": { "parameters": [ @@ -198,11 +23,19 @@ } ], "get": { + "operationId": "getCcPrimaryList", "summary": "プライマリネームサーバ設定の一覧取得", - "description": "プライマリネームサーバの設定の一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "プライマリネームサーバの設定の一覧を取得します。\n", "tags": [ "cc_primaries" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -237,11 +70,19 @@ } }, "post": { + "operationId": "postCcPrimary", "summary": "プライマリネームサーバ設定の作成", - "description": "新しくプライマリネームサーバを作成します。\\\n作成できる最大件数は5件です。\n\n### Authorizations\ndpf_write\n", + "description": "新しくプライマリネームサーバを作成します。\\\n作成できる最大件数は5件です。\n", "tags": [ "cc_primaries" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -300,11 +141,19 @@ } ], "get": { + "operationId": "getCcPrimary", "summary": "プライマリネームサーバ設定の取得", - "description": "指定したCcPrimaryIdのプライマリネームサーバを取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したCcPrimaryIdのプライマリネームサーバを取得します。\n", "tags": [ "cc_primaries" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -339,11 +188,19 @@ } }, "patch": { + "operationId": "patchCcPrimary", "summary": "プライマリネームサーバ設定の更新", - "description": "指定したCcPrimaryIdのプライマリネームサーバを更新します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したCcPrimaryIdのプライマリネームサーバを更新します。\n", "tags": [ "cc_primaries" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -392,11 +249,19 @@ } }, "delete": { + "operationId": "deleteCcPrimary", "summary": "プライマリネームサーバ設定の削除", - "description": "指定したCcPrimaryIdのプライマリネームサーバを削除します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したCcPrimaryIdのプライマリネームサーバを削除します。\n", "tags": [ "cc_primaries" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -438,11 +303,19 @@ } ], "get": { + "operationId": "getCcSecNotifiedServerList", "summary": "DNS NOTIFY設定の一覧取得", - "description": "DNS NOTIFYの設定の一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "DNS NOTIFYの設定の一覧を取得します。\n", "tags": [ "cc_sec_notified_servers" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -477,11 +350,19 @@ } }, "post": { + "operationId": "postCcSecNotifiedServer", "summary": "DNS NOTIFY設定の作成", - "description": "新しくDNS NOFITYを作成します。\\\n作成できる最大件数は256件です。\n\n### Authorizations\ndpf_write\n", + "description": "新しくDNS NOFITYを作成します。\\\n作成できる最大件数は256件です。\n", "tags": [ "cc_sec_notified_servers" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -540,11 +421,19 @@ } ], "get": { + "operationId": "getCcSecNotifiedServer", "summary": "DNS NOTIFY設定の取得", - "description": "指定したCcSecNotifiedServerIdのDNS NOTIFYを取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したCcSecNotifiedServerIdのDNS NOTIFYを取得します。\n", "tags": [ "cc_sec_notified_servers" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -579,11 +468,19 @@ } }, "patch": { + "operationId": "patchCcSecNotifiedServer", "summary": "DNS NOTIFY設定の更新", - "description": "指定したCcSecNotifiedServerIdのDNS NOTIFYを更新します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したCcSecNotifiedServerIdのDNS NOTIFYを更新します。\n", "tags": [ "cc_sec_notified_servers" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -632,11 +529,19 @@ } }, "delete": { + "operationId": "deleteCcSecNotifiedServer", "summary": "DNS NOTIFY設定の削除", - "description": "指定したCcSecNotifiedServerIdのDNS NOTIFYを削除します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したCcSecNotifiedServerIdのDNS NOTIFYを削除します。\n", "tags": [ "cc_sec_notified_servers" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -678,11 +583,19 @@ } ], "get": { + "operationId": "getCcSecTransferAclList", "summary": "ゾーン転送ACLの一覧取得", - "description": "ゾーン転送ACLの設定の一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "ゾーン転送ACLの設定の一覧を取得します。\n", "tags": [ "cc_sec_transfer_acls" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -717,11 +630,19 @@ } }, "post": { + "operationId": "postCcSecTransferAcl", "summary": "ゾーン転送ACLの作成", - "description": "新しくゾーン転送ACLを作成します。\\\n作成できる最大件数は5件です。\n\n### Authorizations\ndpf_write\n", + "description": "新しくゾーン転送ACLを作成します。\\\n作成できる最大件数は5件です。\n", "tags": [ "cc_sec_transfer_acls" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -780,11 +701,19 @@ } ], "get": { + "operationId": "getCcSecTransferAcl", "summary": "ゾーン転送ACLの取得", - "description": "指定したCcSecTransferAclIdのゾーン転送ACLを取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したCcSecTransferAclIdのゾーン転送ACLを取得します。\n", "tags": [ "cc_sec_transfer_acls" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -819,11 +748,19 @@ } }, "patch": { + "operationId": "patchCcSecTransferAcl", "summary": "ゾーン転送ACLの更新", - "description": "指定したCcSecTransferAclIdのゾーン転送ACLを更新します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したCcSecTransferAclIdのゾーン転送ACLを更新します。\n", "tags": [ "cc_sec_transfer_acls" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -872,11 +809,19 @@ } }, "delete": { + "operationId": "deleteCcSecTransferAcl", "summary": "ゾーン転送ACLの削除", - "description": "指定したCcSecTransferAclIdのゾーン転送ACLを削除します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したCcSecTransferAclIdのゾーン転送ACLを削除します。\n", "tags": [ "cc_sec_transfer_acls" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -918,11 +863,19 @@ } ], "get": { + "operationId": "getCcNoticeAccountList", "summary": "通知先アカウント設定の一覧取得", - "description": "通知先アカウントの設定の一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "通知先アカウントの設定の一覧を取得します。\n", "tags": [ "cc_notice_accounts" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -957,11 +910,19 @@ } }, "post": { + "operationId": "postCcNoticeAccount", "summary": "通知先アカウント設定の作成", - "description": "新しく通知先アカウントを作成します。\\\n作成できる最大件数は20件です。\n\n### Authorizations\ndpf_write\n", + "description": "新しく通知先アカウントを作成します。\n", "tags": [ "cc_notice_accounts" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -1020,11 +981,19 @@ } ], "get": { + "operationId": "getCcNoticeAccount", "summary": "通知先アカウントの取得", - "description": "指定したCcNoticeAccountResourceNameの通知先アカウント設定を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したCcNoticeAccountResourceNameの通知先アカウント設定を取得します。\n", "tags": [ "cc_notice_accounts" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -1059,11 +1028,19 @@ } }, "patch": { + "operationId": "patchCcNoticeAccount", "summary": "通知先アカウント設定の更新", - "description": "指定したCcNoticeAccountResourceNameの通知先アカウント設定を更新します。\\\nアカウントに登録されたメールアドレスや電話番号を削除したい場合は、空文字を指定してください。\n\n### Authorizations\ndpf_write\n", + "description": "指定したCcNoticeAccountResourceNameの通知先アカウント設定を更新します。\\\nアカウントに登録されたメールアドレスや電話番号を削除したい場合は、空文字を指定してください。\n", "tags": [ "cc_notice_accounts" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -1112,11 +1089,19 @@ } }, "delete": { + "operationId": "deleteCcNoticeAccount", "summary": "通知先アカウント設定の削除", - "description": "指定したCcNoticeAccountResourceNameの通知先アカウント設定を削除します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したCcNoticeAccountResourceNameの通知先アカウント設定を削除します。\n", "tags": [ "cc_notice_accounts" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -1158,15 +1143,23 @@ } ], "get": { + "operationId": "getCommonConfigList", "summary": "共通設定の一覧取得", - "description": "共通設定の一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "共通設定の一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "common_configs" ], - "parameters": [ + "security": [ { - "$ref": "#/components/parameters/Type" - }, + "DPFViewer": [ + "dpf_read" + ] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/Type" + }, { "$ref": "#/components/parameters/Offset" }, @@ -1217,11 +1210,19 @@ } }, "post": { + "operationId": "postCommonConfig", "summary": "共通設定の作成", - "description": "新しく共通設定を作成します。\n\n### Authorizations\ndpf_write\n", + "description": "新しく共通設定を作成します。\n", "tags": [ "common_configs" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -1277,11 +1278,19 @@ } ], "get": { + "operationId": "getCommonConfigListCount", "summary": "共通設定の件数取得", - "description": "共通設定の件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "共通設定の件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "common_configs" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -1337,11 +1346,19 @@ } ], "patch": { + "operationId": "patchCommonConfigDefault", "summary": "初期適用される共通設定の更新", - "description": "ゾーンおよびLBドメインを新規追加した場合に、自動で適用される共通設定を切り替えます。\n\n### Authorizations\ndpf_write\n", + "description": "ゾーンおよびLBドメインを新規追加した場合に、自動で適用される共通設定を切り替えます。\n", "tags": [ "common_configs" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -1400,11 +1417,19 @@ } ], "get": { + "operationId": "getCommonConfig", "summary": "共通設定の取得", - "description": "指定したCommonConfigIdの共通設定を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したCommonConfigIdの共通設定を取得します。\n", "tags": [ "common_configs" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -1439,11 +1464,19 @@ } }, "patch": { + "operationId": "patchCommonConfig", "summary": "共通設定の更新", - "description": "指定したCommonConfigIdの共通設定を更新します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したCommonConfigIdの共通設定を更新します。\n", "tags": [ "common_configs" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -1492,11 +1525,19 @@ } }, "delete": { + "operationId": "deleteCommonConfig", "summary": "共通設定の削除", - "description": "指定したCommonConfigIdの共通設定を削除します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したCommonConfigIdの共通設定を削除します。\n", "tags": [ "common_configs" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -1541,11 +1582,19 @@ } ], "post": { + "operationId": "postCommonConfigCopy", "summary": "共通設定のコピー", - "description": "指定した共通設定と同じ内容の共通設定を別の共通設定名で作成します。\n\n### Authorizations\ndpf_write\n", + "description": "指定した共通設定と同じ内容の共通設定を別の共通設定名で作成します。\n", "tags": [ "common_configs" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -1604,11 +1653,19 @@ } ], "patch": { + "operationId": "patchCommonConfigManagedDns", "summary": "マネージドDNSサーバの状態更新", - "description": "マネージドDNSサーバをプライマリネームサーバとして有効もしくは無効とするかの切り替えを行えます。\n\n### Authorizations\ndpf_write\n", + "description": "マネージドDNSサーバをプライマリネームサーバとして有効もしくは無効とするかの切り替えを行えます。\n", "tags": [ "common_configs" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -1664,11 +1721,19 @@ } ], "get": { + "operationId": "getContractPartnerList", "summary": "DPF連携サービスの一覧取得", - "description": "DPFが連携しているサービスの一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "DPFが連携しているサービスの一覧を取得します。\n", "tags": [ "contract_partners" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -1705,11 +1770,19 @@ }, "/contracts": { "get": { + "operationId": "getContractList", "summary": "DPF契約情報の一覧取得", - "description": "DPF契約情報の一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "DPF契約情報の一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "contracts" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -1737,6 +1810,9 @@ }, { "$ref": "#/components/parameters/KeywordsDescription" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -1756,7 +1832,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -1775,11 +1851,19 @@ }, "/contracts/count": { "get": { + "operationId": "getContractListCount", "summary": "DPF契約情報の件数取得", - "description": "DPF契約の件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "DPF契約の件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "contracts" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -1801,6 +1885,9 @@ }, { "$ref": "#/components/parameters/KeywordsDescription" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -1820,7 +1907,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -1844,11 +1931,19 @@ } ], "get": { + "operationId": "getContract", "summary": "DPF契約情報の取得", - "description": "指定したContractIdのDPF契約を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したContractIdのDPF契約を取得します。\n", "tags": [ "contracts" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -1883,11 +1978,19 @@ } }, "patch": { + "operationId": "patchContract", "summary": "DPF契約情報の更新", - "description": "指定したContractIdのDPF契約を更新します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したContractIdのDPF契約を更新します。\n", "tags": [ "contracts" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -1936,6 +2039,74 @@ } } }, + "/contracts/{ContractId}/labels": { + "parameters": [ + { + "$ref": "#/components/parameters/ContractId" + } + ], + "get": { + "operationId": "getContractLabels", + "summary": "DPF契約情報のラベル一覧取得", + "description": "指定したContractIdのラベルの一覧を取得します。\n", + "tags": [ + "contracts" + ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/GetContractLabelsSuccessResponse" + }, + "400": { + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | contract | 指定したContractIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BadRequest" + }, + "examples": { + "BadRequest": { + "$ref": "#/components/examples/BadRequest" + } + } + } + } + } + } + }, + "put": { + "operationId": "putContractLabels", + "summary": "DPF契約情報のラベル一括更新", + "description": "指定したContractIdのラベルを一括更新します。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n", + "tags": [ + "contracts" + ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/PutContractLabels" + }, + "responses": { + "202": { + "$ref": "#/components/responses/Accepted" + }, + "400": { + "$ref": "#/components/responses/PutContractLabelsBadRequest" + } + } + } + }, "/contracts/{ContractId}/zones": { "parameters": [ { @@ -1943,11 +2114,19 @@ } ], "get": { + "operationId": "getContractsZoneList", "summary": "DPF契約に紐付くゾーンの一覧取得", - "description": "指定したContractIdのDPF契約に紐付くゾーンの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "指定したContractIdのDPF契約に紐付くゾーンの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "zones (contracts)" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -1984,6 +2163,9 @@ }, { "$ref": "#/components/parameters/KeywordsZoneProxyEnabled" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -2003,7 +2185,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | contract | 指定したContractIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | contract | 指定したContractIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -2027,11 +2209,19 @@ } ], "patch": { + "operationId": "patchContractsZoneCommonConfigs", "summary": "DPF契約に紐付くゾーンの共通設定の更新", - "description": "指定したContractIdの共通設定を切り替えます。\n\n### Authorizations\ndpf_write\n", + "description": "指定したContractIdの共通設定を切り替えます。\n", "tags": [ "zones (contracts)" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -2087,11 +2277,19 @@ } ], "get": { + "operationId": "getContractsZoneListCount", "summary": "DPF契約に紐付くゾーンの件数取得", - "description": "指定したContractIdのDPF契約に紐付くゾーンの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "指定したContractIdのDPF契約に紐付くゾーンの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "zones (contracts)" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -2122,6 +2320,9 @@ }, { "$ref": "#/components/parameters/KeywordsZoneProxyEnabled" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -2141,7 +2342,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | contract | 指定したContractIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | contract | 指定したContractIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -2165,11 +2366,19 @@ } ], "get": { + "operationId": "getContractsLbDomainList", "summary": "DPF契約に紐付くLBドメインの一覧取得", - "description": "指定したContractIdのDPF契約に紐付くLBドメインの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n\n### Authorizations\ndpf_read\n", + "description": "指定したContractIdのDPF契約に紐付くLBドメインの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n", "tags": [ "lb_domains (contracts)" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -2202,7 +2411,7 @@ "$ref": "#/components/parameters/KeywordsCommonConfigId" }, { - "$ref": "#/components/parameters/KeywordsLbDomainLabel" + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -2246,11 +2455,19 @@ } ], "patch": { + "operationId": "patchContractsLbDomainCommonConfigs", "summary": "DPF契約に紐付くLBドメインの共通設定の更新", - "description": "指定したContractIdの共通設定を切り替えます。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n\n### Authorizations\ndpf_write\n", + "description": "指定したContractIdの共通設定を切り替えます。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n", "tags": [ "lb_domains (contracts)" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -2306,11 +2523,19 @@ } ], "get": { + "operationId": "getContractsLbDomainListCount", "summary": "DPF契約に紐付くLBドメインの件数取得", - "description": "指定したContractIdのDPF契約に紐付くLBドメインの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n\n### Authorizations\ndpf_read\n", + "description": "指定したContractIdのDPF契約に紐付くLBドメインの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n", "tags": [ "lb_domains (contracts)" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -2337,7 +2562,7 @@ "$ref": "#/components/parameters/KeywordsCommonConfigId" }, { - "$ref": "#/components/parameters/KeywordsLbDomainLabel" + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -2381,11 +2606,19 @@ } ], "get": { + "operationId": "getDefaultTtlList", "summary": "デフォルトTTLの取得", - "description": "デフォルトTTLの一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "デフォルトTTLの一覧を取得します。\n", "tags": [ "default_ttl" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -2420,11 +2653,19 @@ } }, "patch": { + "operationId": "patchDefaultTtl", "summary": "デフォルトTTLの更新", - "description": "デフォルトTTLを更新します。\\\n**[編集中レコードのゾーン反映](#tag/zones/paths/~1zones~1{ZoneId}~1changes/patch)**を実行するまでは権威サーバには反映されません。\n\n### Authorizations\ndpf_write\n", + "description": "デフォルトTTLを更新します。\\\n[**編集中レコードのゾーン反映**](#tag/zones/operation/patchZoneChanges)を実行するまでは権威サーバには反映されません。\n", "tags": [ "default_ttl" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -2480,11 +2721,19 @@ } ], "delete": { + "operationId": "deleteDefaultTtlChanges", "summary": "編集中デフォルトTTLの取消", - "description": "デフォルトTTLの操作を取消します。\n\n### Authorizations\ndpf_write\n", + "description": "デフォルトTTLの操作を取消します。\n", "tags": [ "default_ttl" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -2526,11 +2775,19 @@ } ], "get": { + "operationId": "getDefaultTtlDiffs", "summary": "デフォルトTTLの編集差分の取得", - "description": "現在DNSに登録されているデフォルトTTLと反映予定のデフォルトTTLの差分一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "現在DNSに登録されているデフォルトTTLと反映予定のデフォルトTTLの差分一覧を取得します。\n", "tags": [ "default_ttl" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -2567,11 +2824,19 @@ }, "/delegations": { "get": { + "operationId": "getDelegationList", "summary": "ネームサーバ申請候補の一覧取得", - "description": "ネームサーバとして申請可能なゾーンの候補の一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "ネームサーバとして申請可能なゾーンの候補の一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "delegations" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -2602,6 +2867,9 @@ }, { "$ref": "#/components/parameters/KeywordsDelegationsRequested" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -2621,7 +2889,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -2638,11 +2906,19 @@ } }, "post": { + "operationId": "postDelegation", "summary": "ネームサーバ申請", - "description": "指定したゾーンを申請します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したゾーンを申請します。\n", "tags": [ "delegations" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -2693,11 +2969,19 @@ }, "/delegations/count": { "get": { + "operationId": "getDelegationListCount", "summary": "ネームサーバ申請候補の件数取得", - "description": "ネームサーバとして申請可能なゾーンの候補の件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "ネームサーバとして申請可能なゾーンの候補の件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "delegations" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -2722,6 +3006,9 @@ }, { "$ref": "#/components/parameters/KeywordsDelegationsRequested" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -2741,7 +3028,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -2765,11 +3052,19 @@ } ], "get": { + "operationId": "getDnssecList", "summary": "DNSSEC情報の取得", - "description": "DNSSEC情報の一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "DNSSEC情報の一覧を取得します。\n", "tags": [ "dnssec" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -2804,11 +3099,19 @@ } }, "patch": { + "operationId": "patchDnssec", "summary": "DNSSEC情報の更新", - "description": "DNSSECの情報を更新します。\n\n### Authorizations\ndpf_write\n", + "description": "DNSSECの情報を更新します。\n", "tags": [ "dnssec" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -2864,11 +3167,19 @@ } ], "patch": { + "operationId": "patchDnssecKskRollover", "summary": "KSKロールオーバーの開始", - "description": "指定したゾーンに対してKSKロールオーバーを開始します。\\\nロールオーバーはds_stateが「3」の場合のみ開始できます。\n\n### Authorizations\ndpf_write\n", + "description": "指定したゾーンに対してKSKロールオーバーを開始します。\\\nロールオーバーはds_stateが「3」の場合のみ開始できます。\n", "tags": [ "dnssec" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -2910,11 +3221,19 @@ } ], "get": { + "operationId": "getDsRecordList", "summary": "DSレコードの一覧取得", - "description": "上位のネームサーバに登録が必要なDSレコードを取得できます。\n\n### Authorizations\ndpf_read\n", + "description": "上位のネームサーバに登録が必要なDSレコードを取得できます。\n", "tags": [ "ds_records" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -2956,11 +3275,19 @@ } ], "get": { + "operationId": "getJob", "summary": "非同期リクエストの状態確認", - "description": "ジョブの進捗状況を取得します。\\\nこのAPIの詳しい利用方法は、**[非同期リクエスト](#section/2./2.4)**を参照してください。\n\n### Authorizations\ndpf_read\n", + "description": "ジョブの進捗状況を取得します。\\\nこのAPIの詳しい利用方法は、[**非同期リクエスト**](#section/2./2.4)を参照してください。\n", "tags": [ "jobs" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -3008,11 +3335,19 @@ } ], "get": { + "operationId": "getContractsLogList", "summary": "DPF契約操作ログの一覧取得", - "description": "DPF契約を操作したログの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "DPF契約を操作したログの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "logs (contracts)" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -3101,11 +3436,19 @@ } ], "get": { + "operationId": "getContractsLogListCount", "summary": "DPF契約操作ログの件数取得", - "description": "DPF契約を操作したログの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "DPF契約を操作したログの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "logs (contracts)" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -3185,11 +3528,19 @@ } ], "get": { + "operationId": "getZonesLogList", "summary": "ゾーン操作ログの一覧取得", - "description": "ゾーンを操作したログの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "ゾーンを操作したログの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "logs (zones)" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -3278,11 +3629,19 @@ } ], "get": { + "operationId": "getZonesLogListCount", "summary": "ゾーン操作ログの件数取得", - "description": "ゾーンを操作したログの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "ゾーンを操作したログの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "logs (zones)" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -3357,11 +3716,29 @@ }, "/ping": { "get": { + "operationId": "getPing", "summary": "API疎通確認", - "description": "APIへの疎通を確認できます。\n\n### Authorizations\ndpf_read\\\ndpf_write\\\ndpf_contract\n", + "description": "APIへの疎通を確認できます。\n", "tags": [ "ping" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + }, + { + "DPFOperator": [ + "dpf_write" + ] + }, + { + "ContractOperator": [ + "dpf_contract" + ] + } + ], "responses": { "200": { "description": "OK", @@ -3388,11 +3765,19 @@ } ], "get": { + "operationId": "getQpList", "summary": "月別のQPSの一覧取得", - "description": "DPF契約の月別のQPSを取得できます。\\\nDPF契約に紐付くゾーンおよびLBドメインの月別のQPSと、\\\nゾーンおよびLBドメインのクエリ数を元に集計したDPF契約の月別のQPSが取得できます。\n\n### Authorizations\ndpf_read\n", + "description": "DPF契約の月別のQPSを取得できます。\\\nDPF契約に紐付くゾーンおよびLBドメインの月別のQPSと、\\\nゾーンおよびLBドメインのクエリ数を元に集計したDPF契約の月別のQPSが取得できます。\n", "tags": [ "qps" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -3434,11 +3819,19 @@ } ], "get": { + "operationId": "getRecordList", "summary": "レコードの一覧取得", - "description": "レコード情報の一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "レコード情報の一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "records" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -3469,6 +3862,9 @@ }, { "$ref": "#/components/parameters/KeywordsOperator" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -3488,7 +3884,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -3504,21 +3900,29 @@ } } }, - "post": { - "summary": "レコードの作成", - "description": "新しくレコードを作成します。\\\n**[編集中レコードのゾーン反映](#tag/zones/paths/~1zones~1{ZoneId}~1changes/patch)**を実行するまでは権威サーバには反映されません。\n\n### Authorizations\ndpf_write\n", + "put": { + "operationId": "putRecord", + "summary": "レコードの一括更新", + "description": "レコードを一括更新します。\\\n[**編集中レコードのゾーン反映**](#tag/zones/operation/patchZoneChanges)を実行するまでは権威サーバには反映されません。\n", "tags": [ "records" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PostRecord" + "$ref": "#/components/schemas/PutRecord" }, "examples": { - "PostRecord": { - "$ref": "#/components/examples/PostRecord" + "PutRecord": { + "$ref": "#/components/examples/PutRecord" } } } @@ -3541,11 +3945,11 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\nforbidden | zone | ゾーンプロキシの設定が有効のため操作できません\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | record | レコードとして不正な形式です\nduplicated | record | 同一nameおよびrrtypeのレコードがすでに作成されています\ninvalid | name | 指定したnameを確認してください\ncname_and_other_mixed | name | 指定したnameがCNAMEと同一です\ncorresponding_ns_not_found | name | 指定したDSレコードのnameに対応するNSレコードが存在していません\ninvalid_quotes | rdata | TXTレコードのrdataは「\"」で囲むようにしてください。
JSON string として \" で囲まれている内部に、さらに rdata としての \" で囲んで含める必要があります。
したがって、JSON string 全体としては \"\\\\\"example\\\\\"\" といった形になります。\ninvalid | rdata | 指定したrdataを確認してください\nreference_not_found | rdata | 参照先が存在しません\nreference_alias | rdata | 指定した参照先がCNAMEです\nmultiple_rdata_found | rdata | 指定したレコードタイプでは複数のrdataを指定することはできません\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | zone | 指定したZoneIdを確認してください\nforbidden | zone | ゾーンプロキシの設定が有効のため操作できません\ntoo_large | records | 指定したパラメータのデータ量が10Mibを超えています\nrequired | records | レコードのパラメータを指定してください\nduplicated | records | 同一nameおよびrrtypeのレコードを指定しています\ninvalid | records | レコードとして不正な形式です\ninvalid_type | records | 指定したレコードの型を確認してください\ninvalid_length | records | 指定したレコードの文字数を確認してください\ninvalid_char_type | records | 指定したレコードの文字種を確認してください\ninvalid_format | records | 指定したレコードのフォーマットを確認してください\nout_of_range | records | 指定したパラメータの数値を確認してください\ntoo_few | records | 登録の必須指定数を下回っています\ntoo_many | records | 登録の上限数を超えています\nforbidden | records | 許可されていない値を指定しています\nsoa_not_found | records | SOAレコードを指定してください\napex_ns_not_found | records | Zone ApexのNSレコードを指定してください\ncname_and_other_mixed | records | 指定したNameがCNAMEと同一のため操作できません\ncorresponding_ns_not_found | records | 指定したDSレコードのnameに対応するNSレコードが存在していません\ninvalid_quotes | records | TXTレコードのrdataは「\"」で囲むようにしてください。
JSON string として \" で囲まれている内部に、さらに rdata としての \" で囲んで含める必要があります。
したがって、JSON string 全体としては \"\\\\\"example\\\\\"\" といった形になります。\nreference_not_found | records | 参照先が存在しません\nreference_alias | records | 指定した参照先がCNAMEです\nmultiple_rdata_found | records | 指定したレコードタイプでは複数のrdataを指定することはできません\ninvalid_length_key | records | 指定したlabel_keyの文字数を確認してください\ninvalid_char_type_key | records | 指定したlabel_keyの文字種を確認してください\ninvalid_format_key | records | 指定したlabel_keyのフォーマットを確認してください\ninvalid_type_value | records | 指定したlabel_valueの型を確認してください\ninvalid_length_value | records | 指定したlabel_valueの文字数を確認してください\ninvalid_char_type_value | records | 指定したlabel_valueの文字種を確認してください\ninvalid_format_value | records | 指定したlabel_valueのフォーマットを確認してください\n
\n", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BadRequest" + "$ref": "#/components/schemas/TargetBadRequest" }, "examples": { "BadRequest": { @@ -3556,20 +3960,89 @@ } } } - } - }, - "/zones/{ZoneId}/records/count": { - "parameters": [ - { - "$ref": "#/components/parameters/ZoneId" - } - ], - "get": { - "summary": "レコードの件数取得", - "description": "レコード情報の件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", - "tags": [ + }, + "post": { + "operationId": "postRecord", + "summary": "レコードの作成", + "description": "新しくレコードを作成します。\\\n[**編集中レコードのゾーン反映**](#tag/zones/operation/patchZoneChanges)を実行するまでは権威サーバには反映されません。\n", + "tags": [ + "records" + ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PostRecord" + }, + "examples": { + "PostRecord": { + "$ref": "#/components/examples/PostRecord" + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncResponse" + }, + "examples": { + "AsyncResponse": { + "$ref": "#/components/examples/AsyncResponse" + } + } + } + } + }, + "400": { + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\nforbidden | zone | ゾーンプロキシの設定が有効のため操作できません\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | record | レコードとして不正な形式です\nduplicated | record | 同一nameおよびrrtypeのレコードがすでに作成されています\ninvalid | name | 指定したnameを確認してください\ncname_and_other_mixed | name | 指定したnameがCNAMEと同一です\ncorresponding_ns_not_found | name | 指定したDSレコードのnameに対応するNSレコードが存在していません\ninvalid_quotes | rdata | TXTレコードのrdataは「\"」で囲むようにしてください。
JSON string として \" で囲まれている内部に、さらに rdata としての \" で囲んで含める必要があります。
したがって、JSON string 全体としては \"\\\\\"example\\\\\"\" といった形になります。\ninvalid | rdata | 指定したrdataを確認してください\nreference_not_found | rdata | 参照先が存在しません\nreference_alias | rdata | 指定した参照先がCNAMEです\nmultiple_rdata_found | rdata | 指定したレコードタイプでは複数のrdataを指定することはできません\ninvalid_format_key | labels | 指定したlabel_keyのフォーマットを確認してください\ninvalid_length_key | labels | 指定したlabel_keyの文字数を確認してください\ninvalid_char_type_key | labels | 指定したlabel_keyの文字種を確認してください\ninvalid_type_value | labels | 指定したlabel_valueの型を確認してください\ninvalid_format_value | labels | 指定したlabel_valueのフォーマットを確認してください\ninvalid_length_value | labels | 指定したlabel_valueの文字数を確認してください\ninvalid_char_type_value | labels | 指定したlabel_valueの文字種を確認してください\n\n
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TargetBadRequest" + }, + "examples": { + "BadRequest": { + "$ref": "#/components/examples/BadRequest" + } + } + } + } + } + } + } + }, + "/zones/{ZoneId}/records/count": { + "parameters": [ + { + "$ref": "#/components/parameters/ZoneId" + } + ], + "get": { + "operationId": "getRecordListCount", + "summary": "レコードの件数取得", + "description": "レコード情報の件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", + "tags": [ "records" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -3594,6 +4067,9 @@ }, { "$ref": "#/components/parameters/KeywordsOperator" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -3613,7 +4089,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -3637,11 +4113,19 @@ } ], "get": { + "operationId": "getRecordCurrents", "summary": "DNS反映済レコードの一覧取得", - "description": "現在DNSに登録されているレコードの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "現在DNSに登録されているレコードの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "records" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -3672,6 +4156,9 @@ }, { "$ref": "#/components/parameters/KeywordsOperator" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -3691,7 +4178,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -3715,11 +4202,19 @@ } ], "get": { + "operationId": "getRecordCurrentsCount", "summary": "DNS反映済レコードの件数取得", - "description": "現在DNSに登録されているレコードの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "現在DNSに登録されているレコードの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "records" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -3744,6 +4239,9 @@ }, { "$ref": "#/components/parameters/KeywordsOperator" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -3763,7 +4261,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -3787,11 +4285,19 @@ } ], "get": { + "operationId": "getRecordDiffs", "summary": "レコードの編集差分の一覧取得", - "description": "現在DNSに登録されているレコードと反映予定のレコードの差分一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "現在DNSに登録されているレコードと反映予定のレコードの差分一覧を取得します。\n", "tags": [ "records" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -3819,6 +4325,9 @@ }, { "$ref": "#/components/parameters/KeywordsDescription" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -3838,7 +4347,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -3862,11 +4371,19 @@ } ], "get": { + "operationId": "getRecordDiffsCount", "summary": "レコードの編集差分の件数取得", - "description": "現在DNSに登録されているレコードと反映予定のレコードの差分数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "現在DNSに登録されているレコードと反映予定のレコードの差分数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "records" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -3888,6 +4405,9 @@ }, { "$ref": "#/components/parameters/KeywordsDescription" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -3907,7 +4427,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -3934,11 +4454,19 @@ } ], "get": { + "operationId": "getRecord", "summary": "レコードの取得", - "description": "指定したRecordIdのレコードを取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したRecordIdのレコードを取得します。\n", "tags": [ "records" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -3973,11 +4501,19 @@ } }, "patch": { + "operationId": "patchRecord", "summary": "レコードの更新", - "description": "指定したRecordIdのレコードを更新します。\\\n**[編集中レコードのゾーン反映](#tag/zones/paths/~1zones~1{ZoneId}~1changes/patch)**を実行するまでは権威サーバには反映されません。\n\n### Authorizations\ndpf_write\n", + "description": "指定したRecordIdのレコードを更新します。\\\n[**編集中レコードのゾーン反映**](#tag/zones/operation/patchZoneChanges)を実行するまでは権威サーバには反映されません。\n", "tags": [ "records" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -4009,11 +4545,11 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\nforbidden | zone | ゾーンプロキシの設定が有効のため操作できません\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | record | 指定したRecordIdを確認してください\nforbidden | record | レコードの状態を確認してください\ninvalid | record | レコードとして不正な形式です\ninvalid_quotes | rdata | TXTレコードのrdataは「\"」で囲むようにしてください。
JSON string として \" で囲まれている内部に、さらに rdata としての \" で囲んで含める必要があります。
したがって、JSON string 全体としては \"\\\\\"example\\\\\"\" といった形になります。\ninvalid | rdata | 指定したrdataを確認してください\nreference_not_found | rdata | 参照先が存在しません\nreference_alias | rdata | 指定した参照先がCNAMEです\nmultiple_rdata_found | rdata | 指定したレコードタイプでは複数のrdataを指定することはできません\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\nforbidden | zone | ゾーンプロキシの設定が有効のため操作できません\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | record | 指定したRecordIdを確認してください\nforbidden | record | レコードの状態を確認してください\ninvalid | record | レコードとして不正な形式です\ninvalid_quotes | rdata | TXTレコードのrdataは「\"」で囲むようにしてください。
JSON string として \" で囲まれている内部に、さらに rdata としての \" で囲んで含める必要があります。
したがって、JSON string 全体としては \"\\\\\"example\\\\\"\" といった形になります。\ninvalid | rdata | 指定したrdataを確認してください\nreference_not_found | rdata | 参照先が存在しません\nreference_alias | rdata | 指定した参照先がCNAMEです\nmultiple_rdata_found | rdata | 指定したレコードタイプでは複数のrdataを指定することはできません\ninvalid_format_key | labels | 指定したlabel_keyのフォーマットを確認してください\ninvalid_length_key | labels | 指定したlabel_keyの文字数を確認してください\ninvalid_char_type_key | labels | 指定したlabel_keyの文字種を確認してください\ninvalid_type_value | labels | 指定したlabel_valueの型を確認してください\ninvalid_format_value | labels | 指定したlabel_valueのフォーマットを確認してください\ninvalid_length_value | labels | 指定したlabel_valueの文字数を確認してください\ninvalid_char_type_value | labels | 指定したlabel_valueの文字種を確認してください\n\n
\n", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BadRequest" + "$ref": "#/components/schemas/TargetBadRequest" }, "examples": { "BadRequest": { @@ -4026,11 +4562,19 @@ } }, "delete": { + "operationId": "deleteRecord", "summary": "レコードの削除", - "description": "指定したRecordIdのレコードを削除します。\\\n**[編集中レコードのゾーン反映](#tag/zones/paths/~1zones~1{ZoneId}~1changes/patch)**を実行するまでは権威サーバには反映されません。\n\n### Authorizations\ndpf_write\n", + "description": "指定したRecordIdのレコードを削除します。\\\n[**編集中レコードのゾーン反映**](#tag/zones/operation/patchZoneChanges)を実行するまでは権威サーバには反映されません。\n", "tags": [ "records" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -4048,7 +4592,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\nforbidden | zone | ゾーンプロキシの設定が有効のため操作できません\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | record | 指定したRecordIdを確認してください\nforbidden | record | レコードの状態を確認してください\nsoa_not_found | record | SOAレコードの削除はできません\napex_ns_not_found | record | Zone APEXのNSレコードのため削除はできません\ncorresponding_ns_not_found | name | 同一nameのDSレコードが存在するためNSレコードの削除はできません\nreference_not_found | rdata | 参照先が存在しないため削除できません\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\nforbidden | zone | ゾーンプロキシの設定が有効のため操作できません\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | record | 指定したRecordIdを確認してください\nforbidden | record | レコードの状態を確認してください\nsoa_not_found | record | SOAレコードの削除はできません\napex_ns_not_found | record | Zone ApexのNSレコードのため削除はできません\ncorresponding_ns_not_found | name | 同一nameのDSレコードが存在するためNSレコードの削除はできません\nreference_not_found | rdata | 参照先が存在しないため削除できません\n\n
\n", "content": { "application/json": { "schema": { @@ -4075,11 +4619,19 @@ } ], "delete": { + "operationId": "deleteRecordChanges", "summary": "編集中レコードの取消", - "description": "指定したRecordIdのレコードの操作を取消します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したRecordIdのレコードの操作を取消します。\n", "tags": [ "records" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -4114,6 +4666,51 @@ } } }, + "/zones/{ZoneId}/records/{RecordId}/ds_records": { + "parameters": [ + { + "$ref": "#/components/parameters/ZoneId" + }, + { + "$ref": "#/components/parameters/RecordId" + } + ], + "get": { + "operationId": "getDsRecordsFromCds", + "summary": "CDS経由のDSレコードの取得", + "description": "指定したRecordIdのレコードによって取り込まれるCDS経由のDSレコードを取得します。\n", + "tags": [ + "records" + ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/GetDsRecordsSuccessResponse" + }, + "400": { + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | record | 指定したRecordIdを確認してください\ninvalid_record_id | record | Zone Apex以外のNSレコードのRecordIdを指定してください\n\n
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BadRequest" + }, + "examples": { + "BadRequest": { + "$ref": "#/components/examples/BadRequest" + } + } + } + } + } + } + } + }, "/contracts/{ContractId}/tsigs": { "parameters": [ { @@ -4121,11 +4718,19 @@ } ], "get": { + "operationId": "getTsigList", "summary": "TSIG鍵の一覧取得", - "description": "TSIG鍵情報の一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "TSIG鍵情報の一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "tsigs" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -4180,11 +4785,19 @@ } }, "post": { + "operationId": "postTsig", "summary": "TSIG鍵の作成", - "description": "新しくTSIG鍵を作成します。\n\n### Authorizations\ndpf_write\n", + "description": "新しくTSIG鍵を作成します。\n", "tags": [ "tsigs" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -4240,11 +4853,19 @@ } ], "get": { + "operationId": "getTsigListCount", "summary": "TSIG鍵の件数取得", - "description": "TSIG鍵の件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "TSIG鍵の件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "tsigs" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -4303,11 +4924,19 @@ } ], "get": { + "operationId": "getTsig", "summary": "TSIG鍵の取得", - "description": "指定したTsigIdのTSIG鍵を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したTsigIdのTSIG鍵を取得します。\n", "tags": [ "tsigs" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -4342,11 +4971,19 @@ } }, "patch": { + "operationId": "patchTsig", "summary": "TSIG鍵の更新", - "description": "指定したTsigIdのTSIG鍵を更新します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したTsigIdのTSIG鍵を更新します。\n", "tags": [ "tsigs" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -4395,11 +5032,19 @@ } }, "delete": { + "operationId": "deleteTsig", "summary": "TSIG鍵の削除", - "description": "指定したTsigIdのTSIG鍵を削除します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したTsigIdのTSIG鍵を削除します。\n", "tags": [ "tsigs" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -4444,11 +5089,19 @@ } ], "get": { + "operationId": "getTsigCommonConfigs", "summary": "TSIG鍵を利用している共通設定の一覧取得", - "description": "指定したTSIG鍵を使用している共通設定の一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したTSIG鍵を使用している共通設定の一覧を取得します。\n", "tags": [ "tsigs" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Offset" @@ -4501,11 +5154,19 @@ } ], "get": { + "operationId": "getTsigCommonConfigsCount", "summary": "TSIG鍵を利用している共通設定の件数取得", - "description": "指定したTSIG鍵を使用している共通設定の件数を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したTSIG鍵を使用している共通設定の件数を取得します。\n", "tags": [ "tsigs" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -4547,11 +5208,19 @@ } ], "get": { + "operationId": "getZoneHistoryList", "summary": "ゾーン反映履歴の一覧取得", - "description": "ゾーン反映の履歴の一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "ゾーン反映の履歴の一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "zone_histories" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -4616,11 +5285,19 @@ } ], "get": { + "operationId": "getZoneHistoryListCount", "summary": "ゾーン反映履歴の件数取得", - "description": "ゾーン反映の履歴の件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "ゾーン反映の履歴の件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "zone_histories" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -4679,11 +5356,19 @@ } ], "get": { + "operationId": "getZoneHistoryText", "summary": "ゾーン反映時のRFC1035形式のテキストの取得", - "description": "ゾーン反映の履歴をRFC1035形式のテキストファイルで取得します。\n\n### Authorizations\ndpf_read\n", + "description": "ゾーン反映の履歴をRFC1035形式のテキストファイルで取得します。\n", "tags": [ "zone_histories" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -4725,11 +5410,19 @@ } ], "get": { + "operationId": "getZoneProxyList", "summary": "ゾーンプロキシ設定の取得", - "description": "ゾーンプロキシの設定を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "ゾーンプロキシの設定を取得します。\n", "tags": [ "zone_proxy" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -4764,11 +5457,19 @@ } }, "patch": { + "operationId": "patchZoneProxy", "summary": "ゾーンプロキシ設定の更新", - "description": "ゾーンプロキシの設定を更新します。\n\n### Authorizations\ndpf_write\n", + "description": "ゾーンプロキシの設定を更新します。\n", "tags": [ "zone_proxy" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -4824,11 +5525,19 @@ } ], "get": { + "operationId": "getZoneProxyHealthCheck", "summary": "プライマリネームサーバのヘルスチェック結果の取得", - "description": "ゾーン転送のヘルスチェック結果の一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "ゾーン転送のヘルスチェック結果の一覧を取得します。\n", "tags": [ "zone_proxy" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -4865,11 +5574,19 @@ }, "/zones": { "get": { + "operationId": "getZoneList", "summary": "ゾーンの一覧取得", - "description": "DPF契約に紐付くゾーンの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "DPF契約に紐付くゾーンの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "zones" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -4906,6 +5623,9 @@ }, { "$ref": "#/components/parameters/KeywordsZoneProxyEnabled" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -4925,7 +5645,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -4944,11 +5664,19 @@ }, "/zones/count": { "get": { + "operationId": "getZoneListCount", "summary": "ゾーンの件数取得", - "description": "DPF契約に紐付くゾーンの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "DPF契約に紐付くゾーンの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "zones" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -4979,6 +5707,9 @@ }, { "$ref": "#/components/parameters/KeywordsZoneProxyEnabled" + }, + { + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -4998,7 +5729,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\ninvalid | schema | 指定したパラメータを確認してください\ninvalid | keywords | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -5022,11 +5753,19 @@ } ], "get": { + "operationId": "getZone", "summary": "ゾーンの取得", - "description": "指定したZoneIdのゾーンを取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したZoneIdのゾーンを取得します。\n", "tags": [ "zones" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -5061,11 +5800,19 @@ } }, "patch": { + "operationId": "patchZone", "summary": "ゾーンの更新", - "description": "指定したZoneIdのゾーンを更新します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したZoneIdのゾーンを更新します。\n", "tags": [ "zones" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -5114,38 +5861,114 @@ } } }, - "/zones/{ZoneId}/changes": { + "/zones/{ZoneId}/labels": { "parameters": [ { "$ref": "#/components/parameters/ZoneId" } ], - "patch": { - "summary": "編集中レコードのゾーン反映", - "description": "編集中のレコードの操作を反映します。\n\n### Authorizations\ndpf_write\n", + "get": { + "operationId": "getZoneLabels", + "summary": "ゾーンのラベル一覧取得", + "description": "指定したZoneIdのラベルの一覧を取得します。\n", "tags": [ "zones" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PatchZoneCommit" - }, - "examples": { - "PatchZoneCommit": { - "$ref": "#/components/examples/PatchZoneCommit" - } - } - } + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] } - }, + ], "responses": { - "202": { - "description": "Accepted", - "content": { - "application/json": { - "schema": { + "200": { + "$ref": "#/components/responses/GetZoneLabelsSuccessResponse" + }, + "400": { + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BadRequest" + }, + "examples": { + "BadRequest": { + "$ref": "#/components/examples/BadRequest" + } + } + } + } + } + } + }, + "put": { + "operationId": "putZoneLabels", + "summary": "ゾーンのラベル一括更新", + "description": "指定したZoneIdのラベルを一括更新します。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n", + "tags": [ + "zones" + ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/PutZoneLabels" + }, + "responses": { + "202": { + "$ref": "#/components/responses/Accepted" + }, + "400": { + "$ref": "#/components/responses/PutZoneLabelsBadRequest" + } + } + } + }, + "/zones/{ZoneId}/changes": { + "parameters": [ + { + "$ref": "#/components/parameters/ZoneId" + } + ], + "patch": { + "operationId": "patchZoneChanges", + "summary": "編集中レコードのゾーン反映", + "description": "編集中のレコードの操作を反映します。\n", + "tags": [ + "zones" + ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PatchZoneCommit" + }, + "examples": { + "PatchZoneCommit": { + "$ref": "#/components/examples/PatchZoneCommit" + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/AsyncResponse" }, "examples": { @@ -5174,11 +5997,19 @@ } }, "delete": { + "operationId": "deleteZoneChanges", "summary": "編集中レコードの一括取消", - "description": "編集中のレコードの操作を一括で取り消します。\n\n### Authorizations\ndpf_write\n", + "description": "編集中のレコードの操作を一括で取り消します。\n", "tags": [ "zones" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -5220,11 +6051,19 @@ } ], "get": { + "operationId": "getZoneContract", "summary": "ゾーンに紐付くDPF契約情報の取得", - "description": "指定したZoneIdのゾーンに紐付くDPF契約情報を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したZoneIdのゾーンに紐付くDPF契約情報を取得します。\n", "tags": [ "zones" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -5266,11 +6105,19 @@ } ], "get": { + "operationId": "getZoneManagedDnsServers", "summary": "マネージドDNSサーバの一覧取得", - "description": "指定したZoneIdのマネージドDNSサーバの一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したZoneIdのマネージドDNSサーバの一覧を取得します。\n", "tags": [ "zones" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -5307,11 +6154,19 @@ }, "/lb_domains": { "get": { + "operationId": "getLbDomainList", "summary": "LBドメインの一覧取得", - "description": "DPF契約に紐付くLBドメインの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n\n### Authorizations\ndpf_read\n", + "description": "DPF契約に紐付くLBドメインの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n", "tags": [ "lb_domains" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -5344,7 +6199,7 @@ "$ref": "#/components/parameters/KeywordsCommonConfigId" }, { - "$ref": "#/components/parameters/KeywordsLbDomainLabel" + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -5383,11 +6238,19 @@ }, "/lb_domains/count": { "get": { + "operationId": "getLbDomainListCount", "summary": "LBドメインの件数取得", - "description": "DPF契約に紐付くLBドメインの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n\n### Authorizations\ndpf_read\n", + "description": "DPF契約に紐付くLBドメインの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n", "tags": [ "lb_domains" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -5414,7 +6277,7 @@ "$ref": "#/components/parameters/KeywordsCommonConfigId" }, { - "$ref": "#/components/parameters/KeywordsLbDomainLabel" + "$ref": "#/components/parameters/KeywordsLabel" } ], "responses": { @@ -5458,11 +6321,19 @@ } ], "get": { + "operationId": "getLbDomain", "summary": "LBドメインの取得", - "description": "指定したLbDomainIdのLBドメインを取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したLbDomainIdのLBドメインを取得します。\n", "tags": [ "lb_domains" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -5497,11 +6368,19 @@ } }, "patch": { + "operationId": "patchLbDomain", "summary": "LBドメインの更新", - "description": "指定したLbDomainIdのLBドメインを更新します。\\\nRuleResourceNameを指定することで適用ルールの切り替えができます。\n\n### Authorizations\ndpf_write\n", + "description": "指定したLbDomainIdのLBドメインを更新します。\\\nRuleResourceNameを指定することで適用ルールの切り替えができます。\n", "tags": [ "lb_domains" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -5557,11 +6436,19 @@ } ], "get": { - "summary": "ラベルの一覧取得", - "description": "指定したLbDomainIdのラベルの一覧を取得します。\\\nラベルの詳細な説明については**[こちら](#tag/lb_domains)**\n\n### Authorizations\ndpf_read\n", + "operationId": "getLbDomainLabels", + "summary": "LBドメインのラベル一覧取得", + "description": "指定したLbDomainIdのラベルの一覧を取得します。\n", "tags": [ "lb_domains" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -5596,16 +6483,24 @@ } }, "put": { - "summary": "ラベルの一括更新", - "description": "指定したLbDomainIdのラベルを一括更新します。\\\nラベルの詳細な説明については**[こちら](#tag/lb_domains)**\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n\n### Authorizations\ndpf_write\n", + "operationId": "putLbDomainLabels", + "summary": "LBドメインのラベル一括更新", + "description": "指定したLbDomainIdのラベルを一括更新します。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n", "tags": [ "lb_domains" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LbDomainLabels" + "$ref": "#/components/schemas/PutLbDomainLabels" }, "examples": { "PutLbDomainLabels": { @@ -5632,7 +6527,7 @@ } }, "400": { - "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | lb_domain | 指定したLbDomainIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\ninvalid_format_key | labels | 指定したlabel_keyのフォーマットを確認してください\ninvalid_length_key | labels | 指定したlabel_keyの文字数を確認してください\ninvalid_char_type_key | labels | 指定したlabel_keyの文字種を確認してください\nforbidden_key | labels | 指定できないlabel_keyを指定しています。label_keyを確認してください\ninvalid_format_value | labels | 指定したlabel_valueのフォーマットを確認してください\ninvalid_length_value | labels | 指定したlabel_valueの文字数を確認してください\ninvalid_char_type_value | labels | 指定したlabel_valueの文字種を確認してください\n\n
\n", + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | lb_domain | 指定したLbDomainIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\ninvalid_format_key | labels | 指定したlabel_keyのフォーマットを確認してください\ninvalid_length_key | labels | 指定したlabel_keyの文字数を確認してください\ninvalid_char_type_key | labels | 指定したlabel_keyの文字種を確認してください\ninvalid_format_value | labels | 指定したlabel_valueのフォーマットを確認してください\ninvalid_length_value | labels | 指定したlabel_valueの文字数を確認してください\ninvalid_char_type_value | labels | 指定したlabel_valueの文字種を確認してください\ninvalid_type_value | labels | 指定したパラメータの型を確認してください\n\n
\n", "content": { "application/json": { "schema": { @@ -5656,11 +6551,19 @@ } ], "get": { + "operationId": "getLbDomainContract", "summary": "LBドメインに紐付くDPF契約情報の取得", - "description": "指定したLbDomainIdのLBドメインに紐付くDPF契約情報を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したLbDomainIdのLBドメインに紐付くDPF契約情報を取得します。\n", "tags": [ "lb_domains" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -5702,11 +6605,19 @@ } ], "get": { + "operationId": "getMonitoringList", "summary": "監視の一覧取得", - "description": "監視の一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "監視の一覧を取得します。\n", "tags": [ "monitorings" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -5741,11 +6652,19 @@ } }, "post": { + "operationId": "postMonitoring", "summary": "監視の作成", - "description": "新しく監視を作成します。\\\n作成できる最大件数は50件です。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n\n### Authorizations\ndpf_write\n", + "description": "新しく監視を作成します。\\\n作成できる最大件数は50件です。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n", "tags": [ "monitorings" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -5753,8 +6672,17 @@ "$ref": "#/components/schemas/PostMonitoring" }, "examples": { - "PostMonitoring": { - "$ref": "#/components/examples/PostMonitoring" + "PostMonitoringPing": { + "$ref": "#/components/examples/PostMonitoringPing" + }, + "PostMonitoringTCP": { + "$ref": "#/components/examples/PostMonitoringTCP" + }, + "PostMonitoringHTTP": { + "$ref": "#/components/examples/PostMonitoringHTTP" + }, + "PostMonitoringStatic": { + "$ref": "#/components/examples/PostMonitoringStatic" } } } @@ -5804,11 +6732,19 @@ } ], "get": { + "operationId": "getMonitoring", "summary": "監視の取得", - "description": "指定したMonitoringResourceNameの監視を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したMonitoringResourceNameの監視を取得します。\n", "tags": [ "monitorings" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -5843,11 +6779,19 @@ } }, "patch": { + "operationId": "patchMonitoring", "summary": "監視の更新", - "description": "指定したMonitoringResourceNameの監視を更新します。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n\n### Authorizations\ndpf_write\n", + "description": "指定したMonitoringResourceNameの監視を更新します。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n", "tags": [ "monitorings" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -5855,8 +6799,17 @@ "$ref": "#/components/schemas/PatchMonitoring" }, "examples": { - "PatchMonitoring": { - "$ref": "#/components/examples/PatchMonitoring" + "PatchMonitoringPing": { + "$ref": "#/components/examples/PatchMonitoringPing" + }, + "PatchMonitoringTCP": { + "$ref": "#/components/examples/PatchMonitoringTCP" + }, + "PatchMonitoringHTTP": { + "$ref": "#/components/examples/PatchMonitoringHTTP" + }, + "PatchMonitoringStatic": { + "$ref": "#/components/examples/PatchMonitoringStatic" } } } @@ -5896,11 +6849,19 @@ } }, "delete": { + "operationId": "deleteMonitoring", "summary": "監視の削除", - "description": "指定したMonitoringResourceNameの監視を削除します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したMonitoringResourceNameの監視を削除します。\n", "tags": [ "monitorings" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -5942,11 +6903,19 @@ } ], "get": { + "operationId": "getSiteList", "summary": "サイトの一覧取得", - "description": "サイトの一覧を取得します。\n### Authorizations\ndpf_read\n", + "description": "サイトの一覧を取得します。\n", "tags": [ "sites" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -5981,11 +6950,19 @@ } }, "post": { + "operationId": "postSite", "summary": "サイトの作成", - "description": "新しくサイトを作成します。\\\n作成できる最大件数は50件です。\n### Authorizations\ndpf_write\n", + "description": "新しくサイトを作成します。\\\n作成できる最大件数は50件です。\n", "tags": [ "sites" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -6044,11 +7021,19 @@ } ], "get": { + "operationId": "getSite", "summary": "サイトの取得", - "description": "指定したSiteResourceNameのサイトを取得します。\n### Authorizations\ndpf_read\n", + "description": "指定したSiteResourceNameのサイトを取得します。\n", "tags": [ "sites" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -6083,11 +7068,19 @@ } }, "patch": { + "operationId": "patchSite", "summary": "サイトの更新", - "description": "指定したSiteResourceNameのサイトを更新します。\n### Authorizations\ndpf_write\n", + "description": "指定したSiteResourceNameのサイトを更新します。\n", "tags": [ "sites" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -6136,11 +7129,19 @@ } }, "delete": { + "operationId": "deleteSite", "summary": "サイトの削除", - "description": "指定したSiteResourceNameのサイトを削除します。\n### Authorizations\ndpf_write\n", + "description": "指定したSiteResourceNameのサイトを削除します。\n", "tags": [ "sites" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -6185,11 +7186,19 @@ } ], "get": { + "operationId": "getEndpointList", "summary": "エンドポイントの一覧取得", - "description": "エンドポイントの一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "エンドポイントの一覧を取得します。\n", "tags": [ "endpoints" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -6224,11 +7233,19 @@ } }, "post": { + "operationId": "postEndpoint", "summary": "エンドポイントの作成", - "description": "新しくエンドポイントを作成します。\\\n作成できる最大件数は50件です。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n\n### Authorizations\ndpf_write\n", + "description": "新しくエンドポイントを作成します。\\\n作成できる最大件数は50件です。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n", "tags": [ "endpoints" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -6290,11 +7307,19 @@ } ], "get": { + "operationId": "getEndpoint", "summary": "エンドポイントの取得", - "description": "指定したEndpointResourceNameのエンドポイントを取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したEndpointResourceNameのエンドポイントを取得します。\n", "tags": [ "endpoints" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -6329,11 +7354,19 @@ } }, "patch": { + "operationId": "patchEndpoint", "summary": "エンドポイントの更新", - "description": "指定したEndpointResourceNameのエンドポイントを更新します。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n\n### Authorizations\ndpf_write\n", + "description": "指定したEndpointResourceNameのエンドポイントを更新します。\\\nエラー発生時はErrorDetailsにtargetキーが付与され、問題の箇所が特定できます。\n", "tags": [ "endpoints" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -6382,11 +7415,19 @@ } }, "delete": { + "operationId": "deleteEndpoint", "summary": "エンドポイントの削除", - "description": "指定したEndpointResourceNameのエンドポイントを削除します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したEndpointResourceNameのエンドポイントを削除します。\n", "tags": [ "endpoints" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -6434,11 +7475,19 @@ } ], "post": { + "operationId": "postEndpointFailover", "summary": "エンドポイントの手動切り離し", - "description": "指定したEndpointResourceNameのエンドポイントの手動切り離しを実行します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したEndpointResourceNameのエンドポイントの手動切り離しを実行します。\n", "tags": [ "endpoints" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -6486,11 +7535,19 @@ } ], "post": { + "operationId": "postEndpointFailback", "summary": "エンドポイントの手動切り戻し", - "description": "指定したEndpointResourceNameのエンドポイントの手動切り戻しを実行します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したEndpointResourceNameのエンドポイントの手動切り戻しを実行します。\n", "tags": [ "endpoints" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -6546,11 +7603,19 @@ } ], "get": { + "operationId": "getRuleList", "summary": "ルールの一覧取得", - "description": "ルールの一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "ルールの一覧を取得します。\n", "tags": [ "rules" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -6585,11 +7650,19 @@ } }, "post": { + "operationId": "postRule", "summary": "ルールの作成", - "description": "新しくルールを作成します。\\\n作成できる最大件数は10件です。\n\n### Authorizations\ndpf_write\n", + "description": "新しくルールを作成します。\\\n作成できる最大件数は10件です。\n", "tags": [ "rules" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -6648,11 +7721,19 @@ } ], "get": { + "operationId": "getRule", "summary": "ルールの取得", - "description": "指定したRuleResourceNameのルールを取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したRuleResourceNameのルールを取得します。\n", "tags": [ "rules" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -6687,11 +7768,19 @@ } }, "patch": { + "operationId": "patchRule", "summary": "ルールの更新", - "description": "指定したRuleResourceNameのルールを更新します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したRuleResourceNameのルールを更新します。\n", "tags": [ "rules" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -6740,11 +7829,19 @@ } }, "delete": { + "operationId": "deleteRule", "summary": "ルールの削除", - "description": "指定したRuleResourceNameのルールを削除します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したRuleResourceNameのルールを削除します。\n", "tags": [ "rules" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -6789,11 +7886,19 @@ } ], "get": { + "operationId": "getRuleMethodList", "summary": "ルールメソッドの一覧取得", - "description": "ルールメソッドの一覧を取得します。\n\n### Authorizations\ndpf_read\n", + "description": "ルールメソッドの一覧を取得します。\n", "tags": [ "rule_methods" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -6828,11 +7933,19 @@ } }, "post": { + "operationId": "postRuleMethod", "summary": "ルールメソッドの作成", - "description": "新しくルールメソッドを作成します。\\\n作成できるメソッドは最大6階層です。\n\n### Authorizations\ndpf_write\n", + "description": "新しくルールメソッドを作成します。\\\n作成できるメソッドは最大6階層です。\n", "tags": [ "rule_methods" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -6894,11 +8007,19 @@ } ], "get": { + "operationId": "getRuleMethod", "summary": "ルールメソッドの取得", - "description": "指定したRuleMethodResourceNameのルールメソッドを取得します。\n\n### Authorizations\ndpf_read\n", + "description": "指定したRuleMethodResourceNameのルールメソッドを取得します。\n", "tags": [ "rule_methods" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -6933,11 +8054,19 @@ } }, "patch": { + "operationId": "patchRuleMethod", "summary": "ルールメソッドの更新", - "description": "指定したRuleMethodResourceNameのルールメソッドを更新します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したRuleMethodResourceNameのルールメソッドを更新します。\n", "tags": [ "rule_methods" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -6986,11 +8115,19 @@ } }, "delete": { + "operationId": "deleteRuleMethod", "summary": "ルールメソッドの削除", - "description": "指定したRuleMethodResourceNameのルールメソッドを削除します。\n\n### Authorizations\ndpf_write\n", + "description": "指定したRuleMethodResourceNameのルールメソッドを削除します。\n", "tags": [ "rule_methods" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "responses": { "202": { "description": "Accepted", @@ -7032,11 +8169,19 @@ } ], "get": { + "operationId": "getConfigList", "summary": "設定の一覧取得", - "description": "設定の一覧を取得します。\n### Authorizations\ndpf_read\n", + "description": "設定の一覧を取得します。\n", "tags": [ "config" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "responses": { "200": { "description": "OK", @@ -7071,11 +8216,19 @@ } }, "put": { + "operationId": "putConfig", "summary": "設定の一括更新", - "description": "設定を一括更新します。\\\nエラー発生時はErrorDetailsにJSONPath形式のtargetキーが付与され、問題の箇所が特定できます。\n\n### Authorizations\ndpf_write\n", + "description": "設定を一括更新します。\\\nエラー発生時はErrorDetailsにJSONPath形式のtargetキーが付与され、問題の箇所が特定できます。\n", "tags": [ "config" ], + "security": [ + { + "DPFOperator": [ + "dpf_write" + ] + } + ], "requestBody": { "content": { "application/json": { @@ -7131,11 +8284,19 @@ } ], "get": { + "operationId": "getLbDomainsLogList", "summary": "LBドメイン操作ログの一覧取得", - "description": "LBドメインを操作したログの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "LBドメインを操作したログの一覧を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "logs (lb_domains)" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -7224,11 +8385,19 @@ } ], "get": { + "operationId": "getLbDomainsLogListCount", "summary": "LBドメイン操作ログの件数取得", - "description": "LBドメインを操作したログの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n\n### Authorizations\ndpf_read\n", + "description": "LBドメインを操作したログの件数を取得します。\\\n\"_keywords\" から始まるパラメータは、合計で30個まで指定可能です。\n", "tags": [ "logs (lb_domains)" ], + "security": [ + { + "DPFViewer": [ + "dpf_read" + ] + } + ], "parameters": [ { "$ref": "#/components/parameters/Type" @@ -7303,6 +8472,23 @@ } }, "components": { + "securitySchemes": { + "DPFOperator": { + "description": "IIJ-IDで[設定]の更新権限を持ったユーザが発行したアクセストークン", + "type": "http", + "scheme": "bearer" + }, + "DPFViewer": { + "description": "IIJ-IDで[設定]の参照権限を持ったユーザが発行したアクセストークン", + "type": "http", + "scheme": "bearer" + }, + "ContractOperator": { + "description": "IIJ-IDで[運用]の更新権限を持ったユーザが発行したアクセストークン", + "type": "http", + "scheme": "bearer" + } + }, "parameters": { "RequestId": { "name": "RequestId", @@ -7720,40 +8906,82 @@ "$ref": "#/components/schemas/KeywordsLbDomainFavorite" } }, - "KeywordsLbDomainLabel": { + "KeywordsLabel": { "name": "_keywords_label[]", "in": "query", "schema": { - "$ref": "#/components/schemas/KeywordsLbDomainLabels" + "$ref": "#/components/schemas/KeywordsLabel" } }, "KeywordsLbDomainsLogsLogType": { "name": "_keywords_log_type[]", "in": "query", "schema": { - "$ref": "#/components/schemas/LbDomainsLogsType" + "$ref": "#/components/schemas/SearchLbDomainsLogsType" } }, "KeywordsLbDomainsLogsOperation": { "name": "_keywords_operation[]", "in": "query", "schema": { - "$ref": "#/components/schemas/LbDomainsLogsOperation" + "$ref": "#/components/schemas/SearchLbDomainsLogsOperation" } }, "KeywordsLbDomainsLogsStatus": { "name": "_keywords_status[]", "in": "query", "schema": { - "$ref": "#/components/schemas/LbDomainsLogsStatus" + "$ref": "#/components/schemas/SearchLbDomainsLogsStatus" } } }, - "schemas": { - "RequestId": { - "type": "string", - "minLength": 32, - "maxLength": 32 + "requestBodies": { + "PutContractLabels": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ContractLabels" + }, + "examples": { + "PutContractLabels": { + "$ref": "#/components/examples/PutContractLabels" + } + } + } + } + }, + "PutZoneLabels": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ZoneLabels" + }, + "examples": { + "PutZoneLabels": { + "$ref": "#/components/examples/PutZoneLabels" + } + } + } + } + } + }, + "schemas": { + "Response": { + "type": "object", + "required": [ + "request_id" + ], + "properties": { + "request_id": { + "$ref": "#/components/schemas/RequestId" + } + } + }, + "RequestId": { + "type": "string", + "minLength": 32, + "maxLength": 32, + "description": "処理の問い合わせの際のキーになる文字列" }, "SystemId": { "type": "string", @@ -7779,7 +9007,7 @@ "ResourceName": { "type": "string", "maxLength": 253, - "description": "登録可能な文字列は**[こちら](https://manual.iij.jp/dpf/help/19629152.html#DNS%E3%83%AC%E3%82%B3%E3%83%BC%E3%83%89%E3%81%AE%E7%99%BB%E9%8C%B2%E3%83%AB%E3%83%BC%E3%83%AB-%E3%83%9B%E3%82%B9%E3%83%88%E5%90%8D%E3%81%AE%E5%85%B1%E9%80%9A%E3%83%AB%E3%83%BC%E3%83%AB)**のホスト名の共通ルールを参照してください。" + "description": "登録可能な文字列は[**こちら**](https://manual.iij.jp/dpf/help/19629152.html#DNS%E3%83%AC%E3%82%B3%E3%83%BC%E3%83%89%E3%81%AE%E7%99%BB%E9%8C%B2%E3%83%AB%E3%83%BC%E3%83%AB-%E3%83%9B%E3%82%B9%E3%83%88%E5%90%8D%E3%81%AE%E5%85%B1%E9%80%9A%E3%83%AB%E3%83%BC%E3%83%AB)のホスト名の共通ルールを参照してください。" }, "LogDateTime": { "type": "string", @@ -7806,7 +9034,8 @@ "Operator": { "type": "string", "description": "編集者", - "default": null + "default": null, + "nullable": true }, "JobsUrl": { "type": "string" @@ -7964,7 +9193,7 @@ "SearchDate": { "type": "string", "format": "full-date", - "default": null + "default": "" }, "SearchTimeZone": { "type": "string", @@ -7985,7 +9214,7 @@ "default": [], "items": { "type": "string", - "maxLength": 255 + "maxLength": 381 } }, "KeywordsId": { @@ -8018,7 +9247,7 @@ }, "CcPrimaryEnabled": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/cc_primaries)**", + "description": "詳細説明は[**こちら**](#tag/cc_primaries)", "enum": [ 0, 1 @@ -8040,7 +9269,7 @@ "$ref": "#/components/schemas/CcPrimaryAddress" }, "tsig_id": { - "$ref": "#/components/schemas/Id" + "$ref": "#/components/schemas/TsigId" }, "enabled": { "$ref": "#/components/schemas/CcPrimaryEnabled" @@ -8129,7 +9358,7 @@ "$ref": "#/components/schemas/CcNotifiedServerAddress" }, "tsig_id": { - "$ref": "#/components/schemas/Id" + "$ref": "#/components/schemas/TsigId" } } }, @@ -8212,7 +9441,7 @@ "$ref": "#/components/schemas/CcSecTransferNetwork" }, "tsig_id": { - "$ref": "#/components/schemas/Id" + "$ref": "#/components/schemas/TsigId" } } }, @@ -8300,24 +9529,52 @@ "description": "メールアドレス" }, "phone": { - "type": "object", - "properties": { - "country_code": { - "type": "string", - "description": "国番号（number指定時必須）", - "enum": [ - "", - "1", - "81" - ] + "oneOf": [ + { + "$ref": "#/components/schemas/CcNoticeAccountPhone" }, - "number": { - "minLength": "0,8", - "maxLength": 13, - "type": "string", - "description": "ハイフンを除いた電話番号（country_code指定時必須）" + { + "$ref": "#/components/schemas/CcNoticeAccountEmptyPhone" } - } + ] + } + } + }, + "CcNoticeAccountPhone": { + "type": "object", + "properties": { + "country_code": { + "type": "string", + "description": "国番号（number指定時必須）", + "enum": [ + "1", + "81" + ] + }, + "number": { + "minLength": 8, + "maxLength": 13, + "type": "string", + "description": "ハイフンを除いた電話番号（country_code指定時必須）" + } + } + }, + "CcNoticeAccountEmptyPhone": { + "type": "object", + "properties": { + "country_code": { + "type": "string", + "description": "国番号（電話番号空の場合)", + "enum": [ + "" + ] + }, + "number": { + "type": "string", + "description": "電話番号（電話番号空の場合)", + "enum": [ + "" + ] } } }, @@ -8353,28 +9610,54 @@ "description": "メールアドレス" }, "phone": { - "type": "object", - "required": [ - "country_code", - "number" - ], - "properties": { - "country_code": { - "type": "string", - "description": "国番号（number指定時必須）", - "enum": [ - "", - "1", - "81" - ] + "oneOf": [ + { + "type": "object", + "required": [ + "country_code", + "number" + ], + "properties": { + "country_code": { + "type": "string", + "description": "国番号（電話番号空の場合)", + "enum": [ + "" + ] + }, + "number": { + "type": "string", + "description": "電話番号（電話番号空の場合)", + "enum": [ + "" + ] + } + } }, - "number": { - "minLength": "0,8", - "maxLength": 13, - "type": "string", - "description": "ハイフンを除いた電話番号（country_code指定時必須）" + { + "type": "object", + "required": [ + "country_code", + "number" + ], + "properties": { + "country_code": { + "type": "string", + "description": "国番号（number指定時必須）", + "enum": [ + "1", + "81" + ] + }, + "number": { + "minLength": 8, + "maxLength": 13, + "type": "string", + "description": "ハイフンを除いた電話番号（country_code指定時必須）" + } + } } - } + ] } } } @@ -8452,7 +9735,7 @@ }, "ManagedDnsEnabled": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/common_configs)**", + "description": "詳細説明は[**こちら**](#tag/common_configs)", "enum": [ 0, 1 @@ -8460,7 +9743,7 @@ }, "CommonConfigDefault": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/common_configs)**", + "description": "詳細説明は[**こちら**](#tag/common_configs)", "enum": [ 0, 1 @@ -8648,9 +9931,30 @@ } } }, + "ContractLabels": { + "type": "object", + "required": [ + "labels" + ], + "properties": { + "labels": { + "default": {}, + "type": "object", + "description": "ラベル", + "minProperties": 0, + "maxProperties": 10, + "additionalProperties": { + "type": "string", + "maxLength": 63, + "minLength": 1, + "description": "Objectは最大で10個\\\n登録可能な文字列は[**こちら**](https://manual.iij.jp/dpf/help/50639516.html)のラベルの共通ルールを参照してください。\n" + } + } + } + }, "ContractState": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/contracts)**", + "description": "詳細説明は[**こちら**](#tag/contracts)", "enum": [ 1, 2 @@ -8658,7 +9962,7 @@ }, "ContractFavorite": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/contracts)**", + "description": "詳細説明は[**こちら**](#tag/contracts)", "enum": [ 1, 2 @@ -8666,7 +9970,7 @@ }, "ContractPlan": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/contracts)**", + "description": "詳細説明は[**こちら**](#tag/contracts)", "enum": [ 1, 2 @@ -8751,7 +10055,7 @@ }, "ContractsLogsOperation": { "type": "string", - "description": "詳細説明は**[こちら](#tag/logs-(contracts))**", + "description": "詳細説明は[**こちら**](#tag/logs-(contracts))", "enum": [ "add_cc_primary", "update_cc_primary", @@ -8775,6 +10079,7 @@ "update_managed_dns_state", "update_contract_description", "update_contract_favorite", + "update_contract_labels", "apply_common_config", "create_contract_partnership", "delete_contract_partnership", @@ -8785,7 +10090,7 @@ }, "ContractsLogsStatus": { "type": "string", - "description": "詳細説明は**[こちら](#tag/logs-(contracts))**", + "description": "詳細説明は[**こちら**](#tag/logs-(contracts))", "enum": [ "start", "success", @@ -8795,7 +10100,7 @@ }, "ContractsLogsLogType": { "type": "string", - "description": "詳細説明は**[こちら](#tag/logs-(contracts))**", + "description": "詳細説明は[**こちら**](#tag/logs-(contracts))", "enum": [ "service", "common_config", @@ -8865,7 +10170,7 @@ }, "DefaultTtlState": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/default_ttl)**", + "description": "詳細説明は[**こちら**](#tag/default_ttl)", "enum": [ 0, 3, @@ -8979,7 +10284,6 @@ "type": "array", "minItems": 12, "maxItems": 12, - "default": [], "items": { "$ref": "#/components/schemas/QpsValue" } @@ -9032,7 +10336,7 @@ }, "TsigsAlgorithm": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/tsigs)**", + "description": "詳細説明は[**こちら**](#tag/tsigs)", "enum": [ 0 ] @@ -9131,7 +10435,7 @@ "type": "object", "required": [ "request_id", - "result" + "results" ], "properties": { "request_id": { @@ -9149,7 +10453,7 @@ }, "DnssecEnabled": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/dnssec)**", + "description": "詳細説明は[**こちら**](#tag/dnssec)", "enum": [ 0, 1 @@ -9157,7 +10461,7 @@ }, "DnssecState": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/dnssec)**", + "description": "詳細説明は[**こちら**](#tag/dnssec)", "enum": [ 0, 1, @@ -9168,11 +10472,10 @@ }, "DnssecDsState": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/dnssec)**", + "description": "詳細説明は[**こちら**](#tag/dnssec)", "enum": [ 0, 1, - 2, 3, 4, 5, @@ -9269,7 +10572,7 @@ }, "ZonesLogsType": { "type": "string", - "description": "詳細説明は**[こちら](#tag/logs-(zones))**", + "description": "詳細説明は[**こちら**](#tag/logs-(zones))", "enum": [ "service", "record", @@ -9278,7 +10581,7 @@ }, "ZonesLogsOperation": { "type": "string", - "description": "詳細説明は**[こちら](#tag/logs-(zones))**", + "description": "詳細説明は[**こちら**](#tag/logs-(zones))", "enum": [ "updating_default_ttl", "dismiss_default_ttl_change", @@ -9291,15 +10594,18 @@ "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" ] }, "ZonesLogsStatus": { "type": "string", - "description": "詳細説明は**[こちら](#tag/logs-(zones))**", + "description": "詳細説明は[**こちら**](#tag/logs-(zones))", "enum": [ "start", "success", @@ -9398,6 +10704,13 @@ "TXT" ] }, + "DsRecordsRrtype": { + "type": "string", + "description": "レコードタイプ", + "enum": [ + "DS" + ] + }, "RecordsRdata": { "type": "array", "description": "レコードの値", @@ -9413,7 +10726,7 @@ }, "RecordsState": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/records)**", + "description": "詳細説明は[**こちら**](#tag/records)", "enum": [ 0, 1, @@ -9430,6 +10743,7 @@ "ttl", "rrtype", "rdata", + "labels", "state", "description", "operator" @@ -9450,6 +10764,9 @@ "rdata": { "$ref": "#/components/schemas/RecordsRdata" }, + "labels": { + "$ref": "#/components/schemas/RecordLabels" + }, "state": { "$ref": "#/components/schemas/RecordsState" }, @@ -9461,6 +10778,19 @@ } } }, + "RecordLabels": { + "default": {}, + "type": "object", + "description": "ラベル", + "minProperties": 0, + "maxProperties": 10, + "additionalProperties": { + "type": "string", + "maxLength": 63, + "minLength": 1, + "description": "Objectは最大で10個\\\n登録可能な文字列は[**こちら**](https://manual.iij.jp/dpf/help/50639516.html)のラベルの共通ルールを参照してください。\n" + } + }, "GetRecords": { "type": "object", "required": [ @@ -9481,6 +10811,66 @@ } } }, + "PutRecord": { + "type": "object", + "required": [ + "records" + ], + "properties": { + "records": { + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "required": [ + "name", + "ttl", + "rrtype", + "rdata", + "labels", + "description" + ], + "properties": { + "name": { + "$ref": "#/components/schemas/RecordsName" + }, + "ttl": { + "$ref": "#/components/schemas/RecordsTtl" + }, + "rrtype": { + "type": "string", + "description": "レコードタイプ", + "enum": [ + "A", + "AAAA", + "CAA", + "CNAME", + "DS", + "NS", + "MX", + "NAPTR", + "SOA", + "SRV", + "TXT", + "TLSA", + "ANAME", + "PTR" + ] + }, + "rdata": { + "$ref": "#/components/schemas/RecordsRdata" + }, + "description": { + "$ref": "#/components/schemas/Description" + }, + "labels": { + "$ref": "#/components/schemas/RecordLabels" + } + } + } + } + } + }, "PostRecord": { "type": "object", "required": [ @@ -9519,6 +10909,9 @@ }, "description": { "$ref": "#/components/schemas/Description" + }, + "labels": { + "$ref": "#/components/schemas/RecordLabels" } } }, @@ -9578,6 +10971,9 @@ "rdata": { "$ref": "#/components/schemas/RecordsRdata" }, + "labels": { + "$ref": "#/components/schemas/RecordLabels" + }, "description": { "$ref": "#/components/schemas/Description" } @@ -9636,7 +11032,7 @@ "$ref": "#/components/schemas/Operator" }, "text": { - "$ref": "#/components/schemas/ZoneHistoriesCommittedAt" + "$ref": "#/components/schemas/ZoneHistoriesText" } } }, @@ -9675,15 +11071,15 @@ }, "ZoneProxyStatus": { "type": "string", - "description": "詳細説明は**[こちら](#tag/zone_proxy)**", + "description": "詳細説明は[**こちら**](#tag/zone_proxy)", "enum": [ - "success", - "fail" + "OK", + "NG" ] }, "ZoneProxyEnabled": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/zone_proxy)**", + "description": "詳細説明は[**こちら**](#tag/zone_proxy)", "enum": [ 0, 1 @@ -9777,7 +11173,7 @@ }, "ZonesFavorite": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/zones)**", + "description": "詳細説明は[**こちら**](#tag/zones)", "enum": [ 1, 2 @@ -9785,20 +11181,12 @@ }, "ZonesState": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/zones)**", + "description": "詳細説明は[**こちら**](#tag/zones)", "enum": [ 1, 2 ] }, - "ZonesEnabled": { - "type": "integer", - "description": "詳細説明は**[こちら](#tag/zones)**", - "enum": [ - 0, - 1 - ] - }, "Zone": { "type": "object", "required": [ @@ -9809,8 +11197,7 @@ "favorite", "name", "network", - "description", - "zone_proxy_enabled" + "description" ], "properties": { "id": { @@ -9836,9 +11223,6 @@ }, "description": { "$ref": "#/components/schemas/Description" - }, - "zone_proxy_enabled": { - "$ref": "#/components/schemas/ZonesEnabled" } } }, @@ -9913,17 +11297,30 @@ } } }, - "DelegationsFavorite": { - "type": "integer", - "description": "詳細説明は**[こちら](#tag/delegations)**", - "enum": [ - 1, - 2 - ] + "ZoneLabels": { + "type": "object", + "required": [ + "labels" + ], + "properties": { + "labels": { + "default": {}, + "type": "object", + "description": "ラベル", + "minProperties": 0, + "maxProperties": 10, + "additionalProperties": { + "type": "string", + "maxLength": 63, + "minLength": 1, + "description": "Objectは最大で10個\\\n登録可能な文字列は[**こちら**](https://manual.iij.jp/dpf/help/50639516.html)のラベルの共通ルールを参照してください。\n" + } + } + } }, "DelegationsRequested": { "type": "integer", - "description": "詳細説明は**[こちら](#tag/delegations)**", + "description": "詳細説明は[**こちら**](#tag/delegations)", "enum": [ 0, 1 @@ -10009,7 +11406,7 @@ }, "status": { "type": "string", - "description": "詳細説明は**[こちら](#tag/jobs)**", + "description": "詳細説明は[**こちら**](#tag/jobs)", "enum": [ "RUNNING", "SUCCESSFUL", @@ -10053,13 +11450,13 @@ 1, 2 ], - "description": "詳細説明は**[こちら](#tag/lb_domains)**" + "description": "詳細説明は[**こちら**](#tag/lb_domains)" }, "KeywordsLbDomainState": { "type": "array", "minItems": 0, "default": [], - "description": "詳細説明は**[こちら](#tag/lb_domains)**", + "description": "詳細説明は[**こちら**](#tag/lb_domains)", "items": { "type": "integer", "enum": [ @@ -10072,7 +11469,7 @@ "type": "array", "minItems": 0, "default": [], - "description": "詳細説明は**[こちら](#tag/lb_domains)**", + "description": "詳細説明は[**こちら**](#tag/lb_domains)", "items": { "type": "integer", "enum": [ @@ -10087,7 +11484,7 @@ 1, 2 ], - "description": "詳細説明は**[こちら](#tag/lb_domains)**" + "description": "詳細説明は[**こちら**](#tag/lb_domains)" }, "LbDomainLabels": { "type": "object", @@ -10103,18 +11500,18 @@ "type": "string", "maxLength": 63, "minLength": 1, - "description": "Objectは最大で10個\\\n詳細説明は**[こちら](#tag/lb_domains)**\n" + "description": "Objectは最大で10個\\\n登録可能な文字列は[**こちら**](https://manual.iij.jp/dpf/help/50639516.html)のラベルの共通ルールを参照してください。\n" } } } }, - "KeywordsLbDomainLabels": { + "KeywordsLabel": { "type": "array", "minItems": 0, "default": [], "items": { "type": "string", - "maxLength": 255 + "maxLength": 381 }, "description": "Valueは「labelのKey=labelのValue」のようにイコール区切りで指定" }, @@ -10230,132 +11627,266 @@ }, "MonitoringMtype": { "type": "string", + "description": "監視種別", "enum": [ "ping", "tcp", "http", "static" + ] + }, + "MonitoringPropsLocation": { + "type": "string", + "description": "監視元ロケーション", + "enum": [ + "jp", + "us", + "all" ], - "description": "監視種別" + "default": "all" + }, + "MonitoringPropsInterval": { + "type": "integer", + "description": "監視間隔（s）", + "minimum": 30, + "maximum": 600, + "default": 30 + }, + "MonitoringPropsHoldtime": { + "type": "integer", + "description": "保留時間（s）", + "minimum": 0, + "maximum": 3600, + "default": 0 + }, + "MonitoringPropsTimeout": { + "type": "integer", + "description": "タイムアウト（s）", + "minimum": 1, + "maximum": 30, + "default": 5 + }, + "MonitoringPropsTCPPort": { + "type": "integer", + "description": "ポート番号", + "minimum": 0, + "maximum": 65535 + }, + "MonitoringPropsHTTPPort": { + "type": "integer", + "description": "ポート番号,POST時に未指定の場合はHTTPの場合は80,HTTPSの場合は443", + "minimum": 0, + "maximum": 65535 + }, + "MonitoringPropsTLSEnabled": { + "type": "boolean", + "description": "TLS監視利用フラグ", + "default": false + }, + "MonitoringPropsTLSSNI": { + "type": "string", + "description": "TLS SNI値、未指定の場合、監視時にSNIとして、Hostヘッダーを利用", + "maxLength": 253 + }, + "MonitoringPropsResponseMatch": { + "type": "string", + "description": "レスポンスボディマッチ文字列", + "default": "", + "maxLength": 256 + }, + "MonitoringPropsHTTPS": { + "type": "boolean", + "description": "HTTPS利用フラグ", + "default": false + }, + "MonitoringPropsHeaders": { + "type": "array", + "description": "Hostヘッダー", + "minItems": 0, + "maxItems": 1, + "items": { + "$ref": "#/components/schemas/MonitoringPropsHeader" + } }, - "MonitoringProps": { + "MonitoringPropsHeader": { "type": "object", + "description": "ヘッダーの中身", + "required": [ + "field_name", + "field_value" + ], "properties": { - "location": { + "field_name": { "type": "string", "enum": [ - "jp", - "us", - "all" - ], - "default": "all", - "description": "監視元ロケーション（指定可能な監視種別はping,tcp,http）" - }, - "interval": { - "type": "integer", - "minimum": 30, - "maximum": 600, - "default": 30, - "description": "監視間隔（s）（指定可能な監視種別はping,tcp,http）" - }, - "holdtime": { - "type": "integer", - "minimum": 0, - "maximum": 3600, - "default": 0, - "description": "保留時間（s）（指定可能な監視種別はping,tcp,http）" - }, - "timeout": { - "type": "integer", - "minimum": 1, - "maximum": 30, - "default": 5, - "description": "タイムアウト（s）（指定可能な監視種別はping,tcp,http）" - }, - "port": { - "type": "integer", - "minimum": 0, - "maximum": 65535, - "description": "ポート番号（監視種別がhttpかつ、httpsがtrueの場合は未指定時443。それ以外の場合は未指定時80。指定可能な監視種別はtcp,http）" - }, - "tls_enabled": { - "type": "boolean", - "default": false, - "description": "TLS監視（指定可能な監視種別はtcp）" + "Host" + ] }, - "tls_sni": { + "field_value": { "type": "string", - "default": "", - "maxLength": 253, - "description": "TLS SNI（指定可能な監視種別はtcp,http）" + "description": "Hostヘッダー", + "maxLength": 8192 + } + } + }, + "MonitoringPropsPath": { + "type": "string", + "description": "URLのPATH部(先頭の/が補完されて利用される)", + "maxLength": 2048 + }, + "MonitoringPropsStatusCodes": { + "type": "array", + "description": "マッチするステータスコードの配列", + "minItems": 0, + "maxItems": 10, + "default": [], + "items": { + "$ref": "#/components/schemas/MonitoringPropsStatusCode" + } + }, + "MonitoringPropsStatusCode": { + "type": "string", + "description": "ステータスコード（0-9の3桁の文字列のみ指定可能）" + }, + "MonitoringPropsResult": { + "type": "string", + "description": "監視種別staticの監視結果の固定値", + "enum": [ + "up", + "down", + "unknown" + ], + "default": "up" + }, + "Monitoring": { + "anyOf": [ + { + "$ref": "#/components/schemas/MonitoringPing" }, - "response_match": { - "type": "string", - "default": "", - "maxLength": 256, - "description": "レスポンスボディマッチ文字列（指定可能な監視種別はhttp）" + { + "$ref": "#/components/schemas/MonitoringTCP" }, - "https": { - "type": "boolean", - "default": false, - "description": "HTTPS利用（指定可能な監視種別はhttp）" + { + "$ref": "#/components/schemas/MonitoringHTTP" }, - "headers": { - "type": "array", - "description": "Hostヘッダー（指定可能な監視種別はhttp）", - "minItems": 0, - "maxItems": 1, - "default": [], - "items": { - "type": "object", - "required": [ - "field_name", - "field_value" - ], - "properties": { - "field_name": { - "type": "string", - "enum": [ - "Host" - ] - }, - "field_value": { - "type": "string", - "description": "Hostヘッダー", - "maxLength": 8192 - } - } - } + { + "$ref": "#/components/schemas/MonitoringStatic" + } + ] + }, + "MonitoringPing": { + "type": "object", + "required": [ + "resource_name", + "name", + "mtype", + "description", + "props" + ], + "properties": { + "resource_name": { + "$ref": "#/components/schemas/ResourceName" + }, + "name": { + "$ref": "#/components/schemas/MonitoringName" }, - "path": { + "mtype": { "type": "string", - "default": "", - "maxLength": 2048, - "description": "パス（先頭に「/」は不要。指定可能な監視種別はhttp）" + "enum": [ + "ping" + ] }, - "status_codes": { - "type": "array", - "minItems": 0, - "maxItems": 10, - "default": [], - "description": "ステータスコード（0-9の3桁の文字列のみ指定可能。指定可能な監視種別はhttp）", - "items": { - "type": "string" + "description": { + "$ref": "#/components/schemas/Description" + }, + "props": { + "type": "object", + "required": [ + "location", + "interval", + "holdtime", + "timeout" + ], + "properties": { + "location": { + "$ref": "#/components/schemas/MonitoringPropsLocation" + }, + "interval": { + "$ref": "#/components/schemas/MonitoringPropsInterval" + }, + "holdtime": { + "$ref": "#/components/schemas/MonitoringPropsHoldtime" + }, + "timeout": { + "$ref": "#/components/schemas/MonitoringPropsTimeout" + } } + } + } + }, + "MonitoringTCP": { + "type": "object", + "required": [ + "resource_name", + "name", + "mtype", + "description", + "props" + ], + "properties": { + "resource_name": { + "$ref": "#/components/schemas/ResourceName" }, - "result": { + "name": { + "$ref": "#/components/schemas/MonitoringName" + }, + "mtype": { "type": "string", "enum": [ - "up", - "down", - "unknown" + "tcp" + ] + }, + "description": { + "$ref": "#/components/schemas/Description" + }, + "props": { + "type": "object", + "required": [ + "location", + "interval", + "holdtime", + "timeout", + "port", + "tls_enabled", + "tls_sni" ], - "default": "up", - "description": "固定値（指定可能な監視種別はstatic）" + "properties": { + "location": { + "$ref": "#/components/schemas/MonitoringPropsLocation" + }, + "interval": { + "$ref": "#/components/schemas/MonitoringPropsInterval" + }, + "holdtime": { + "$ref": "#/components/schemas/MonitoringPropsHoldtime" + }, + "timeout": { + "$ref": "#/components/schemas/MonitoringPropsTimeout" + }, + "port": { + "$ref": "#/components/schemas/MonitoringPropsTCPPort" + }, + "tls_enabled": { + "$ref": "#/components/schemas/MonitoringPropsTLSEnabled" + }, + "tls_sni": { + "$ref": "#/components/schemas/MonitoringPropsTLSSNI" + } + } } } }, - "Monitoring": { + "MonitoringHTTP": { "type": "object", "required": [ "resource_name", @@ -10372,28 +11903,129 @@ "$ref": "#/components/schemas/MonitoringName" }, "mtype": { - "$ref": "#/components/schemas/MonitoringMtype" + "type": "string", + "enum": [ + "http" + ] }, "description": { "$ref": "#/components/schemas/Description" }, "props": { - "$ref": "#/components/schemas/MonitoringProps" + "type": "object", + "required": [ + "location", + "interval", + "holdtime", + "timeout", + "port", + "https", + "tls_sni", + "response_match", + "headers", + "path", + "status_codes" + ], + "properties": { + "location": { + "$ref": "#/components/schemas/MonitoringPropsLocation" + }, + "interval": { + "$ref": "#/components/schemas/MonitoringPropsInterval" + }, + "holdtime": { + "$ref": "#/components/schemas/MonitoringPropsHoldtime" + }, + "timeout": { + "$ref": "#/components/schemas/MonitoringPropsTimeout" + }, + "port": { + "$ref": "#/components/schemas/MonitoringPropsHTTPPort" + }, + "https": { + "$ref": "#/components/schemas/MonitoringPropsHTTPS" + }, + "tls_sni": { + "$ref": "#/components/schemas/MonitoringPropsTLSSNI" + }, + "response_match": { + "$ref": "#/components/schemas/MonitoringPropsResponseMatch" + }, + "headers": { + "$ref": "#/components/schemas/MonitoringPropsHeaders" + }, + "path": { + "$ref": "#/components/schemas/MonitoringPropsPath" + }, + "status_codes": { + "$ref": "#/components/schemas/MonitoringPropsStatusCodes" + } + } } } }, - "Monitorings": { + "MonitoringStatic": { "type": "object", + "required": [ + "resource_name", + "name", + "mtype", + "description", + "props" + ], "properties": { - "monitorings": { - "type": "array", - "default": [], - "items": { - "$ref": "#/components/schemas/Monitoring" + "resource_name": { + "$ref": "#/components/schemas/ResourceName" + }, + "name": { + "$ref": "#/components/schemas/MonitoringName" + }, + "mtype": { + "type": "string", + "enum": [ + "static" + ] + }, + "description": { + "$ref": "#/components/schemas/Description" + }, + "props": { + "type": "object", + "required": [ + "result" + ], + "properties": { + "result": { + "$ref": "#/components/schemas/MonitoringPropsResult" + } } } } }, + "GetMonitoring": { + "required": [ + "request_id", + "result" + ], + "properties": { + "request_id": { + "$ref": "#/components/schemas/RequestId" + }, + "result": { + "required": [ + "sites" + ], + "allOf": [ + { + "$ref": "#/components/schemas/Monitoring" + }, + { + "$ref": "#/components/schemas/Sites" + } + ] + } + } + }, "GetMonitorings": { "type": "object", "required": [ @@ -10424,7 +12056,172 @@ } } }, + "PatchMonitoring": { + "anyOf": [ + { + "$ref": "#/components/schemas/PatchMonitoringPing" + }, + { + "$ref": "#/components/schemas/PatchMonitoringTCP" + }, + { + "$ref": "#/components/schemas/PatchMonitoringHTTP" + }, + { + "$ref": "#/components/schemas/PatchMonitoringStatic" + } + ] + }, + "PatchMonitoringPing": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/MonitoringName" + }, + "description": { + "$ref": "#/components/schemas/Description" + }, + "props": { + "type": "object", + "properties": { + "location": { + "$ref": "#/components/schemas/MonitoringPropsLocation" + }, + "interval": { + "$ref": "#/components/schemas/MonitoringPropsInterval" + }, + "holdtime": { + "$ref": "#/components/schemas/MonitoringPropsHoldtime" + }, + "timeout": { + "$ref": "#/components/schemas/MonitoringPropsTimeout" + } + } + } + } + }, + "PatchMonitoringTCP": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/MonitoringName" + }, + "description": { + "$ref": "#/components/schemas/Description" + }, + "props": { + "type": "object", + "properties": { + "location": { + "$ref": "#/components/schemas/MonitoringPropsLocation" + }, + "interval": { + "$ref": "#/components/schemas/MonitoringPropsInterval" + }, + "holdtime": { + "$ref": "#/components/schemas/MonitoringPropsHoldtime" + }, + "timeout": { + "$ref": "#/components/schemas/MonitoringPropsTimeout" + }, + "port": { + "$ref": "#/components/schemas/MonitoringPropsTCPPort" + }, + "tls_enabled": { + "$ref": "#/components/schemas/MonitoringPropsTLSEnabled" + }, + "tls_sni": { + "$ref": "#/components/schemas/MonitoringPropsTLSSNI" + } + } + } + } + }, + "PatchMonitoringHTTP": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/MonitoringName" + }, + "description": { + "$ref": "#/components/schemas/Description" + }, + "props": { + "type": "object", + "properties": { + "location": { + "$ref": "#/components/schemas/MonitoringPropsLocation" + }, + "interval": { + "$ref": "#/components/schemas/MonitoringPropsInterval" + }, + "holdtime": { + "$ref": "#/components/schemas/MonitoringPropsHoldtime" + }, + "timeout": { + "$ref": "#/components/schemas/MonitoringPropsTimeout" + }, + "port": { + "$ref": "#/components/schemas/MonitoringPropsHTTPPort" + }, + "https": { + "$ref": "#/components/schemas/MonitoringPropsHTTPS" + }, + "tls_sni": { + "$ref": "#/components/schemas/MonitoringPropsTLSSNI" + }, + "response_match": { + "$ref": "#/components/schemas/MonitoringPropsResponseMatch" + }, + "headers": { + "$ref": "#/components/schemas/MonitoringPropsHeaders" + }, + "path": { + "$ref": "#/components/schemas/MonitoringPropsPath" + }, + "status_codes": { + "$ref": "#/components/schemas/MonitoringPropsStatusCodes" + } + } + } + } + }, + "PatchMonitoringStatic": { + "type": "object", + "properties": { + "name": { + "$ref": "#/components/schemas/MonitoringName" + }, + "description": { + "$ref": "#/components/schemas/Description" + }, + "props": { + "type": "object", + "properties": { + "result": { + "$ref": "#/components/schemas/MonitoringPropsResult" + } + } + } + } + }, "PostMonitoring": { + "anyOf": [ + { + "$ref": "#/components/schemas/PostMonitoringPing" + }, + { + "$ref": "#/components/schemas/PostMonitoringTCP" + }, + { + "$ref": "#/components/schemas/PostMonitoringHTTP" + }, + { + "$ref": "#/components/schemas/PostMonitoringStatic" + } + ] + }, + "PostMonitoringPing": { "type": "object", "required": [ "name", @@ -10438,46 +12235,102 @@ "$ref": "#/components/schemas/MonitoringName" }, "mtype": { - "$ref": "#/components/schemas/MonitoringMtype" + "type": "string", + "enum": [ + "ping" + ] }, "description": { "$ref": "#/components/schemas/Description" }, "props": { - "$ref": "#/components/schemas/MonitoringProps" + "type": "object", + "properties": { + "location": { + "$ref": "#/components/schemas/MonitoringPropsLocation" + }, + "interval": { + "$ref": "#/components/schemas/MonitoringPropsInterval" + }, + "holdtime": { + "$ref": "#/components/schemas/MonitoringPropsHoldtime" + }, + "timeout": { + "$ref": "#/components/schemas/MonitoringPropsTimeout" + } + } } } }, - "GetMonitoring": { + "PostMonitoringTCP": { + "type": "object", "required": [ - "request_id", - "result" + "name", + "mtype" ], "properties": { - "request_id": { - "$ref": "#/components/schemas/RequestId" + "resource_name": { + "$ref": "#/components/schemas/ResourceName" }, - "result": { - "required": [ - "sites" - ], - "allOf": [ - { - "$ref": "#/components/schemas/Monitoring" + "name": { + "$ref": "#/components/schemas/MonitoringName" + }, + "mtype": { + "type": "string", + "enum": [ + "tcp" + ] + }, + "description": { + "$ref": "#/components/schemas/Description" + }, + "props": { + "type": "object", + "properties": { + "location": { + "$ref": "#/components/schemas/MonitoringPropsLocation" }, - { - "$ref": "#/components/schemas/Sites" + "interval": { + "$ref": "#/components/schemas/MonitoringPropsInterval" + }, + "holdtime": { + "$ref": "#/components/schemas/MonitoringPropsHoldtime" + }, + "timeout": { + "$ref": "#/components/schemas/MonitoringPropsTimeout" + }, + "port": { + "$ref": "#/components/schemas/MonitoringPropsTCPPort" + }, + "tls_enabled": { + "$ref": "#/components/schemas/MonitoringPropsTLSEnabled" + }, + "tls_sni": { + "$ref": "#/components/schemas/MonitoringPropsTLSSNI" } - ] + } } } }, - "PatchMonitoring": { + "PostMonitoringHTTP": { "type": "object", + "required": [ + "name", + "mtype" + ], "properties": { + "resource_name": { + "$ref": "#/components/schemas/ResourceName" + }, "name": { "$ref": "#/components/schemas/MonitoringName" }, + "mtype": { + "type": "string", + "enum": [ + "http" + ] + }, "description": { "$ref": "#/components/schemas/Description" }, @@ -10485,104 +12338,69 @@ "type": "object", "properties": { "location": { - "type": "string", - "enum": [ - "jp", - "us", - "all" - ], - "description": "監視元ロケーション（指定可能な監視種別はping,tcp,http）" + "$ref": "#/components/schemas/MonitoringPropsLocation" }, "interval": { - "type": "integer", - "minimum": 30, - "maximum": 600, - "description": "監視間隔（s）（指定可能な監視種別はping,tcp,http）" + "$ref": "#/components/schemas/MonitoringPropsInterval" }, "holdtime": { - "type": "integer", - "minimum": 0, - "maximum": 3600, - "description": "保留時間（s）（指定可能な監視種別はping,tcp,http）" + "$ref": "#/components/schemas/MonitoringPropsHoldtime" }, "timeout": { - "type": "integer", - "minimum": 1, - "maximum": 30, - "description": "タイムアウト（s）（指定可能な監視種別はping,tcp,http）" + "$ref": "#/components/schemas/MonitoringPropsTimeout" }, "port": { - "type": "integer", - "minimum": 0, - "maximum": 65535, - "description": "ポート番号（指定可能な監視種別はtcp,http）" + "$ref": "#/components/schemas/MonitoringPropsHTTPPort" }, - "tls_enabled": { - "type": "boolean", - "description": "TLS監視（指定可能な監視種別はtcp）" + "https": { + "$ref": "#/components/schemas/MonitoringPropsHTTPS" }, "tls_sni": { - "type": "string", - "maxLength": 253, - "description": "TLS SNI（指定可能な監視種別はtcp,http）" + "$ref": "#/components/schemas/MonitoringPropsTLSSNI" }, "response_match": { - "type": "string", - "maxLength": 256, - "description": "レスポンスボディマッチ文字列（指定可能な監視種別はhttp）" - }, - "https": { - "type": "boolean", - "description": "HTTPS利用（指定可能な監視種別はhttp）" + "$ref": "#/components/schemas/MonitoringPropsResponseMatch" }, "headers": { - "type": "array", - "description": "Hostヘッダー（指定可能な監視種別はhttp）", - "minItems": 0, - "maxItems": 1, - "items": { - "type": "object", - "required": [ - "field_name", - "field_value" - ], - "properties": { - "field_name": { - "type": "string", - "enum": [ - "Host" - ] - }, - "field_value": { - "type": "string", - "description": "Hostヘッダー", - "maxLength": 8192 - } - } - } + "$ref": "#/components/schemas/MonitoringPropsHeaders" }, "path": { - "type": "string", - "maxLength": 2048, - "description": "パス（先頭に「/」は不要。指定可能な監視種別はhttp）" + "$ref": "#/components/schemas/MonitoringPropsPath" }, "status_codes": { - "type": "array", - "minItems": 0, - "maxItems": 10, - "description": "ステータスコード（0-9の3桁の文字列のみ指定可能。指定可能な監視種別はhttp）", - "items": { - "type": "string" - } - }, + "$ref": "#/components/schemas/MonitoringPropsStatusCodes" + } + } + } + } + }, + "PostMonitoringStatic": { + "type": "object", + "required": [ + "name", + "mtype" + ], + "properties": { + "resource_name": { + "$ref": "#/components/schemas/ResourceName" + }, + "name": { + "$ref": "#/components/schemas/MonitoringName" + }, + "mtype": { + "type": "string", + "enum": [ + "static" + ] + }, + "description": { + "$ref": "#/components/schemas/Description" + }, + "props": { + "type": "object", + "properties": { "result": { - "type": "string", - "enum": [ - "up", - "down", - "unknown" - ], - "description": "固定値（指定可能な監視種別はstatic）" + "$ref": "#/components/schemas/MonitoringPropsResult" } } } @@ -11232,12 +13050,6 @@ } } }, - "RuleMethodName": { - "type": "string", - "description": "ルールメソッド名", - "minLength": 1, - "maxLength": 80 - }, "RuleMethodPriority": { "type": "integer", "minimum": 0, @@ -11476,103 +13288,32 @@ } } } - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "required": [ - "resource_name", - "name", - "description", - "methods" - ], - "properties": { - "resource_name": { - "$ref": "#/components/schemas/ResourceName" - }, - "name": { - "$ref": "#/components/schemas/RuleName" - }, - "description": { - "$ref": "#/components/schemas/Description" - }, - "methods": { - "type": "array", - "default": [], - "items": { - "type": "object", - "required": [ - "method" - ], - "properties": { - "priority": { - "$ref": "#/components/schemas/RuleMethodPriority" - }, - "method": { - "type": "object", - "required": [ - "resource_name", - "mtype", - "enabled", - "live_status", - "ready_status", - "methods" - ], - "properties": { - "resource_name": { - "$ref": "#/components/schemas/ResourceName" - }, - "mtype": { - "type": "string", - "enum": [ - "entry_a", - "entry_aaaa", - "entry_cname", - "failover", - "exit_site", - "exit_sorry" - ], - "description": "メソッド種別" - }, - "enabled": { - "type": "boolean", - "default": false, - "description": "状態" - }, - "site_resource_name": { - "type": "string", - "description": "紐付けされているサイトのリソース名（mtype が exit_site の場合のみ指定）", - "maxLength": 253 - }, - "live_status": { - "type": "string", - "enum": [ - "up", - "down" - ], - "description": "Live Status" - }, - "ready_status": { - "type": "string", - "enum": [ - "up", - "down" - ], - "description": "Ready Status" - }, - "methods": { - "type": "array", - "default": [], - "description": "以降はmethods配下のパラメータ(priority,methodを含むオブジェクト)がネストします。\\\nentry_methodを除き5階層まで指定可能です。\n" - } - } - } - } - } - } - } - } + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "required": [ + "resource_name", + "name", + "description", + "methods" + ], + "properties": { + "resource_name": { + "$ref": "#/components/schemas/ResourceName" + }, + "name": { + "$ref": "#/components/schemas/RuleName" + }, + "description": { + "$ref": "#/components/schemas/Description" + }, + "methods": { + "$ref": "#/components/schemas/ConfigRuleMethods" + } + } + } } } }, @@ -11862,132 +13603,123 @@ "$ref": "#/components/schemas/PatchDescription" }, "methods": { - "type": "array", - "items": { - "type": "object", - "required": [ - "method" - ], - "properties": { - "priority": { - "$ref": "#/components/schemas/RuleMethodPriority" - }, - "method": { - "type": "object", - "required": [ - "resource_name", - "mtype", - "enabled", - "methods" - ], - "properties": { - "resource_name": { - "$ref": "#/components/schemas/ResourceName" - }, - "mtype": { - "type": "string", - "enum": [ - "entry_a", - "entry_aaaa", - "entry_cname", - "failover", - "exit_site", - "exit_sorry" - ], - "description": "メソッド種別" - }, - "enabled": { - "type": "boolean", - "description": "状態" - }, - "site_resource_name": { - "type": "string", - "description": "紐付けされているサイトのリソース名（mtype が exit_site の場合のみ指定）", - "maxLength": 253 - }, - "methods": { - "type": "array", - "description": "以降はmethods配下のパラメータ(priority,methodを含むオブジェクト)がネストします。\\\nentry_methodを除き5階層まで指定可能です。\n" - } - } - } + "$ref": "#/components/schemas/ConfigRuleMethods" + } + } + } + } + } + }, + "ConfigRuleMethods": { + "type": "array", + "items": { + "type": "object", + "required": [ + "method" + ], + "properties": { + "priority": { + "$ref": "#/components/schemas/RuleMethodPriority" + }, + "method": { + "allOf": [ + { + "$ref": "#/components/schemas/RuleMethodMethod" + }, + { + "type": "object", + "required": [ + "methods" + ], + "properties": { + "methods": { + "$ref": "#/components/schemas/ConfigRuleMethods" } } } - } + ] } } } }, - "LbDomainsLogsType": { + "SearchLbDomainsLogsType": { "type": "array", "minItems": 0, "default": [], - "description": "詳細説明は**[こちら](#tag/logs-(lb_domains))**", + "description": "詳細説明は[**こちら**](#tag/logs-(lb_domains)", "items": { - "type": "string", - "enum": [ - "service", - "rule", - "site", - "monitoring", - "file", - "monitoring_event" - ] + "$ref": "#/components/schemas/LbDomainsLogsType" } }, - "LbDomainsLogsOperation": { + "SearchLbDomainsLogsOperation": { "type": "array", "minItems": 0, "default": [], - "description": "詳細説明は**[こちら](#tag/logs-(lb_domains))**", + "description": "詳細説明は[**こちら**](#tag/logs-(lb_domains))", "items": { - "type": "string", - "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" - ] + "$ref": "#/components/schemas/LbDomainsLogsOperation" } }, - "LbDomainsLogsStatus": { + "SearchLbDomainsLogsStatus": { "type": "array", "minItems": 0, "default": [], - "description": "詳細説明は**[こちら](#tag/logs-(lb_domains))**", + "description": "詳細説明は[**こちら**](#tag/logs-(lb_domains))", "items": { - "type": "string", - "enum": [ - "start", - "success", - "failure", - "retry" - ] + "$ref": "#/components/schemas/LbDomainsLogsStatus" } }, + "LbDomainsLogsType": { + "type": "string", + "enum": [ + "service", + "rule", + "site", + "monitoring", + "file", + "monitoring_event" + ] + }, + "LbDomainsLogsOperation": { + "type": "string", + "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" + ] + }, + "LbDomainsLogsStatus": { + "type": "string", + "enum": [ + "start", + "success", + "failure", + "retry" + ] + }, "LbDomainsLog": { "type": "object", "required": [ @@ -12044,6 +13776,168 @@ } } }, + "responses": { + "Accepted": { + "description": "Accepted", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AsyncResponse" + }, + "examples": { + "AsyncResponse": { + "$ref": "#/components/examples/AsyncResponse" + } + } + } + } + }, + "GetContractLabelsSuccessResponse": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Response" + }, + { + "type": "object", + "required": [ + "result" + ], + "properties": { + "result": { + "$ref": "#/components/schemas/ContractLabels" + } + } + } + ] + }, + "examples": { + "success": { + "$ref": "#/components/examples/GetContractLabels" + } + } + } + } + }, + "PutContractLabelsBadRequest": { + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | contract | 指定したContractIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\ninvalid_format_key | labels | 指定したlabel_keyのフォーマットを確認してください\ninvalid_length_key | labels | 指定したlabel_keyの文字数を確認してください\ninvalid_char_type_key | labels | 指定したlabel_keyの文字種を確認してください\ninvalid_format_value | labels | 指定したlabel_valueのフォーマットを確認してください\ninvalid_length_value | labels | 指定したlabel_valueの文字数を確認してください\ninvalid_char_type_value | labels | 指定したlabel_valueの文字種を確認してください\ninvalid_type_value | labels | 指定したパラメータの型を確認してください\n\n
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TargetBadRequest" + }, + "examples": { + "BadRequest": { + "$ref": "#/components/examples/BadRequest" + } + } + } + } + }, + "GetZoneLabelsSuccessResponse": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Response" + }, + { + "type": "object", + "required": [ + "result" + ], + "properties": { + "result": { + "$ref": "#/components/schemas/ZoneLabels" + } + } + } + ] + }, + "examples": { + "success": { + "$ref": "#/components/examples/GetZoneLabels" + } + } + } + } + }, + "PutZoneLabelsBadRequest": { + "description": "Bad Request\n\n
\nErrorDetails\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | zone | 指定したZoneIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\ninvalid_format_key | labels | 指定したlabel_keyのフォーマットを確認してください\ninvalid_length_key | labels | 指定したlabel_keyの文字数を確認してください\ninvalid_char_type_key | labels | 指定したlabel_keyの文字種を確認してください\ninvalid_format_value | labels | 指定したlabel_valueのフォーマットを確認してください\ninvalid_length_value | labels | 指定したlabel_valueの文字数を確認してください\ninvalid_char_type_value | labels | 指定したlabel_valueの文字種を確認してください\ninvalid_type_value | labels | 指定したパラメータの型を確認してください\n\n
\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TargetBadRequest" + }, + "examples": { + "BadRequest": { + "$ref": "#/components/examples/BadRequest" + } + } + } + } + }, + "GetDsRecordsSuccessResponse": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Response" + }, + { + "type": "object", + "required": [ + "results" + ], + "properties": { + "results": { + "type": "array", + "minItems": 0, + "default": [], + "items": { + "type": "object", + "required": [ + "name", + "ttl", + "rrtype", + "rdata" + ], + "properties": { + "name": { + "$ref": "#/components/schemas/RecordsName" + }, + "ttl": { + "$ref": "#/components/schemas/RecordsTtl" + }, + "rrtype": { + "$ref": "#/components/schemas/DsRecordsRrtype" + }, + "rdata": { + "$ref": "#/components/schemas/RecordsRdata" + } + } + } + } + } + } + ] + }, + "examples": { + "success": { + "$ref": "#/components/examples/GetDsRecordsFromCds" + } + } + } + } + } + }, "examples": { "AsyncResponse": { "value": { @@ -12352,6 +14246,26 @@ "favorite": 2 } }, + "GetContractLabels": { + "summary": "正常取得", + "value": { + "request_id": "782d746ac3cb46499b31708fa80e8660", + "result": { + "labels": { + "label_key_1": "label_value_1", + "label_key_2": "label_value_2" + } + } + } + }, + "PutContractLabels": { + "value": { + "labels": { + "label_key_1": "label_value_1", + "label_key_2": "label_value_2" + } + } + }, "GetContractsLogs": { "value": { "request_id": "782d746ac3cb46499b31708fa80e8660", @@ -12391,8 +14305,8 @@ "value": { "common_config_id": 1234, "zone_ids": [ - "mxxxxxxxxxxxxxx", - "myyyyyyyyyyyyyy" + "mxxxxxxxxxxxxx", + "myyyyyyyyyyyyy" ] } }, @@ -12400,8 +14314,8 @@ "value": { "common_config_id": 1234, "lb_domain_ids": [ - "bxxxxxxxxxxxxxx", - "byyyyyyyyyyyyyy" + "bxxxxxxxxxxxxx", + "byyyyyyyyyyyyy" ] } }, @@ -12426,7 +14340,7 @@ "results": [ { "rrset": "example.com. IN DS 1234 8 2 E8.....", - "transited_at": "2020-01-01T01:02:03:000Z" + "transited_at": "2020-01-01T01:02:03.000+00:00" } ] } @@ -12605,14 +14519,14 @@ "request_id": "782d746ac3cb46499b31708fa80e8660", "results": [ { - "id": "1234", + "id": 1234, "name": "name1.fxxxxxxxxxxxxx.d-53.net.", "algorithm": 0, "secret": "YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXowMTIzNTY3ODk=", "description": "" }, { - "id": "1235", + "id": 1235, "name": "name2.fxxxxxxxxxxxxx.d-53.net.", "algorithm": 0, "secret": "MDEyMzU2Nzg5YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXo=", @@ -12631,7 +14545,7 @@ "value": { "request_id": "782d746ac3cb46499b31708fa80e8660", "result": { - "id": "1234", + "id": 1234, "name": "name.fxxxxxxxxxxxxx.d-53.net.", "algorithm": 0, "secret": "YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXowMTIzNTY3ODk=", @@ -12738,6 +14652,10 @@ "value": "ns000.d-53.net. dns-managers.iij.ad.jp. 1 3600 600 604800 300" } ], + "labels": { + "label_key_1": "label_value_1", + "label_key_2": "label_value_2" + }, "state": 0, "description": "", "operator": null @@ -12758,6 +14676,10 @@ "value": "ns001-xxxxxxxxxxxxxxxx.x.d-53.info." } ], + "labels": { + "label_key_3": "label_value_3", + "label_key_4": "label_value_4" + }, "state": 0, "description": "", "operator": null @@ -12765,6 +14687,60 @@ ] } }, + "PutRecord": { + "value": { + "records": [ + { + "name": "example.com.", + "ttl": null, + "rrtype": "SOA", + "rdata": [ + { + "value": "ns000.d-53.net. dns-managers.iij.ad.jp. 1 3600 600 604800 900" + } + ], + "labels": { + "key1": "value1", + "key2": "value2" + }, + "description": "" + }, + { + "name": "example.com.", + "ttl": 300, + "rrtype": "NS", + "rdata": [ + { + "value": "ns001-xxxxxxxxxxxxxxxx.o.d-53.jp." + }, + { + "value": "ns001-xxxxxxxxxxxxxxxx.o.d-53.net." + }, + { + "value": "ns001-xxxxxxxxxxxxxxxx.o.d-53.info." + } + ], + "labels": { + "key3": "value3", + "key4": "value4" + }, + "description": "comment" + }, + { + "name": "sample.example.com.", + "ttl": 600, + "rrtype": "TXT", + "rdata": [ + { + "value": "\"sample\"" + } + ], + "labels": {}, + "description": "" + } + ] + } + }, "PostRecord": { "value": { "name": "example.com", @@ -12790,6 +14766,10 @@ "value": "ns000.d-53.net. dns-managers.iij.ad.jp. 1 3600 600 604800 300" } ], + "labels": { + "label_key_1": "label_value_1", + "label_key_2": "label_value_2" + }, "state": 0, "description": "", "operator": null @@ -12816,6 +14796,10 @@ "value": "ns000.d-53.net. dns-managers.iij.ad.jp. 1 3600 600 604800 300" } ], + "labels": { + "label_key_1": "label_value_1", + "label_key_2": "label_value_2" + }, "state": 3, "description": "", "operator": "SAXXXXXXX" @@ -12830,6 +14814,10 @@ "value": "ns000.d-53.net. dns-managers.iij.ad.jp. 1 3600 600 604800 300" } ], + "labels": { + "label_key_1": "label_value_1", + "label_key_2": "label_value_2" + }, "state": 5, "description": "", "operator": null @@ -12852,6 +14840,10 @@ "value": "ns001-xxxxxxxxxxxxxxxx.x.d-53.info." } ], + "labels": { + "label_key_3": "label_value_3", + "label_key_4": "label_value_4" + }, "state": 3, "description": "", "operator": "SAXXXXXXX" @@ -12872,6 +14864,10 @@ "value": "ns001-xxxxxxxxxxxxxxxx.x.d-53.info." } ], + "labels": { + "label_key_3": "label_value_3", + "label_key_4": "label_value_4" + }, "state": 5, "description": "", "operator": null @@ -12880,19 +14876,36 @@ ] } }, + "GetDsRecordsFromCds": { + "value": { + "request_id": "782d746ac3cb46499b31708fa80e8660", + "results": [ + { + "name": "sub.example.com.", + "ttl": 28800, + "rrtype": "DS", + "rdata": [ + { + "value": "41647 13 2 2ad225a2e5b514c2f443f30bb5fa926cf4a11a2722349b7b37000cd06ef7185f" + } + ] + } + ] + } + }, "GetZoneHistories": { "value": { "request_id": "782d746ac3cb46499b31708fa80e8660", "results": [ { "id": 1234, - "committed_at": "2020-01-01T01:02:03:000Z", + "committed_at": "2020-01-01T01:02:03.000+00:00", "description": "", "operator": "SAXXXXXXX" }, { "id": 1235, - "committed_at": "2020-01-02T01:02:03:000Z", + "committed_at": "2020-01-01T01:02:03.000+00:00", "description": "", "operator": "SAXXXXXXX" } @@ -12904,7 +14917,7 @@ "request_id": "782d746ac3cb46499b31708fa80e8660", "result": { "id": 1234, - "committed_at": "2020-01-01T01:02:03:000Z", + "committed_at": "2020-01-01T01:02:03.000+00:00", "description": "", "operator": "SAXXXXXXX", "text": "$TTL 28800\nexample.com. IN SOA ns000.d-53.net. dns-managers.iij.ad.jp. 1 3600 600 604800 300\nexample.com. IN NS ns001-xxxxxxxxxxxxxxxx.x.d-53.jp.\nexample.com. IN NS ns001-xxxxxxxxxxxxxxxx.x.d-53.org.\nexample.com. IN NS ns001-xxxxxxxxxxxxxxxx.x.d-53.info." @@ -12927,17 +14940,17 @@ "GetHealthCheck": { "value": { "request_id": "782d746ac3cb46499b31708fa80e8660", - "result": [ + "results": [ { "address": "192.0.2.0", "status": "NG", - "tsig_nae": "name1.fxxxxxxxxxxxxx.d-53.net.", + "tsig_name": "name1.fxxxxxxxxxxxxx.d-53.net.", "enabled": 1 }, { "address": "198.51.100.0", "status": "OK", - "tsig_nae": "name2.fxxxxxxxxxxxxx.d-53.net.", + "tsig_name": "name2.fxxxxxxxxxxxxx.d-53.net.", "enabled": 1 } ] @@ -12955,8 +14968,7 @@ "favorite": 1, "name": "name1.example.com.", "network": null, - "description": "", - "zone_proxy_enabled": 0 + "description": "" }, { "id": "myyyyyyyyyyyyy", @@ -12966,8 +14978,7 @@ "favorite": 2, "network": null, "name": "name2.example.com.", - "description": "", - "zone_proxy_enabled": 0 + "description": "" } ] } @@ -12983,8 +14994,7 @@ "favorite": 1, "name": "name.example.com.", "network": null, - "description": "", - "zone_proxy_enabled": 0 + "description": "" } } }, @@ -13008,27 +15018,45 @@ ] } }, + "GetZoneLabels": { + "summary": "正常取得", + "value": { + "request_id": "782d746ac3cb46499b31708fa80e8660", + "result": { + "labels": { + "label_key_1": "label_value_1", + "label_key_2": "label_value_2" + } + } + } + }, + "PutZoneLabels": { + "value": { + "labels": { + "label_key_1": "label_value_1", + "label_key_2": "label_value_2" + } + } + }, "GetDelegations": { "value": { "request_id": "782d746ac3cb46499b31708fa80e8660", "results": [ { "id": "mxxxxxxxxxxxxx", - "service_code\"": "dpmxxxxxxxx", - "favorite\"": 1, - "name\"": "name1.example.com.", + "service_code": "dpmxxxxxxxx", + "name": "name1.example.com.", "network": null, "description": "", - "delegation_requested_at": "2020-01-01T01:02:03:000Z" + "delegation_requested_at": "2020-01-01T01:02:03.000+00:00" }, { "id": "myyyyyyyyyyyyy", - "service_code\"": "dpmyyyyyyyy", - "favorite\"": 2, - "name\"": "name2.example.com.", + "service_code": "dpmyyyyyyyy", + "name": "name2.example.com.", "network": null, "description": "", - "delegation_requested_at": "" + "delegation_requested_at": "2020-01-01T01:02:03.000+00:00" } ] } @@ -13163,9 +15191,56 @@ ] } }, - "PostMonitoring": { + "PostMonitoringPing": { + "value": { + "name": "monitoring-ping", + "mtype": "ping", + "props": { + "interval": 600, + "timeout": 30, + "holdtime": 0 + } + } + }, + "PostMonitoringTCP": { + "value": { + "name": "monitoring-tcp", + "mtype": "tcp", + "props": { + "interval": 600, + "timeout": 30, + "holdtime": 0, + "port": 53 + } + } + }, + "PostMonitoringHTTP": { + "value": { + "name": "monitoring-ping", + "mtype": "http", + "props": { + "interval": 600, + "timeout": 30, + "holdtime": 0, + "https": true, + "headers": [ + { + "field_name": "Host", + "field_value": "www.example.jp" + } + ], + "path": "ready", + "response_match": "status=ok", + "status_codes": [ + "200", + "202" + ] + } + } + }, + "PostMonitoringStatic": { "value": { - "name": "monitoring002", + "name": "monitoring-static", "mtype": "static", "description": "", "props": { @@ -13188,8 +15263,32 @@ } } }, - "PatchMonitoring": { + "PatchMonitoringPing": { + "value": { + "props": { + "interval": 300 + } + } + }, + "PatchMonitoringTCP": { + "value": { + "description": "description", + "props": { + "port": 443 + } + } + }, + "PatchMonitoringHTTP": { + "value": { + "description": "description", + "props": { + "path": "live" + } + } + }, + "PatchMonitoringStatic": { "value": { + "name": "monitoring-static2", "description": "description", "props": { "result": "up" @@ -13349,7 +15448,7 @@ "methods": [ { "method": { - "resource_name\"": "bzzzzzzzzzzzzz-zzzz-zzzzz", + "resource_name": "bzzzzzzzzzzzzz-zzzz-zzzzz", "mtype": "entry_a", "enabled": true, "live_status": "down", @@ -13670,5 +15769,184 @@ } } } - } -} \ No newline at end of file + }, + "tags": [ + { + "name": "cc_primaries", + "description": "プライマリネームサーバの操作ができます。\\\nプライマリネームサーバの状態（enabled）は以下のとおりです。\n\n### enabled\n値 | 意味 | 備考\n---|------|-----\n0 | 無効 |\n1 | 有効 |\n" + }, + { + "name": "cc_sec_notified_servers", + "description": "DNS NOTIFYの操作ができます。\n" + }, + { + "name": "cc_sec_transfer_acls", + "description": "ゾーン転送ACLの操作ができます。\n" + }, + { + "name": "cc_notice_accounts", + "description": "通知先アカウントの操作ができます。\n" + }, + { + "name": "common_configs", + "description": "複数のゾーンおよびLBドメインで共通の設定内容を使用するための共通設定を操作できます。\\\nマネージドDNSサーバの状態（managed_dns_enabled）、初期適用の共通設定（default）は以下のとおりです。\n\n### managed_dns_enabled\n値 | 意味 | 備考\n---|------|-----\n0 | 無効 |\n1 | 有効 |\n\n### default\n値 | 意味 | 備考\n---|------|-----\n0 | 無効 |\n1 | 有効 |\n" + }, + { + "name": "contracts", + "description": "DPF契約の操作ができます。\\\n契約プラン（plan）、契約の状態（state）、お気に入りの状態（favorite）は以下のとおりです。\n\n### plan\n値 | 意味 | 備考\n---|------|-----\n 1 | ベーシック |\n 2 | プレミアム |\n\n### state\n値 | 意味 | 備考\n---|------|-----\n 1 | 利用開始前 |\n 2 | 利用中 |\n\n### favorite\n値 | 意味 | 備考\n---|------|-----\n 1 | 表示優先度高 |\n 2 | 表示優先度低 |\n" + }, + { + "name": "contract_partners", + "description": "DPF契約の連携しているサービス情報の操作ができます。\n" + }, + { + "name": "logs (contracts)", + "description": "DPF契約を操作したログを取得できます。\\\n取得可能なログは90日前までとなります。\\\n操作内容（operation）、ログの種別（log_type）、処理の状態（status）は以下のとおりです。\n\n### operation\n値 | 意味 | 備考\n---|------|-----\nadd_cc_primary | プライマリネームサーバ設定の作成 |\nupdate_cc_primary | プライマリネームサーバ設定の更新 |\ndelete_cc_primary | プライマリネームサーバ設定の削除 |\nadd_cc_sec_notified_server | DNS NOTIFY設定の作成 |\nupdate_cc_sec_notified_server | DNS NOTIFY設定の更新 |\ndelete_cc_sec_notified_server | DNS NOTIFY設定の削除 |\nadd_cc_sec_transfer_acl | ゾーン転送ACLの作成 |\nupdate_cc_sec_transfer_acl | ゾーン転送ACLの更新 |\ndelete_cc_sec_transfer_acl | ゾーン転送ACLの削除 |\nadd_notification_account | 通知先アカウント設定の追加 |\nupdate_notification_account | 通知先アカウント設定の更新 |\ndelete_notification_account | 通知先アカウント設定の削除 |\nmail_notification | メール通知の実行 |\nphone_notification | 架電通知の実行 |\ncreate_common_config | 共通設定の作成 |\nswitch_default_common_config | 初期適用される共通設定の更新 |\nupdate_common_config | 共通設定の更新 |\ndelete_common_config | 共通設定の削除 |\ncopy_common_config | 共通設定のコピー |\nupdate_managed_dns_state | マネージドDNSサーバの状態更新 |\nupdate_contract_description | DPF契約情報のコメントの更新 |\nupdate_contract_favorite | DPF契約情報のお気に入り状態の更新 |\nupdate_contract_labels | DPF契約情報のラベルの更新 |\napply_common_config | DPF契約に紐付くゾーンおよびLBドメインの共通設定の更新 |\ncreate_contract_partnership | IIJ IDサービスとの連携 |\ndelete_contract_partnership | IIJ IDサービスとの連携解除 |\ncreate_tsig | TSIG鍵の作成 |\nupdate_tsig | TSIG鍵の更新 |\ndelete_tsig | TSIG鍵の削除 |\n\n### log_type\n値 | 意味 | 備考\n---|------|-----\nservice | サービス設定の操作 |\ncommon_config | 共通設定の操作 |\nnotification | 通知の実行 |\n\n### status\n値 | 意味 | 備考\n---|------|-----\nstart | 処理開始 |\nsuccess | 処理正常終了 |\nfailure | 処理失敗 |\nretry | リトライ |\n" + }, + { + "name": "qps", + "description": "" + }, + { + "name": "tsigs", + "description": "TSIG鍵の操作ができます。\\\nハッシュアルゴリズム（algorithm）は以下のとおりです。\n\n### algorithm\n値 | 意味 | 備考\n---|------|-----\n0 | HMAC-SHA256 |\n" + }, + { + "name": "zones (contracts)", + "description": "DPF契約に紐付くゾーンの操作ができます。\\\nゾーンの状態（state）、お気に入りの状態（favorite）、ゾーンプロキシの状態（zone_proxy_enabled）の詳細な説明は、[**zones**](#tag/zones)を参照してください。\n" + }, + { + "name": "lb_domains (contracts)", + "description": "DPF契約に紐付くLBドメインの操作ができます。\\\nLBドメインの状態（state）、お気に入りの状態（favorite）の詳細な説明は、[**lb_domains**](#tag/lb_domains)を参照してください。\n" + }, + { + "name": "default_ttl", + "description": "契約に紐づくゾーンのデフォルトTTLの操作ができます。\\\nデフォルトTTLの状態（state）は以下のとおりです。\n\n### state\n値 | 意味 | 備考\n---|------|-----\n 0 | 反映済み |\n 3 | 更新予定 |\n 5 | 更新前の状態 |\n" + }, + { + "name": "dnssec", + "description": "DNSSECの操作ができます。\\\nDNSSECの有効状態（enabled）、DNSSECの状態（state）、DSレコードの状態（ds_state）は以下のとおりです。\n\n### enabled\n値 | 意味 | 備考\n---|------|-----\n0 | 無効 |\n1 | 有効 |\n\n### state\n値 | 意味 | 備考\n---|------|-----\n0 | ゾーン公開前 |\n1 | 有効化作業中 |\n2 | 有効 |\n3 | 無効化作業中 |\n4 | 無効 |\n\n### ds_state\n値 | 意味 | 備考\n---|------|-----\n0 | 公開前 |\n1 | DSレコード登録待ち |\n3 | DSレコード公開中 |\n4 | ロールオーバー準備中 |\n5 | DSレコード変更待ち |\n6 | DSレコード変更反映待ち |\n7 | DSレコード削除待ち |\n8 | DSレコード削除反映待ち |\n" + }, + { + "name": "ds_records", + "description": "" + }, + { + "name": "logs (zones)", + "description": "契約に紐付くゾーンを操作したログを取得できます。\\\n取得可能なログは90日前までとなります。\\\n操作内容（operation）、ログの種別（log_type）、処理の状態（status）は以下のとおりです。\n\n### operation\n値 | 意味 | 備考\n---|------|-----\nupdating_default_ttl | デフォルトTTLの更新 |\ndismiss_default_ttl_change | 編集中デフォルトTTLの取消 |\nupdate_dnssec_configuration | DNSSEC情報の更新 |\nbegin_ksk_rollover | KSKロールオーバーの開始 |\nadding_record | レコードの作成 |\nupdating_record | レコードの更新 |\ndeleting_record | レコードの削除 |\ndismiss_record_change | 編集中レコードの取消 |\nupdate_zone_proxy | ゾーンプロキシ設定の更新 |\nupdate_zone_description | ゾーンのコメントの更新 |\nupdate_zone_favorite | ゾーンのお気に入り状態の更新 |\nupdate_zone_labels | ゾーンのラベルの更新 |\ncommit_zone | 編集中レコードのゾーン反映 |\nupload_zone | ゾーンファイルのアップロード |\ndismiss_zone_edits | 編集中レコードの一括取消 |\nbulk_update_records | レコードの一括更新 |\nupsert_subdomain_ns_records | サブドメインNSレコードの一括登録\t |\ncreate_delegations | ネームサーバ申請 |\n\n### log_type\n値 | 意味 | 備考\n---|------|-----\nservice | サービス設定の操作 |\nrecord | レコードの操作 |\ndnssec | DNSSEC設定の操作 |\n\n### status\n値 | 意味 | 備考\n---|------|-----\nstart | 処理開始 |\nsuccess | 処理正常終了 |\nfailure | 処理失敗 |\nretry | リトライ |\n" + }, + { + "name": "records", + "description": "契約に紐付くゾーンのレコード操作ができます。\\\nレコード操作の状態（state）は以下のとおりです。\n\n### state\n値 | 意味 | 備考\n---|------|-----\n 0 | 反映済み |\n 1 | 追加予定 |\n 2 | 削除予定 |\n 3 | 更新予定 |\n 5 | 更新前の状態 |\n" + }, + { + "name": "zone_histories", + "description": "当日を含めて90日前までのゾーン反映の履歴を確認できます。\\\n確認のタイミングにより、それ以前の履歴を確認できる場合があります。\n" + }, + { + "name": "zone_proxy", + "description": "ゾーンプロキシの操作ができます。\\\nゾーンプロキシの状態（enabled）、ゾーン転送の状態（state）は以下のとおりです。\n\n### enabled\n値 | 意味 | 備考\n---|------|-----\n 0 | 無効 |\n 1 | 有効 |\n\n### state\n値 | 意味 | 備考\n---|------|-----\n OK | ゾーン転送成功 |\n NG | ゾーン転送失敗 |\n" + }, + { + "name": "zones", + "description": "DPF契約に紐付くゾーンの操作ができます。\\\nゾーンの状態（state）、お気に入りの状態（favorite）、ゾーンプロキシの状態（zone_proxy_enabled）は以下のとおりです。\n\n### state\n値 | 意味 | 備考\n---|------|-----\n 1 | 公開前 |\n 2 | 公開 |\n\n### favorite\n値 | 意味 | 備考\n---|------|-----\n 1 | 表示優先度高 |\n 2 | 表示優先度低 |\n\n### zone_proxy_enabled\n値 | 意味 | 備考\n---|------|-----\n 0 | 無効 |\n 1 | 有効 |\n" + }, + { + "name": "lb_domains", + "description": "DPF契約に紐付くLBドメインの操作ができます。\\\nLBドメインの状態（state）、お気に入りの状態（favorite）は以下のとおりです。\n\n### state\n値 | 意味 | 備考\n---|------|-----\n 1 | 公開前 |\n 2 | 公開 |\n\n### favorite\n値 | 意味 | 備考\n---|------|-----\n 1 | 表示優先度高 |\n 2 | 表示優先度低 |\n" + }, + { + "name": "monitorings", + "description": "LBドメインに紐付く監視の操作ができます。\n" + }, + { + "name": "sites", + "description": "LBドメインに紐付くサイトの操作ができます。\n" + }, + { + "name": "endpoints", + "description": "サイトに紐付くエンドポイントの操作ができます。\n" + }, + { + "name": "rules", + "description": "LBドメインに紐付くルールの操作ができます。\\\n適用ルールは[**LBドメインの更新**](#tag/lb_domains/operation/patchLbDomain)で切り替えができます。\n" + }, + { + "name": "rule_methods", + "description": "ルールに紐付くルールメソッドの操作ができます。\n" + }, + { + "name": "config", + "description": "LBドメインに紐付く設定と状態の操作ができます。\n" + }, + { + "name": "logs (lb_domains)", + "description": "契約に紐付くLBドメインを操作したログを取得できます。\\\n取得可能なログは90日前までとなります。\\\n操作内容（operation）、ログの種別（log_type）、処理の状態（status）は以下のとおりです。\n\n### operation\n値 | 意味 | 備考\n---|------|-----\nupdate_lb_domain_description | トラフィックコントロール契約のコメントの更新 |\nupdate_lb_domain_favorite | トラフィックコントロール契約のお気に入り状態の切り替え |\nupdate_lb_domain_labels | トラフィックコントロール契約のラベルの更新 |\nupdate_lb_domain_rule | 適用ルールの切り替え |\nadd_rule | ルールの追加 |\nupdate_rule | ルールの更新 |\ndelete_rule | ルールの削除 |\nadd_rule_method | ルールメソッドの追加 |\nupdate_rule_method | ルールメソッドの更新 |\ndelete_rule_method | ルールメソッドの削除 |\nadd_site | サイトの追加 |\nupdate_site | サイトの更新 |\ndelete_site | サイトの削除 |\nadd_endpoint | エンドポイントの追加 |\nupdate_endpoint | エンドポイントの更新 |\ndelete_endpoint | エンドポイントの削除 |\nmanual_failover | エンドポイントの手動切り離し |\nmanual_failback | エンドポイントの手動切り戻し |\nadd_monitoring | 監視の追加 |\nupdate_monitoring | 監視の更新 |\ndelete_monitoring | 監視の削除 |\nfile_import | ファイルインポート |\nmonitoring_result_changed | 監視結果の更新 |\nendpoint_live_status_changed | エンドポイントLiveStatusの更新 |\nendpoint_ready_status_changed | エンドポイントReadyStatusの更新 |\nsite_live_status_changed | サイトLiveStatusの更新 |\n\n### log_type\n値 | 意味 | 備考\n---|------|-----\nservice | サービス設定の操作 |\nrule | ルールの操作 |\nsite | サイトの操作 |\nmonitoring | 監視の操作 |\nfile | ファイル設定の操作 |\nmonitoring_event | 監視イベントの操作 |\n\n### status\n値 | 意味 | 備考\n---|------|-----\nstart | 処理開始 |\nsuccess | 処理正常終了 |\nfailure | 処理失敗 |\nretry | リトライ |\n" + }, + { + "name": "delegations", + "description": "ネームサーバ申請の操作ができます。\\\nお気に入りの状態（favorite）、ネームサーバの状態（requested）は以下のとおりです。\n\n### favorite\n値 | 意味 | 備考\n---|------|-----\n1 | 表示優先度高 |\n2 | 表示優先度低 |\n\n### requested\n値 | 意味 | 備考\n---|------|-----\n0 | 未申請 |\n1 | 申請済み |\n" + }, + { + "name": "jobs", + "description": "非同期リクエストの状態確認ができます。\\\nリクエストの状態（status）は以下のとおりです。\n\n### status\n値 | 意味 | 備考\n---|------|-----\nRUNNING | 処理中 |\nSUCCESSFUL | 正常終了 |\nFAILED | 異常終了 |\n" + }, + { + "name": "ping", + "description": "" + } + ], + "x-tagGroups": [ + { + "name": "IIJ DNSプラットフォームサービス", + "tags": [ + "cc_notice_accounts", + "cc_primaries", + "cc_sec_notified_servers", + "cc_sec_transfer_acls", + "common_configs", + "contracts", + "contract_partners", + "lb_domains (contracts)", + "logs (contracts)", + "qps", + "tsigs", + "zones (contracts)" + ] + }, + { + "name": "IIJマネージドDNSサービス", + "tags": [ + "default_ttl", + "dnssec", + "ds_records", + "logs (zones)", + "records", + "zone_histories", + "zone_proxy", + "zones" + ] + }, + { + "name": "IIJ DNSトラフィックマネージメントサービス", + "tags": [ + "config", + "endpoints", + "lb_domains", + "logs (lb_domains)", + "monitorings", + "rule_methods", + "rules", + "sites" + ] + }, + { + "name": "サービス共通", + "tags": [ + "delegations", + "jobs", + "ping" + ] + } + ] +}