エッジの照会

Prev Next

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

エッジの詳細情報を照会します。

リクエスト

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

メソッド URI
GET /api/v1/cdn-edge/{edgeId}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
edgeId Long Required エッジ ID

リクエスト例

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

curl --location --request GET 'https://edge.apigw.ntruss.com/api/v1/cdn-edges/123' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンスの結果

result

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

フィールド タイプ 必須の有無 説明
profileId Long - プロファイル ID
edgeName String - エッジ名
distributionConfig Object - デプロイ設定: CdnDistributionConfig
originalCopyConfig Object - オリジン設定: CdnOriginalCopyConfig
cachingConfig Object - キャッシュ設定: CdnCachingConfig
managedRule Object - マネージドルール: ManagedRule
headerPolicies Array - ヘッダ設定: HeaderPolicy
  • 設定しない場合、空の値[]を表示
optimizationConfig Object - 最適化設定: OptimizationConfig
accessControl Object - アクセス制御設定: AccessControl
productType String - サービス区分コード

CdnDistributionConfig

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

フィールド タイプ 必須の有無 説明
protocolType String - サービスプロトコル
regionType String - サービス地域
serviceDomain Object - サービスドメインを設定
serviceDomain.domainType String - サービスドメインタイプ
  • NCP_DOMAIN_AUTO | NCP_DOMAIN_CUSTOM | CUSTOM_DOMAIN
    • NCP_DOMAIN_AUTO: 自動作成された NAVERクラウドプラットフォームドメイン
    • NCP_DOMAIN_CUSTOM: ユーザー入力値を含む NAVERクラウドプラットフォームドメイン
    • CUSTOM_DOMAIN: ユーザー保有ドメイン
serviceDomain.domainName String - ドメイン名
serviceDomain.certificate Object - 証明書
  • ユーザー保有ドメイン(CUSTOM_DOMAIN)がHTTPSでサービスされている場合は、配下の情報を含めて表示
serviceDomain.certificate.id Number - 証明書スロット ID
edgeLogging Object - エッジログ設定
edgeLogging.enabled Boolean - 機能を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • trueの場合、関連情報を追加表示
edgeLogging.bucketPrefix String - ログ保存パス
edgeLogging.objectStorage Object - ログストレージ情報
  • Object Storageに登録されているバケット
edgeLogging.objectStorage.region String - サービスリージョン
edgeLogging.objectStorage.bucketName String - バケット名

CdnOriginalCopyConfig

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

フィールド タイプ 必須の有無 説明
originalCopyLocation Object - オリジンサーバ設定
originalCopyLocation.type String - オリジンタイプ
  • OBJECT_STORAGE | LOAD_BALANCER | API_GATEWAY | CUSTOM
    • OBJECT_STORAGE: NAVERクラウドプラットフォームの Object Storage
    • LOAD_BALANCER: NAVERクラウドプラットフォームの Load Balancer
    • API_GATEWAY: NAVERクラウドプラットフォームの API Gateway
    • CUSTOM: 外部オリジンドメイン
originalCopyLocation.region String - サービスリージョン
  • originalCopyLocation.typeOBJECT_STORAGEまたはLOAD_BALANCERの場合、表示
originalCopyLocation.bucketName String - バケット名
  • originalCopyLocation.typeOBJECT_STORAGEの場合、表示
originalCopyLocation.customLocation String - オリジンドメイン名
  • originalCopyLocation.typeLOAD_BALANCERAPI_GATEWAYCUSTOMの場合、表示
forwardHostHeader Object - ホストヘッダのフォワード設定
forwardHostHeader.type String - フォワードタイプ
  • INCOMING_HOST_HEADER | ORIGIN_HOSTNAME | CUSTOM
    • INCOMING_HOST_HEADER: クライアントから渡されたヘッダを使用
    • ORIGIN_HOSTNAME: 特定の値にヘッダを置き換え
    • CUSTOM: ヘッダ値を指定
forwardHostHeader.customHostHeader String - ホストヘッダ値
  • forwardHostHeader.typeCUSTOMの場合、表示
originalCopyProtocol Object - オリジンプロトコルの設定
originalCopyProtocol.type String - プロトコルタイプ
  • HTTP | HTTPS
