API一覧
API一覧
CAC-APIでは以下のAPIが利用できます。
| HTTPメソッド | API名 | 目的 |
|---|---|---|
| GET | contract | 契約情報一覧取得 |
| GET | origin | オリジンサーバー情報取得 |
| PUT | origin | オリジンサーバー情報変更 |
| GET | cache_setting | キャッシュ設定情報取得 |
| PUT | cache_setting | キャッシュ設定 |
| GET | purgejob | キャッシュ削除ジョブステータス取得(一覧) |
| GET | purgejob | キャッシュ削除ジョブステータス取得(JobID指定) |
| POST | purgejob | キャッシュ削除ジョブ登録 |
| POST | accesslog_key | アクセスログダウンロード用URL発行 |
| GET | range_purgejob(一覧) | 範囲指定キャッシュ削除ジョブステータス取得（一覧) |
| GET | range_purgejob (JobID指定) | 範囲指定キャッシュ削除ジョブステータス取得(JobID指定) |
| POST | range_purgejob | 範囲指定キャッシュ削除ジョブ登録 |
| GET | acls_setting | ACL設定情報取得 |
| PUT | acls_setting | ACL設定情報変更 |
| GET | bypass_setting | キャッシュバイパス設定情報取得 |
| PUT | bypass_setting | キャッシュバイパス設定情報変更 |
| GET | ipv6_setting | IPv6設定情報取得 |
| PUT | ipv6_setting | IPv6設定情報変更 |
| GET | redirect_setting | HTTPリダイレクト設定情報取得 |
| PUT | redirect_setting | HTTPリダイレクト設定情報変更 |
APIバージョン
CAC-APIで提供するAPI群にはバージョンが設定されています。バージョンによって一部のパラメータや、挙動が変化する場合があります
APIをリクエストする際に、APIVersionパラメータを指定することで、どのバージョンのAPIを実行するかを指定することができます。
現在指定可能なAPIVersionは以下の通りです。
| APIVersion | 利用開始日 | 利用終了日 | 備考 |
|---|---|---|---|
| 20140602 | 2014年6月3日 | 未定 | 初期リリース版 |
API詳細における凡例 (レスポンス)
各API一覧ページでは、レスポンスの説明に以下のような表記を使用します。
JSON表記
{ |
"SampleApiResponse": { |
"Param1": "abcdefg", |
"Param2": { |
"ParamA": "pqr", |
"ParamB": "xyz" |
}, |
"Param3": [ |
{ |
"ParamC": "123" |
}, |
{ |
"ParamC": "987" |
} |
] |
} |
} |
| フィールド | タイプ | 意味 |
|---|---|---|
SampleApiResponse.Param1 |
String |
単純な値 |
SampleApiResponse.Param2 |
Object |
内部に複数の値を含む連想配列 |
SampleApiResponse.Param2.ParamA |
String |
構造体に含まれる単純な値 |
SampleApiResponse.Param2.ParamB |
String |
構造体に含まれる単純な値 |
SampleApiResponse.Param3 |
Array |
内部に複数の値を含む単純配列 |
SampleApiResponse.Param3.ParamC |
String |
配列に含まれる単純な値 |
- 構造化されたフィールドのキーは、表中ではそれぞれのキーを"."(ドット)で連結して現します
- CAC-APIでは値に型はありません。すべて文字列として取り扱います。