-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.json
16107 lines (16107 loc) · 526 KB
/
swagger.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.0.2",
"info": {
"title": "DPF-APIリファレンスマニュアル",
"version": "1.0",
"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<HTTPメソッド> /dpf/<version>/<APIパス> HTTP/1.1\nHost: api.dns-platform.jp\nAuthorization: Bearer <access_token>\nContent-Type: application/json; charset=UTF-8\n\n<HTTPリクエストボディ: JSON形式のAPI固有のパラメータ>\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が正しくありません <br> 存在しないAPIが指定されました <br> 指定された以外のHTTPメソッドが指定されました | 左記の内容を確認してください\n429 | TooManyRequests | Too many requests. | - | - | 大量のAPIリクエストが送信されました | 単位時間当たりのAPIリクエスト数が多いため、リクエスト数を抑えてください\n500 | SystemError | System error occurred. | - | - | システム障害が発生しました | [**サポートセンター**](https://help.iij.ad.jp/)へお問い合わせください<br>お問い合わせの際にリクエストの詳細時間及びrequest_idをお伝えください\n503 | ServiceUnavailable | Service unavailable. | - | - | メンテナンス中もしくはアクセスが集中しています | しばらく待ってから再度リクエストしてください<br>メンテナンス内容についてはサービスオンラインでご確認ください\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/<version>/jobs/<request_id>\"\n}\n```\n\n#### GETリクエスト\n```\nGET /dpf/<version>/jobs/<request_id> HTTP/1.1\nHost: api.dns-platform.jp\nAuthorization: Bearer <access_token>\nContent-Type: application/json; charset=UTF-8\n\n{}\n```\n\n#### 進捗状況のレスポンス\n```\nHTTP/1.1 200 OK\nDate: Mon, 26 Mar 202X hh:mm:dd GMT\nContent-Type: application/json; charset=utf-8\n〜 略 〜\n\n{\n \"request_id\": \"782d746ac3cb46499b31708fa80e8660\",\n \"resources_url\": <resources_url>,\n \"status\": \"SUCCESSFUL\"\n}\n```\n"
},
"servers": [
{
"url": "https://api.dns-platform.jp/dpf/v1",
"description": "API endpoint"
}
],
"paths": {
"/common_configs/{CommonConfigId}/cc_primaries": {
"parameters": [
{
"$ref": "#/components/parameters/CommonConfigId"
}
],
"get": {
"operationId": "getCcPrimaryList",
"summary": "プライマリネームサーバ設定の一覧取得",
"description": "プライマリネームサーバの設定の一覧を取得します。\n",
"tags": [
"cc_primaries"
],
"security": [
{
"DPFViewer": [
"dpf_read"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCcPrimaries"
},
"examples": {
"GetCcPrimaries": {
"$ref": "#/components/examples/GetCcPrimaries"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
},
"post": {
"operationId": "postCcPrimary",
"summary": "プライマリネームサーバ設定の作成",
"description": "新しくプライマリネームサーバを作成します。\\\n作成できる最大件数は5件です。\n",
"tags": [
"cc_primaries"
],
"security": [
{
"DPFOperator": [
"dpf_write"
]
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostCcPrimary"
},
"examples": {
"PostCcPrimaries": {
"$ref": "#/components/examples/PostCcPrimary"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncResponse"
},
"examples": {
"AsyncResponse": {
"$ref": "#/components/examples/AsyncResponse"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | tsig | 指定したTSIG鍵を確認してください\ninvalid | address | 指定したaddressを確認してください\ntoo_many | address | 登録の上限数を超えています\nduplicated | address | 既に登録されています\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
}
},
"/common_configs/{CommonConfigId}/cc_primaries/{CcPrimaryId}": {
"parameters": [
{
"$ref": "#/components/parameters/CommonConfigId"
},
{
"$ref": "#/components/parameters/CcPrimaryId"
}
],
"get": {
"operationId": "getCcPrimary",
"summary": "プライマリネームサーバ設定の取得",
"description": "指定したCcPrimaryIdのプライマリネームサーバを取得します。\n",
"tags": [
"cc_primaries"
],
"security": [
{
"DPFViewer": [
"dpf_read"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCcPrimary"
},
"examples": {
"GetCcPrimary": {
"$ref": "#/components/examples/GetCcPrimary"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | cc_primary | 指定したCcPrimaryIdを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
},
"patch": {
"operationId": "patchCcPrimary",
"summary": "プライマリネームサーバ設定の更新",
"description": "指定したCcPrimaryIdのプライマリネームサーバを更新します。\n",
"tags": [
"cc_primaries"
],
"security": [
{
"DPFOperator": [
"dpf_write"
]
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchCcPrimary"
},
"examples": {
"PatchCcPrimary": {
"$ref": "#/components/examples/PatchCcPrimary"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncResponse"
},
"examples": {
"AsyncResponse": {
"$ref": "#/components/examples/AsyncResponse"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | cc_primary | 指定したCcPrimaryIdを確認してください\nnot_found | tsig | 指定したTSIGを確認してください\ninvalid | address | 指定したaddressを確認してください\nduplicated | address | 指定したaddressを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
},
"delete": {
"operationId": "deleteCcPrimary",
"summary": "プライマリネームサーバ設定の削除",
"description": "指定したCcPrimaryIdのプライマリネームサーバを削除します。\n",
"tags": [
"cc_primaries"
],
"security": [
{
"DPFOperator": [
"dpf_write"
]
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncResponse"
},
"examples": {
"AsyncResponse": {
"$ref": "#/components/examples/AsyncResponse"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | cc_primary | 指定したCcPrimaryIdを確認してください\nforbidden | cc_primary | 有効のため削除できません\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
}
},
"/common_configs/{CommonConfigId}/cc_sec_notified_servers": {
"parameters": [
{
"$ref": "#/components/parameters/CommonConfigId"
}
],
"get": {
"operationId": "getCcSecNotifiedServerList",
"summary": "DNS NOTIFY設定の一覧取得",
"description": "DNS NOTIFYの設定の一覧を取得します。\n",
"tags": [
"cc_sec_notified_servers"
],
"security": [
{
"DPFViewer": [
"dpf_read"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCcSecNotifiedServers"
},
"examples": {
"GetCcSecNotifiedServers": {
"$ref": "#/components/examples/GetCcSecNotifiedServers"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
},
"post": {
"operationId": "postCcSecNotifiedServer",
"summary": "DNS NOTIFY設定の作成",
"description": "新しくDNS NOFITYを作成します。\\\n作成できる最大件数は256件です。\n",
"tags": [
"cc_sec_notified_servers"
],
"security": [
{
"DPFOperator": [
"dpf_write"
]
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostCcSecNotifiedServer"
},
"examples": {
"PostCcSecNotifiedServers": {
"$ref": "#/components/examples/PostCcSecNotifiedServer"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncResponse"
},
"examples": {
"AsyncResponse": {
"$ref": "#/components/examples/AsyncResponse"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | tsig | 指定したTSIG鍵を確認してください\ninvalid | address | 指定したaddressを確認してください\ntoo_many | address | 登録の上限数を超えています\nduplicated | address | 既に登録されています\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
}
},
"/common_configs/{CommonConfigId}/cc_sec_notified_servers/{CcSecNotifiedServerId}": {
"parameters": [
{
"$ref": "#/components/parameters/CommonConfigId"
},
{
"$ref": "#/components/parameters/CcSecNotifiedServerId"
}
],
"get": {
"operationId": "getCcSecNotifiedServer",
"summary": "DNS NOTIFY設定の取得",
"description": "指定したCcSecNotifiedServerIdのDNS NOTIFYを取得します。\n",
"tags": [
"cc_sec_notified_servers"
],
"security": [
{
"DPFViewer": [
"dpf_read"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCcSecNotifiedServer"
},
"examples": {
"GetCcSecNotifiedServer": {
"$ref": "#/components/examples/GetCcSecNotifiedServer"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | cc_sec_notified_server | 指定したCcSecNotifiedServerIdを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
},
"patch": {
"operationId": "patchCcSecNotifiedServer",
"summary": "DNS NOTIFY設定の更新",
"description": "指定したCcSecNotifiedServerIdのDNS NOTIFYを更新します。\n",
"tags": [
"cc_sec_notified_servers"
],
"security": [
{
"DPFOperator": [
"dpf_write"
]
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchCcSecNotifiedServer"
},
"examples": {
"PatchCcSecNotifiedServer": {
"$ref": "#/components/examples/PatchCcSecNotifiedServer"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncResponse"
},
"examples": {
"AsyncResponse": {
"$ref": "#/components/examples/AsyncResponse"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | cc_sec_notified_server | 指定したCcSecNotifiedServerIdを確認してください\nnot_found | tsig | 指定したTSIGを確認してください\ninvalid | address | 指定したaddressを確認してください\nduplicated | address | 指定したaddressを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
},
"delete": {
"operationId": "deleteCcSecNotifiedServer",
"summary": "DNS NOTIFY設定の削除",
"description": "指定したCcSecNotifiedServerIdのDNS NOTIFYを削除します。\n",
"tags": [
"cc_sec_notified_servers"
],
"security": [
{
"DPFOperator": [
"dpf_write"
]
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncResponse"
},
"examples": {
"AsyncResponse": {
"$ref": "#/components/examples/AsyncResponse"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | cc_sec_notified_server | 指定したCcSecNotifiedServerIdを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
}
},
"/common_configs/{CommonConfigId}/cc_sec_transfer_acls": {
"parameters": [
{
"$ref": "#/components/parameters/CommonConfigId"
}
],
"get": {
"operationId": "getCcSecTransferAclList",
"summary": "ゾーン転送ACLの一覧取得",
"description": "ゾーン転送ACLの設定の一覧を取得します。\n",
"tags": [
"cc_sec_transfer_acls"
],
"security": [
{
"DPFViewer": [
"dpf_read"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCcSecTransferAcls"
},
"examples": {
"GetCcSecTransferAcls": {
"$ref": "#/components/examples/GetCcSecTransferAcls"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
},
"post": {
"operationId": "postCcSecTransferAcl",
"summary": "ゾーン転送ACLの作成",
"description": "新しくゾーン転送ACLを作成します。\\\n作成できる最大件数は10件です。\n",
"tags": [
"cc_sec_transfer_acls"
],
"security": [
{
"DPFOperator": [
"dpf_write"
]
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostCcSecTransferAcl"
},
"examples": {
"PostCcSecTransferAcls": {
"$ref": "#/components/examples/PostCcSecTransferAcl"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncResponse"
},
"examples": {
"AsyncResponse": {
"$ref": "#/components/examples/AsyncResponse"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | tsig | 指定したTSIG鍵を確認してください\ninvalid | network | 指定したnetworkを確認してください\ntoo_many | network | 登録の上限数を超えています\nduplicated | network | 指定したnetworkを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
}
},
"/common_configs/{CommonConfigId}/cc_sec_transfer_acls/{CcSecTransferAclId}": {
"parameters": [
{
"$ref": "#/components/parameters/CommonConfigId"
},
{
"$ref": "#/components/parameters/CcSecTransferAclId"
}
],
"get": {
"operationId": "getCcSecTransferAcl",
"summary": "ゾーン転送ACLの取得",
"description": "指定したCcSecTransferAclIdのゾーン転送ACLを取得します。\n",
"tags": [
"cc_sec_transfer_acls"
],
"security": [
{
"DPFViewer": [
"dpf_read"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCcSecTransferAcl"
},
"examples": {
"GetCcSecTransferAcl": {
"$ref": "#/components/examples/GetCcSecTransferAcl"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | cc_sec_transfer_acl | 指定したCcSecTransferAclIdを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
},
"patch": {
"operationId": "patchCcSecTransferAcl",
"summary": "ゾーン転送ACLの更新",
"description": "指定したCcSecTransferAclIdのゾーン転送ACLを更新します。\n",
"tags": [
"cc_sec_transfer_acls"
],
"security": [
{
"DPFOperator": [
"dpf_write"
]
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchCcSecTransferAcl"
},
"examples": {
"PatchCcSecTransferAcl": {
"$ref": "#/components/examples/PatchCcSecTransferAcl"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncResponse"
},
"examples": {
"AsyncResponse": {
"$ref": "#/components/examples/AsyncResponse"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | cc_sec_transfer_acl | 指定したCcSecTransferAclIdを確認してください\nnot_found | tsig | 指定したTSIGを確認してください\ninvalid | network | 指定したnetworkを確認してください\nduplicated | network | 指定したnetworkを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
},
"delete": {
"operationId": "deleteCcSecTransferAcl",
"summary": "ゾーン転送ACLの削除",
"description": "指定したCcSecTransferAclIdのゾーン転送ACLを削除します。\n",
"tags": [
"cc_sec_transfer_acls"
],
"security": [
{
"DPFOperator": [
"dpf_write"
]
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncResponse"
},
"examples": {
"AsyncResponse": {
"$ref": "#/components/examples/AsyncResponse"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\nnot_found | cc_sec_transfer_acl | 指定したCcSecTransferAclIdを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
}
},
"/common_configs/{CommonConfigId}/cc_notice_accounts": {
"parameters": [
{
"$ref": "#/components/parameters/CommonConfigId"
}
],
"get": {
"operationId": "getCcNoticeAccountList",
"summary": "通知先アカウント設定の一覧取得",
"description": "通知先アカウントの設定の一覧を取得します。\n",
"tags": [
"cc_notice_accounts"
],
"security": [
{
"DPFViewer": [
"dpf_read"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCcNoticeAccounts"
},
"examples": {
"GetCcNoticeAccounts": {
"$ref": "#/components/examples/GetCcNoticeAccounts"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\ninvalid | schema | 指定したパラメータを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
},
"post": {
"operationId": "postCcNoticeAccount",
"summary": "通知先アカウント設定の作成",
"description": "新しく通知先アカウントを作成します。\n",
"tags": [
"cc_notice_accounts"
],
"security": [
{
"DPFOperator": [
"dpf_write"
]
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostCcNoticeAccount"
},
"examples": {
"PostCcNoticeAccounts": {
"$ref": "#/components/examples/PostCcNoticeAccount"
}
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncResponse"
},
"examples": {
"AsyncResponse": {
"$ref": "#/components/examples/AsyncResponse"
}
}
}
}
},
"400": {
"description": "Bad Request\n\n<details close>\n<summary>ErrorDetails</summary>\n\ncode | attribute | 対処方法\n-----|-----------|----------\nnot_found | common_config | 指定したCommonConfigIdを確認してください\nduplicated | resource_name | 指定したCcNoticeAccountResourceNameは既に登録されています\ninvalid_length | resource_name | 指定したCcNoticeAccountResourceNameの文字数を確認してください\ninvalid_format | resource_name | 指定したCcNoticeAccountResourceNameのフォーマットを確認してください\ntoo_many | name | 登録の上限数を超えています\ninvalid_format | name | 指定したアカウント名のフォーマットを確認してください\ninvalid_char_type | mail | 指定したメールアドレスの文字種を確認してください\ninvalid_format | mail | 指定したメールアドレスのフォーマットを確認してください\nrequired | country_code | 電話番号を指定する場合は国番号を指定する必要があります\nconflicted | country_code | 電話番号を指定していない場合は国番号を指定しないでください\ninvalid | schema | 指定したパラメータを確認してください\n\n</details>\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
},
"examples": {
"BadRequest": {
"$ref": "#/components/examples/BadRequest"
}
}
}
}
}
}
}
},
"/common_configs/{CommonConfigId}/cc_notice_accounts/{CcNoticeAccountResourceName}": {
"parameters": [
{
"$ref": "#/components/parameters/CommonConfigId"
},
{
"$ref": "#/components/parameters/CcNoticeAccountResourceName"
}
],
"get": {
"operationId": "getCcNoticeAccount",
"summary": "通知先アカウントの取得",
"description": "指定したCcNoticeAccountResourceNameの通知先アカウント設定を取得します。\n",
"tags": [
"cc_notice_accounts"
],
"security": [
{
"DPFViewer": [
"dpf_read"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {