インスタンスの照会

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

Global CDNインスタンスリストを照会します。

リクエスト

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

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

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`cdnInstanceNo`	String	Optional	CDNインスタンス番号
`pageNo`	Integer	Optional	ページ番号 0~2147483647
`pageSize`	Integer	Optional	ページごとの項目数 0~2147483647
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/cdn/v2/getGlobalCdnInstanceList?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}'

レスポンス

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

レスポンスボディ

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

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

`globalCdnInstanceList`

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

フィールド	タイプ	必須の有無	説明
`cdnInstanceNo`	String	-	CDNインスタンス ID
`cdnInstanceStatusName`	String	-	CDNインスタンスのステータス
`cdnInstanceDescription`	String	-	CDNインスタンスの説明
`serviceName`	String	-	サービス名
`isAvailablePartialDomainPurge`	Boolean	-	部分パージは可能か `true` \| `false` `true`: 可能 `false`: 不可能
`globalCdnServiceDomainList`	Array	-	サービスドメインリスト: globalCdnServiceDomainList
`globalCdnRule`	Object	-	CDNの設定
`globalCdnRule.protocolTypeCode`	String	-	サービスプロトコルタイプ
`globalCdnRule.serviceDomainTypeCode`	String	-	サービスドメインタイプ `DEFAULT` \| `USER` `DEFAULT`: NAVERクラウドプラットフォームが提供する CDNドメイン `USER`: ユーザー保有ドメイン
`globalCdnRule.originUrl`	String	-	オリジンの位置
`globalCdnRule.originPath`	String	-	オリジンの詳細パス
`globalCdnRule.originHttpPort`	Integer	-	オリジンの HTTPポート
`globalCdnRule.originHttpsPort`	Integer	-	オリジンの HTTPSポート
`globalCdnRule.forwardHostHeaderTypeCode`	String	-	ホストヘッダフォワードタイプ `REQUEST_HOST_HEADER` \| `ORIGIN_HOSTNAME` \| `CUSTOM` `REQUEST_HOST_HEADER`: クライアントから渡されたヘッダを使用 `ORIGIN_HOSTNAME`: 特定の値でヘッダを置き換え `CUSTOM`: ヘッダ値を指定
`globalCdnRule.forwardHostHeader`	String	-	ホストヘッダ値 `globalCdnRule.forwardHostHeaderTypeCode`が`CUSTOM`の場合、有効値を表示
`globalCdnRule.cacheKeyHostNameTypeCode`	String	-	キャッシュキーホスト名タイプ `REQUEST_HOST_HEADER` \| `ORIGIN_HOSTNAME` `REQUEST_HOST_HEADER`: キャッシュキーにサービスドメインを含める `ORIGIN_HOSTNAME`: キャッシュキーにオリジンサーバのホスト名を含める
`globalCdnRule.isGzipCompressionUse`	Boolean	-	Gzip圧縮転送を使用するか `true` \| `false` `true`: 使用 `false`: 使用しない使用するとレスポンス時間を短縮
`globalCdnRule.cachingOptionTypeCode`	String	-	キャッシュオプション
`globalCdnRule.isErrorContentsResponseUse`	Boolean	-	オリジン使用不可の場合、キャッシュされたエラーコンテンツを使用するか `true` \| `false` `true`: 使用 `false`: 使用しない
`globalCdnRule.cachingTtlTime`	Integer	-	キャッシュの最大保管期間(秒)
`globalCdnRule.isQueryStringIgnoreUse`	Boolean	-	クエリ文字列を無視するか `true` \| `false` `true`: 無視 `false`: 無視しない
`globalCdnRule.isRemoveVaryHeaderUse`	Boolean	-	Varyヘッダ削除を使用するか `true` \| `false` `true`: 使用 `false`: 使用しない使用する場合、オリジンサーバレスポンスの Accept-Encodingのほか、Varyヘッダを削除後にキャッシュ
`globalCdnRule.isLargeFileOptimizationUse`	Boolean	-	大容量ファイル転送を使用するか `true` \| `false` `true`: 使用 `false`: 使用しない使用すると、大容量ファイル転送のパフォーマンスと安定性が最適化
`globalCdnRule.gzipResponseTypeCode`	String	-	Gzip圧縮転送タイプ `ORIGIN_RESPONSE` \| `NEVER` \| `ALWAYS` `ORIGIN_RESPONSE`: オリジンの圧縮設定と同様に適用 `NEVER`: 使用しない `ALWAYS`: 使用
`globalCdnRule.isReferrerDomainUse`	Boolean	-	リファラドメインアクセス制御を使用するか `true` \| `false` `true`: 使用 `false`: 使用しないリクエストに特定のリファラドメインが含まれている場合にのみレスポンス
`globalCdnRule.referrerDomainList`	Array	-	許可リファラドメインリスト
`globalCdnRule.isReferrerDomainRestrictUse`	Boolean	-	リファラがない場合、アクセスをブロックするか `true` \| `false` `true`: ブロック `false`: 許可
`globalCdnRule.isSecureTokenUse`	Boolean	-	セキュリティトークンを使用するか `true` \| `false` `true`: 使用 `false`: 使用しないトークンでリクエストを認証してパスした場合にのみレスポンス
`globalCdnRule.secureTokenPassword`	String	-	トークンキー値
`globalCdnRule.isAccessLogUse`	Boolean	-	アクセスログを使用するか `true` \| `false` `true`: 使用 `false`: 使用しない
`globalCdnRule.isRequestCustomHeaderUse`	Boolean	-	リクエスト時に Customヘッダを使用するか `true` \| `false` `true`: 使用 `false`: 使用しない
`globalCdnRule.requestCustomHeaderList`	Array	-	Customヘッダリスト: globalCdnCustomHeader
`globalCdnRule.isResponseCustomHeaderUse`	Boolean	-	レスポンス時に Customヘッダを使用するか `true` \| `false` `true`: 使用 `false`: 使用しない
`globalCdnRule.responseCustomHeaderList`	Array	-	Customヘッダリスト: globalCdnCustomHeader

