パージのリクエスト

Prev Next

Classic/VPC環境で利用できます。

パージジョブを実行します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /api/v1/purge

リクエストヘッダ

Global Edge APIで共通して使用されるヘッダの詳細は、Global Edgeのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
edgeId Long Required エッジ ID
purgeType String Required パージタイプ
  • ALL | DIRECTORY | PATTERN | URL
    • ALL: すべてパージ
    • DIRECTORY: ディレクトリ単位パージ
    • PATTERN: ディレクトリとファイル拡張子単位パージ
    • URL: 個々のファイル単位パージ
purgeTarget Array Conditional パージ対象リスト
  • 選択したpurgeTypeに応じて入力
    • ALL: フィールドを省略
    • DIRECTORY: /で始まり、/\*で終わる
      • <例> /src/images/\*
    • PATTERN: /で始まり、*.abc拡張子で終わる
      • <例> /static/\*.png、/static/images/*.css
    • URL: /で始まり、ワイルドカード(*)は使用不可
      • <例> /src/css/main.css?version=2024
参考

エッジのサービス地域がグローバルな場合、パージのタイプによってジョブの所要時間が異なります。

  • ALL、DIRECTORY、PATTERN単位のパージジョブは約40分かかります。
  • URL単位のパージジョブはす素早く処理されます。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://edge.apigw.ntruss.com/api/v1/purge' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "edgeId": 11197,
    "purgeType": "DIRECTORY",
    "purgeTarget": [
        "/src/images/*",
        "/static/thumbs/*"
    ]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
message String - レスポンスメッセージ
result Array - パージリクエスト ID
  • パージ履歴照会時に必要

レスポンスステータスコード

Global Edge APIで共通して使用されるレスポンスステータスコードの詳細は、Global Edgeのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "code": "0000",
    "message": "Success",
    "result": [
        372****
    ]
}