パージ履歴の照会

Prev Next

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

パージジョブ履歴を照会します。

リクエスト

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

メソッド URI
GET /api/v1/purge/{purgeRequestId}

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
purgeRequestId Long Required パージリクエスト ID

リクエスト例

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

curl --location --request GET 'https://edge.apigw.ntruss.com/api/v1/purge/372****' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' 

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.clientIp String - パージリクエストクライアント IP
result.purgeId Long - パージリクエスト ID
result.instanceNo Long - エッジ契約番号
result.requestDateTime String - パージリクエスト日時(UTC)
result.serviceDomain String - エッジドメイン
result.status String - パージの進行状況
  • READY | RUNNING | SUCCESS | FAILURE
    • READY: 実行待ち
    • RUNNING: 実行中
    • SUCCESS: 完了
    • FAILURE: 失敗
result.targetDirectory String - パージ対象のディレクトリリスト
  • purgeTypeDIRECTORYの場合、表示
result.targetFileList Array - パージ対象リスト
  • purgeTypePATTERNまたはURLの場合、表示
result.targetFileListString String - パージ対象リスト
result.purgeType String - パージタイプ
  • ALL | DIRECTORY | PATTERN | URL
    • ALL: すべてパージ
    • DIRECTORY: ディレクトリ単位パージ
    • PATTERN: ディレクトリとファイル拡張子単位パージ
    • URL: 個々のファイル単位パージ
result.workerType String - パージリクエストアカウントタイプ
  • ACCOUNT | SUBACCOUNT
    • ACCOUNT: メインアカウント
    • SUBACCOUNT: サブアカウント
result.purgeRequestSource String - パージリクエストの出どころ
  • GLOBAL_EDGE_API | GLOBAL_EDGE
    • GLOBAL_EDGE_API: API
    • GLOBAL_EDGE: コンソール
result.ticketId String - チケット ID

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

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

レスポンス例

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

{
    "code": "0000",
    "message": "Success",
    "result": {
        "clientIp": "***.***.***.***",
        "purgeId": 372****,
        "instanceNo": 107***482,
        "requestDateTime": "2025-07-17T08:20:19.523Z",
        "serviceDomain": "jze**********.edge.naverncp.com",
        "status": "SUCCESS",
        "targetDirectory": "/src/images/*,/static/thumbs/*",
        "purgeType": "DIRECTORY",
        "workerType": "ACCOUNT",
        "purgeRequestSource": "GLOBAL_EDGE_API",
        "ticketId": "P-17527404195*********************t2wqisv5ffv1v"
    }
}