originalCopyProtocol.port Integer - ポート番号
originalCopyPath String - オリジンのパス
originFailoverConfig Object - オリジンフェイルオーバー設定
originFailoverConfig.ruleName String - フェイルオーバールール名
originFailoverConfig.statusCodes Array - オリジンレスポンスコードリスト
originFailoverConfig.originalCopyLocation Object - リクエストをフォワードするバックアップオリジンサーバ情報
originFailoverConfig.originalCopyLocation.type String - バックアップオリジンのタイプ
  • OBJECT_STORAGE | CUSTOM
    • OBJECT_STORAGE: Object Storage
    • CUSTOM: 外部ドメイン
originFailoverConfig.originalCopyLocation.region String - サービスリージョン
  • originFailoverConfig.originalCopyLocation.typeOBJECT_STORAGEの場合、表示
originFailoverConfig.originalCopyLocation.bucketName String - バケット名
  • originFailoverConfig.originalCopyLocation.typeOBJECT_STORAGEの場合、表示
originFailoverConfig.originalCopyLocation.customLocation String - ドメイン名
  • originFailoverConfig.originalCopyLocation.typeCUSTOMの場合、表示

CdnCachingConfig

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

フィールド タイプ 必須の有無 説明
defaultCaching Object - キャッシュのデフォルト設定
defaultCaching.enabled Boolean - 機能を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • trueの場合、関連情報を追加表示
defaultCaching.ruleDefinitionType String - キャッシュオプション
  • CACHING | BYPASS_CACHE | ORIGIN_CACHE_CONTROL_HEADER
    • CACHING: キャッシュ
    • BYPASS_CACHE: オリジンサーバにバイパス
    • ORIGIN_CACHE_CONTROL_HEADER: オリジン Cache-Controlヘッダで処理
defaultCaching.cacheRevalidateConfig Object - 古いオブジェクトの再検証設定
  • キャッシュが期限切れになり、オリジンを使用できない場合の動作を指定
defaultCaching.cacheRevalidateConfig.type String - 再検証のタイプ
  • IF_POSSIBLE | ALWAYS
    • IF_POSSIBLE: 確認できない場合、古いオブジェクトサービスを提供
    • ALWAYS: オリジンを常に検証
defaultCaching.cacheRevalidateConfig.ageType String - キャッシュ最大保管期間の単位
defaultCaching.cacheRevalidateConfig.age Integer - キャッシュの最大保管期間
negativeTtl Boolean - ネガティブ TTLを使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • オリジンサーバからエラーレスポンスを返す際にレスポンスをキャッシュ
bypassQueryString Object - バイパスクエリ文字列の設定
  • キャッシュなしでオリジンサーバにバイパスする条件文字列を指定
bypassQueryString.enabled Boolean - 機能を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • trueの場合、関連情報を追加表示
bypassQueryString.queryStrings Array - 対象の文字列リスト
cacheKeyHostname String - キャッシュキーホスト名タイプ
  • INCOMING_HOST_HEADER | ORIGIN_HOSTNAME
    • INCOMING_HOST_HEADER: キャッシュキーにサービスドメインを含める
    • ORIGIN_HOSTNAME: キャッシュキーにオリジンサーバのホスト名を含める
cacheKeyIgnoreQueryString Object - キャッシュキークエリ文字列の設定
  • キャッシュキー作成時にクエリ文字列を含めるか/無視するかを指定
cacheKeyIgnoreQueryString.type String - 設定のタイプ
  • ALL_IGNORED | ALL_ALLOWED | ALLOW_SPECIFIC_STRING
    • ALL_IGNORED: すべて無視
    • ALL_ALLOWED: すべて許可
    • ALLOW_SPECIFIC_STRING: 特定の文字列を許可
cacheKeyIgnoreQueryString.queryStrings Array - 対象の文字列リスト
  • cacheKeyIgnoreQueryString.typeALLOW_SPECIFIC_STRINGの場合、表示
urlLetterCaseIgnoreUse Boolean - キャッシュキーの大文字・小文字区別を無視するか
  • true | false
    • true: 無視
    • false: 無視しない
  • オリジンが大文字・小文字を区別しない場合、URLとファイル名の大文字・小文字を無視してキャッシュ可能
removeVaryHeader Boolean - Varyヘッダ削除を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • 使用する場合、オリジンサーバレスポンスの Accept-Encodingのほか、Varyヘッダを削除後にキャッシュ
edgeAuth Object - リクエスト認証の設定
  • トークンでリクエストを認証してパスした場合にのみレスポンス
edgeAuth.enabled Boolean - 機能を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • trueの場合、関連情報を追加表示
edgeAuth.type String - 認証タイプ
  • SIGNED_URL | JWT | MEDIA_VAULT
    • SIGNED_URL: URLに認証情報を含める
    • JWT: JSONトークンを生成して HTTPヘッダに含める
    • MEDIA_VAULT: URLに認証情報を含める
