パージ履歴の照会

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

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

リクエスト

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

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

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`cdnInstanceNo`	String	Required	CDNインスタンス番号インスタンスの照会を参照
`purgeIdList.N`	Array	Optional	パージ IDリスト <例> `purgeIdList.1=4adf60fe-9a78-11ea-ad28-53ed5947c29c&purgeIdList.2=53caca78-9a78-11ea-ac15-ad144c57b203`
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/cdn/v2/getGlobalCdnPurgeHistoryList?cdnInstanceNo=2851****&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`getGlobalCdnPurgeHistoryListResponse`	Object	-	レスポンス結果
`getGlobalCdnPurgeHistoryListResponse.totalRows`	Integer	-	レスポンス結果数
`getGlobalCdnPurgeHistoryListResponse.globalCdnPurgeHistoryList`	Array	-	パージ履歴リスト
`getGlobalCdnPurgeHistoryListResponse.requestId`	String	-	リクエスト ID UUID形式
`getGlobalCdnPurgeHistoryListResponse.returnCode`	String	-	レスポンスコード
`getGlobalCdnPurgeHistoryListResponse.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	-	パージ対象リスト
`estimatedCompletionDate`	String	-	予想完了日時 ISO 8601形式
`isSuccess`	Boolean	-	パージは成功したか `true` \| `false` `true`: 成功 `false`: 失敗
`requestDate`	String	-	リクエスト日時 ISO 8601形式

`globalCdnServiceDomainList`

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

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

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

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

レスポンス例

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

{
    "getGlobalCdnPurgeHistoryListResponse": {
        "totalRows": 1,
        "globalCdnPurgeHistoryList": [
            {
                "cdnInstanceNo": "2851****",
                "purgeId": "edup-CdBJv*********H2eSo",
                "isWholePurge": false,
                "isWholeDomain": true,
                "globalCdnServiceDomainList": [
                    {
                        "serviceDomainTypeCode": "DEFAULT",
                        "protocolTypeCode": "HTTP",
                        "defaultDomainName": "wlrw******.gcdn.ntruss.com",
                        "userDomainName": ""
                    }
                ],
                "targetFileList": [
                    "/sample.jpeg"
                ],
                "isSuccess": true
            }
        ],
        "requestId": "b8b0968a-****-****-****-b99fb7a49188",
        "returnCode": "0",
        "returnMessage": "success"
    }
}