パージの実行

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

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

リクエスト

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

メソッド	URI
GET \| POST	/cdn/v2/requestGlobalCdnPurge

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`cdnInstanceNo`	String	Required	CDNインスタンス番号インスタンスの照会を参照
`isWholeDomain`	Boolean	Required	ドメイン全体対象のパージかどうか `true` \| `false` `true`: ドメイン全体 `false`: 指定したドメイン
`isWholePurge`	Boolean	Required	ファイル全体対象のパージかどうか `true` \| `false` `true`: ファイル全体 `false`: 指定したファイル
`serviceDomainNameList.N`	Array	Conditional	サービスドメインリスト `isWholeDomain`が`false`の場合、必ず入力 <例> `serviceDomainNameList.1=sample.example.com&serviceDomainNameList.2=test.example.com`
`targetFileList.N`	Array	Conditional	パージ対象リスト `isWholePurge`が`false`の場合、必ず入力 <例> `targetFileList.1=alice.txt&targetFileList.2=bob.png`
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/cdn/v2/requestGlobalCdnPurge?cdnInstanceNo=2851****&isWholeDomain=true
&isWholePurge=false&targetFileList.1=file.txt&targetFileList.2=compressed.zip&responseFormatType=json' \
--header 'Content-Type: application/json' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`requestGlobalCdnPurgeResponse`	Object	-	レスポンス結果
`requestGlobalCdnPurgeResponse.totalRows`	Integer	-	レスポンス結果数
`requestGlobalCdnPurgeResponse.globalCdnPurgeHistoryList`	Array	-	パージ履歴リスト
`requestGlobalCdnPurgeResponse.requestId`	String	-	リクエスト ID UUID形式
`requestGlobalCdnPurgeResponse.returnCode`	String	-	レスポンスコード
`requestGlobalCdnPurgeResponse.returnMessage`	String	-	レスポンスメッセージ

`globalCdnPurgeHistoryList`

globalCdnPurgeHistoryListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`cdnInstanceNo`	String	-	CDNインスタンス番号
`purgeId`	String	-	パージリクエスト ID
`isWholePurge`	Boolean	-	ファイル全体対象のパージかどうか `true` \| `false` `true`: ファイル全体 `false`: 指定したファイル
`isWholeDomain`	Boolean	-	ドメイン全体対象のパージかどうか `true` \| `false` `true`: ドメイン全体 `false`: 指定したドメイン
`globalCdnServiceDomainList`	Array	-	サービスドメインリスト: globalCdnServiceDomainList
`targetFileList`	Array	-	パージ対象リスト
`isSuccess`	Boolean	-	パージは成功したか `true` \| `false` `true`: 成功 `false`: 失敗

`globalCdnServiceDomainList`

globalCdnServiceDomainListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`serviceDomainTypeCode`	String	-	サービスドメインの区分 `DEFAULT` \| `USER` `DEFAULT`: NAVERクラウドプラットフォームが提供する CDNドメイン `USER`: ユーザー保有ドメイン
`protocolTypeCode`	String	-	サービスプロトコル
`defaultDomainName`	String	-	NAVERクラウドプラットフォームのドメイン名
`userDomainName`	String	-	ユーザードメイン名

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

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

レスポンス例

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

{
    "requestGlobalCdnPurgeResponse": {
        "totalRows": 1,
        "globalCdnPurgeHistoryList": [
            {
                "cdnInstanceNo": "2851****",
                "purgeId": "edup-Cgqm**************uM",
                "isWholePurge": false,
                "isWholeDomain": true,
                "globalCdnServiceDomainList": [
                    {
                        "serviceDomainTypeCode": "DEFAULT",
                        "protocolTypeCode": "HTTP",
                        "defaultDomainName": "wlrw*********.gcdn.ntruss.com",
                        "userDomainName": ""
                    }
                ],
                "targetFileList": [
                    "/file.txt",
                    "/compressed.zip"
                ],
                "isSuccess": true
            }
        ],
        "requestId": "8eb274f2-****-****-****-50e2d1930727",
        "returnCode": "0",
        "returnMessage": "success"
    }
}