edgeAuth.tokenName String - トークン名
edgeAuth.tokenKey String - トークンキー値
edgeAuth.bypassValues Array - 認証除外拡張子リスト
edgeAuth.tokenBypassValues Array - 認証値をオリジンに渡す拡張子リスト
cachingRules Array - キャッシュ詳細ルールの設定: CachingRule
  • ルールが存在する場合は配下の情報を含めて表示

CachingRule

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

フィールド タイプ 必須の有無 説明
ruleName String - キャッシュの詳細ルール名
ruleType String - ルール条件タイプ
  • DIRECTORY | FILE_EXTENSION | ADVANCED
    • DIRECTORY: ディレクトリ
    • FILE_EXTENSION: ファイル拡張子
    • ADVANCED: ディレクトリとファイル拡張子
ruleConditions Array - ルール条件リスト
ruleDefinitionType String - キャッシュオプション
  • CACHING | BYPASS_CACHE | ORIGIN_CACHE_CONTROL_HEADER
    • CACHING: キャッシュ
    • BYPASS_CACHE: オリジンサーバにバイパス
    • ORIGIN_CACHE_CONTROL_HEADER: オリジン Cache-Controlヘッダで処理
cacheRevalidateConfig Object - 古いオブジェクトの再検証設定
  • キャッシュが期限切れになり、オリジンを使用できない場合の動作を指定
cacheRevalidateConfig.type String - 再検証のタイプ
  • IF_POSSIBLE | ALWAYS
    • IF_POSSIBLE: 確認できない場合、古いオブジェクトサービスを提供
    • ALWAYS: オリジンを常に検証
cacheRevalidateConfig.ageType String - キャッシュ最大保管期間の単位
cacheRevalidateConfig.age String - キャッシュの最大保管期間
ruleBasedRoutingConfig Object - ルールベースのオリジンルーティング設定
  • ルール条件を満たすと、指定した場所にオリジンをルーティング
ruleBasedRoutingConfig.enabled Boolean - 機能を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • trueの場合、関連情報を追加表示
ruleBasedRoutingConfig.originalCopyLocation Object - オリジンサーバ設定
ruleBasedRoutingConfig.originalCopyLocation.type String - オリジンタイプ
  • OBJECT_STORAGE | CUSTOM
    • OBJECT_STORAGE: Object Storage
    • CUSTOM: 外部ドメイン
ruleBasedRoutingConfig.originalCopyLocation.region String - サービスリージョン
  • ruleBasedRoutingConfig.originalCopyLocation.typeOBJECT_STORAGEの場合、表示
ruleBasedRoutingConfig.originalCopyLocation.bucketName String - バケット名
  • ruleBasedRoutingConfig.originalCopyLocation.typeOBJECT_STORAGEの場合、表示
ruleBasedRoutingConfig.originalCopyLocation.customLocation String - ドメイン名
  • ruleBasedRoutingConfig.originalCopyLocation.typeCUSTOMの場合、表示
browserCache Object - ブラウザキャッシュの設定
  • エッジからクライアントに送信するキャッシュ動作を指定
browserCache.enabled Boolean - 機能を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • trueの場合、関連情報を追加表示
browserCache.type String - ブラウザのキャッシュを許可するか
  • ALLOW_CACHE | NO_CACHE
    • ALLOW_CACHE: キャッシュを許可
    • NO_CACHE: キャッシュを許可しない
browserCache.ageType String - キャッシュ最大保管期間の単位
browserCache.age Integer - キャッシュの最大保管期間
cacheKeyQueryParameter Object - キャッシュキークエリパラメータ設定
  • キャッシュキー作成時にクエリ文字列を含める/無視するかを指定
cacheKeyQueryParameter.enabled Boolean - 機能を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • trueの場合、関連情報を追加表示
cacheKeyQueryParameter.type String - 設定タイプ
  • ALL_IGNORED | ALL_ALLOWED | IGNORE_SPECIFIC_STRING | ALLOW_SPECIFIC_STRING
    • ALL_IGNORED: すべて無視
    • ALL_ALLOWED: すべて許可
    • IGNORE_SPECIFIC_STRING: 特定の文字列を無視
    • ALLOW_SPECIFIC_STRING: 特定の文字列を許可
cacheKeyQueryParameter.queryParameters Array - 対象の文字列リスト
  • cacheKeyQueryParameter.typeALLOW_SPECIFIC_STRINGまたはIGNORE_SPECIFIC_STRINGの場合、表示