`globalCdnServiceDomainList`

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

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

`globalCdnCustomHeader`

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

フィールド	タイプ	必須の有無	説明
`headerTypeCode`	String	-	ヘッダタイプ `REQUEST` \| `RESPONSE` `REQUEST`: リクエストヘッダ `RESPONSE`: レスポンスヘッダ
`actionTypeCode`	String	-	アクションタイプ `ADD` \| `MODIFY` \| `REMOVE` `ADD`: 追加 `MODIFY`: 更新 `REMOVE`: 削除
`headerName`	String	-	ヘッダ名
`headerValue`	String	-	ヘッダ値

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

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

レスポンス例

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

{
    "getGlobalCdnInstanceListResponse": {
        "totalRows": 3,
        "globalCdnInstanceList": [
            {
                "cdnInstanceNo": "2851****",
                "cdnInstanceStatusName": "running",
                "cdnInstanceDescription": "",
                "serviceName": "cdn000",
                "isAvailablePartialDomainPurge": false,
                "globalCdnServiceDomainList": [
                    {
                        "serviceDomainTypeCode": "DEFAULT",
                        "protocolTypeCode": "HTTP",
                        "defaultDomainName": "fdhv**************.gcdn.ntruss.com",
                        "userDomainName": ""
                    }
                ],
                "globalCdnRule": {
                    "protocolTypeCode": "HTTP",
                    "serviceDomainTypeCode": "DEFAULT",
                    "originUrl": "data4c8f9378.kr.object.ncloudstorage.com",
                    "originPath": "/year%3D2023",
                    "originHttpPort": 80,
                    "originHttpsPort": 0,
                    "forwardHostHeaderTypeCode": "ORIGIN_HOSTNAME",
                    "forwardHostHeader": "",
                    "cacheKeyHostNameTypeCode": "REQUEST_HOST_HEADER",
                    "isGzipCompressionUse": true,
                    "cachingOptionTypeCode": "EXPIRES",
                    "isErrorContentsResponseUse": true,
                    "cachingTtlTime": 604800,
                    "isQueryStringIgnoreUse": true,
                    "isRemoveVaryHeaderUse": true,
                    "isLargeFileOptimizationUse": true,
                    "gzipResponseTypeCode": "ORIGIN_RESPONSE",
                    "isReferrerDomainUse": false,
                    "referrerDomainList": [],
                    "isReferrerDomainRestrictUse": false,
                    "isSecureTokenUse": true,
                    "secureTokenPassword": "fd5*************",
                    "isAccessLogUse": true,
                    "isRequestCustomHeaderUse": true,
                    "requestCustomHeaderList": [
                        {
                            "headerTypeCode": "REQUEST",
                            "actionTypeCode": "DELETE",
                            "headerName": "date",
                            "headerValue": ""
                        }
                    ],
                    "isResponseCustomHeaderUse": true,
                    "responseCustomHeaderList": [
                        {
                            "headerTypeCode": "RESPONSE",
                            "actionTypeCode": "ADD",
                            "headerName": "client",
                            "headerValue": "remote"
                        }
                    ]
                }
            },
            ...
        ],
        "requestId": "7c3662e4-****-****-****-0a15aa98a9a9",
        "returnCode": "0",
        "returnMessage": "success"
    }
}