Purgeリクエストの照会
- 印刷する
- PDF
Purgeリクエストの照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
概要
パージのリクエストの詳細情報を照会します。
リクエスト
リクエスト URL
GET
https://edge.apigw.ntruss.com/api/v1/purge/{purgeRequestId}
リクエストパラメータ
| パラメータ名 | 必須の有無 | タイプ | 制限事項 | 説明 |
|---|---|---|---|---|
| purgeRequestId | Yes | Long | パージリクエスト番号 |
レスポンス
すべてのレスポンスは、HTTP Status Codeで成功または失敗を返します。
| HTTPステータスコード | コードのメッセージ | 説明 |
|---|---|---|
| 200 | Success | 照会成功 |
| 401 | Unauthorized | 認証失敗 |
| 500 | Internal Server Error | サーバエラー |
PurgeHistory
| 項目 | タイプ | 説明 |
|---|---|---|
| clientIp | String | パージリクエスタ IPアドレス |
| purgeId | Long | パージリクエスト番号 |
| instanceNo | Long | エッジ契約番号 |
| requestDateTime | ZonedDateTime | パージリクエスト日時(UTC) |
| serviceDomain | String | パージ対象のドメイン |
| status | PurgeResult | パージの進捗状況 |
| targetDirectory | String | パージ対象のディレクトリリスト(コンマで区切って並べたもの) |
| targetFileList | List<String> | パージ対象リスト |
| targetFileListString | String | パージ対象リスト(コンマで区切って並べたもの) |
| purgeType | PurgeType | パージタイプ |
| workerType | WorkerType | パージリクエスタアカウントタイプ |
| ticketId | String | パージチケット ID |
PurgeResult
| 値 | 説明 |
|---|---|
| READY | パージ実行待機 |
| RUNNING | パージ実行中 |
| SUCCESS | 完了 |
| FAILURE | パージ失敗 |
PurgeType
| 値 | 説明 |
|---|---|
| ALL | すべてのコンテンツをパージ |
| DIRECTORY | ディレクトリ単位でパージ |
| PATTERN | 拡張子単位でコンテンツをパージ |
| URL | URLで指定したコンテンツをパージ |
WorkerType
| 値 | 説明 |
|---|---|
| ACCOUNT | メインアカウントでリクエスト |
| SUBACCOUNT | サブアカウントでリクエスト |
例
リクエスト例
https://edge.apigw.ntruss.com/api/v1/purge/9999
レスポンス例
{
"clientIp":"127.0.0.1",
"purgeId":9999,
"instanceNo":999999,
"requestDateTime":"2022-11-24T07:54:13Z",
"serviceDomain":"sample.mycustomdomain.com",
"status":"READY",
"purgeType":"ALL",
"workerType":"ACCOUNT",
"ticketId":"PT-00000000000000000000"
}
エラーコード
| Errorコード | 説明 |
|---|---|
| 0032 | 許可されていないリクエスト |
| 0400 | リクエストデータ形式が一致しない |
| 9999 | サーバエラー発生 |
この記事は役に立ちましたか?