accessDeny Boolean - ルール条件(ruleConditions)へのアクセスをブロックするか
  • true | false
    • true: ブロック
    • false: ブロックしない
urlRedirect Object - URLリダイレクト設定
  • ルール条件を満たすと、オリジンサーバではなくリダイレクトでレスポンス
urlRedirect.enabled Boolean - 機能を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • trueの場合、関連情報を追加表示
urlRedirect.destinationProtocol String - リダイレクト目的地プロトコル
  • HTTP | HTTPS
urlRedirect.destinationHostname String - リダイレクト目的地ホスト
urlRedirect.destinationPath String - リダイレクト目的地の詳細パス
urlRedirect.responseCode String - リダイレクトの状態コード
  • MOVED_PERMANENTLY_301 | FOUND_302
    • MOVED_PERMANENTLY_301: 永久的 URL移動
    • FOUND_302: 一時的 URL移動
urlRewrite Object - URLリライト設定
  • ルール条件を満たすと、リクエストの URLを自動変更
urlRewrite.enabled Boolean - 機能を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • trueの場合、関連情報を追加表示
urlRewrite.rewriteTarget String - 目的地の詳細パス

ManagedRule

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

フィールド タイプ 必須の有無 説明
cors Boolean - CORSヘッダ(オリジン間リソース共有ヘッダ)を追加するか
  • true | false
    • true: 追加
    • false: 追加しない
corsPolicy Object Conditional CORSヘッダ(オリジン間リソース共有ヘッダ)の詳細設定
corsPolicy.allowOrigin String Required Access-Control-Allow-Origin設定
  • Access-Control-Allow-Origin: *と Access-Control-Allow-Credentials: trueは同時設定不可
corsPolicy.allowMethods Array Conditional Access-Control-Allow-Methods設定
  • GET | POST | OPTIONS
  • 設定しない場合、空の値[]を入力
corsPolicy.allowHeaders Array Conditional Access-Control-Allow-Headers設定
  • 設定しない場合、空の値[]を入力
corsPolicy.allowCredentials Boolean Conditional Access-Control-Allow-Credentials設定
  • true | false
  • Access-Control-Allow-Origin: *と Access-Control-Allow-Credentials: trueは同時設定不可
corsPolicy.useMaxAge Boolean Conditional Access-Control-Max-Age設定
  • true | false
    • true: 86400
    • false: 使用しない
http2 Boolean - HTTP/2(オープンネットワークプロトコル)を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
trueClientIpHeader Boolean - オリジンサーバへのリクエストフォワード時にヘッダにクライアント IPアドレスヘッダを追加するか
  • true | false
    • true: 追加
    • false: 追加しない
hsts Boolean - ブラウザアクセスに HTTPSを使用するか
  • true | false
    • true: 使用
    • false: 使用しない

HeaderPolicy

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

フィールド タイプ 必須の有無 説明
type String - ヘッダタイプ
  • ORIGIN_REQUEST | CLIENT_RESPONSE
    • ORIGIN_REQUEST: オリジンサーバにフォワードされるリクエストヘッダ
    • CLIENT_RESPONSE: サーバからクライアントに送信されるレスポンスヘッダ
ruleName String - ヘッダ設定名
header Object - ヘッダの詳細設定
header.type String - アクションタイプ
  • ADD | MODIFY | REMOVE
    • ADD: 追加
    • MODIFY: 更新
    • REMOVE: 削除
header.name String - ヘッダ名
header.value String - ヘッダ値
  • header.typeADDまたはMODIFYの場合、表示

OptimizationConfig

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

フィールド タイプ 必須の有無 説明
httpCompression Boolean - Gzip、Brotli圧縮転送を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • 使用するとレスポンスタイムを短縮
largeFileOptimization Boolean - 大容量ファイル転送を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • 使用すると、大容量ファイル転送のパフォーマンスと安定性が最適化
headerMaxSize Object Conditional Request Header Size設定
headerMaxSize.singleSize String Required 単一 Header Size設定
  • SIZE_8KB | SIZE_16KB | SIZE_32KB
    • SIZE_8KB: 8192
    • SIZE_16KB: 16384
    • SIZE_32KB: 32768
headerMaxSize.totalSize String Required 全 Header Size設定
  • SIZE_8KB | SIZE_16KB | SIZE_32KB
    • SIZE_8KB: 8192
    • SIZE_16KB: 16384
    • SIZE_32KB: 32768

AccessControl

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

フィールド タイプ 必須の有無 説明
type String - アクセス制御タイプ
  • WHITELIST | BLACKLIST
    • WHITELIST: ホワイトリスト
    • BLACKLIST: ブラックリスト
ipPolicies Array - クライアント IPアドレスまたは CIDRブロック
  • IPアドレス形式
  • 設定しない場合、空の値[]を表示
geoPolicies Array - クライアント国コード
  • ISO 3166-1 alpha-2国コード基準
  • 設定しない場合、空の値[]を表示
refererPolicies Array - HTTPリクエストリファラヘッダ
  • ドメイン形式
  • 設定しない場合、空の値[]を表示

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

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

レスポンス例

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

{
    "code": "0000",
    "message": "Success",
    "result": {
        "profileId": 4207,
        "edgeName": "edge2",
        "distributionConfig": {
            "protocolType": "HTTP",
            "regionType": "KOREA",
            "serviceDomain": {
                "domainType": "NCP_DOMAIN_AUTO",
                "domainName": "jze******.edge.naverncp.com"
            },
            "edgeLogging": {
                "enabled": false
            }
        },
        "originalCopyConfig": {
            "originalCopyLocation": {
                "type": "LOAD_BALANCER",
                "region": "KR",
                "customLocation": "LB-********.kr.lb.naverncp.com"
            },
            "forwardHostHeader": {
                "type": "INCOMING_HOST_HEADER",
                "customHostHeader": ""
            },
            "originalCopyProtocol": {
                "type": "HTTP",
                "port": 80
            },
            "originalCopyPath": ""
        },
        "cachingConfig": {
            "defaultCaching": {
                "enabled": true,
                "ruleDefinitionType": "CACHING",
                "cacheRevalidateConfig": {
                    "type": "ALWAYS",
                    "ageType": "DAYS",
                    "age": 30
                }
            },
            "negativeTtl": true,
            "bypassQueryString": {
                "enabled": false
            },
            "cacheKeyHostname": "INCOMING_HOST_HEADER",
            "cacheKeyIgnoreQueryString": {
                "type": "ALL_IGNORED"
            },
            "urlLetterCaseIgnoreUse": false,
            "removeVaryHeader": true,
            "edgeAuth": {
                "enabled": false
            },
            "cachingRules": [
                {
                    "ruleName": "cachedetailrule",
                    "ruleType": "DIRECTORY",
                    "ruleConditions": [
                        "/dir/*"
                    ],
                    "ruleDefinitionType": "CACHING",
                    "cacheRevalidateConfig": {
                        "type": "IF_POSSIBLE",
                        "ageType": "DAYS",
                        "age": 30
                    },
                    "ruleBasedRoutingConfig": {
                        "enabled": true,
                        "originalCopyLocation": {
                            "type": "CUSTOM",
                            "customLocation": "admin.example.com"
                        }
                    },
                    "browserCache": {
                        "enabled": true,
                        "type": "ALLOW_CACHE",
                        "ageType": "MINUTES",
                        "age": 1
                    },
                    "cacheKeyQueryParameter": {
                        "enabled": true,
                        "type": "IGNORE_SPECIFIC_STRING",
                        "queryParameters": [
                            "param"
                        ]
                    },
                    "accessDeny": true,
                    "urlRedirect": {
                        "enabled": true,
                        "destinationProtocol": "HTTP",
                        "destinationHostname": "host.com",
                        "destinationPath": "/directory",
                        "responseCode": "FOUND_302"
                    },
                    "urlRewrite": {
                        "enabled": false
                    }
                }
            ]
        },
        "managedRule": {
            "cors": false,
            "corsPolicy": {
                "allowOrigin": "*",
                "allowMethods": [
                    "GET",
                    "POST",
                    "OPTIONS"
                ],
                "allowHeaders": [
                    "origin"
                ],
                "allowCredentials": false,
                "useMaxAge": true
            },
            "http2": false,
            "trueClientIpHeader": false,
            "hsts": false
        },
        "headerPolicies": [],
        "optimizationConfig": {
            "httpCompression": true,
            "largeFileOptimization": true,
            "headerMaxSize": {
                "singleSize": "SIZE_16KB",
                "totalSize": "SIZE_32KB"
            }
        },
        "accessControl": {
            "type": "WHITELIST",
            "ipPolicies": [
                "1**.***.***.**0"
            ],
            "geoPolicies": [
                "AF",
                "AL"
            ],
            "refererPolicies": [
                "*.test.com"
            ]
        },
        "productType": "GLOBAL_EDGE"
    }
}