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 | - | サービスドメインタイプ
|
serviceDomain.domainName |
String | - | ドメイン名 |
serviceDomain.certificate |
Object | - | 証明書
|
serviceDomain.certificate.id |
Number | - | 証明書スロット ID |
edgeLogging |
Object | - | エッジログ設定 |
edgeLogging.enabled |
Boolean | - | 機能を使用するか
|
edgeLogging.bucketPrefix |
String | - | ログ保存パス |
edgeLogging.objectStorage |
Object | - | ログストレージ情報
|
edgeLogging.objectStorage.region |
String | - | サービスリージョン |
edgeLogging.objectStorage.bucketName |
String | - | バケット名 |
CdnOriginalCopyConfig
CdnOriginalCopyConfigの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
originalCopyLocation |
Object | - | オリジンサーバ設定 |
originalCopyLocation.type |
String | - | オリジンタイプ
|
originalCopyLocation.region |
String | - | サービスリージョン
|
originalCopyLocation.bucketName |
String | - | バケット名
|
originalCopyLocation.customLocation |
String | - | オリジンドメイン名
|
forwardHostHeader |
Object | - | ホストヘッダのフォワード設定 |
forwardHostHeader.type |
String | - | フォワードタイプ
|
forwardHostHeader.customHostHeader |
String | - | ホストヘッダ値
|
originalCopyProtocol |
Object | - | オリジンプロトコルの設定 |
originalCopyProtocol.type |
String | - | プロトコルタイプ
|
originalCopyProtocol.port |
Integer | - | ポート番号 |
originalCopyPath |
String | - | オリジンのパス |
originFailoverConfig |
Object | - | オリジンフェイルオーバー設定 |
originFailoverConfig.ruleName |
String | - | フェイルオーバールール名 |
originFailoverConfig.statusCodes |
Array | - | オリジンレスポンスコードリスト |
originFailoverConfig.originalCopyLocation |
Object | - | リクエストをフォワードするバックアップオリジンサーバ情報 |
originFailoverConfig.originalCopyLocation.type |
String | - | バックアップオリジンのタイプ
|
originFailoverConfig.originalCopyLocation.region |
String | - | サービスリージョン
|
originFailoverConfig.originalCopyLocation.bucketName |
String | - | バケット名
|
originFailoverConfig.originalCopyLocation.customLocation |
String | - | ドメイン名
|
CdnCachingConfig
CdnCachingConfigの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
defaultCaching |
Object | - | キャッシュのデフォルト設定 |
defaultCaching.enabled |
Boolean | - | 機能を使用するか
|
defaultCaching.ruleDefinitionType |
String | - | キャッシュオプション
|
defaultCaching.cacheRevalidateConfig |
Object | - | 古いオブジェクトの再検証設定
|
defaultCaching.cacheRevalidateConfig.type |
String | - | 再検証のタイプ
|
defaultCaching.cacheRevalidateConfig.ageType |
String | - | キャッシュ最大保管期間の単位 |
defaultCaching.cacheRevalidateConfig.age |
Integer | - | キャッシュの最大保管期間 |
negativeTtl |
Boolean | - | ネガティブ TTLを使用するか
|
bypassQueryString |
Object | - | バイパスクエリ文字列の設定
|
bypassQueryString.enabled |
Boolean | - | 機能を使用するか
|
bypassQueryString.queryStrings |
Array | - | 対象の文字列リスト |
cacheKeyHostname |
String | - | キャッシュキーホスト名タイプ
|
cacheKeyIgnoreQueryString |
Object | - | キャッシュキークエリ文字列の設定
|
cacheKeyIgnoreQueryString.type |
String | - | 設定のタイプ
|
cacheKeyIgnoreQueryString.queryStrings |
Array | - | 対象の文字列リスト
|
urlLetterCaseIgnoreUse |
Boolean | - | キャッシュキーの大文字・小文字区別を無視するか
|
removeVaryHeader |
Boolean | - | Varyヘッダ削除を使用するか
|
edgeAuth |
Object | - | リクエスト認証の設定
|
edgeAuth.enabled |
Boolean | - | 機能を使用するか
|
edgeAuth.type |
String | - | 認証タイプ
|
edgeAuth.tokenName |
String | - | トークン名 |
edgeAuth.tokenKey |
String | - | トークンキー値 |
edgeAuth.bypassValues |
Array | - | 認証除外拡張子リスト |
edgeAuth.tokenBypassValues |
Array | - | 認証値をオリジンに渡す拡張子リスト |
cachingRules |
Array | - | キャッシュ詳細ルールの設定: CachingRule
|
CachingRule
CachingRuleの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
ruleName |
String | - | キャッシュの詳細ルール名 |
ruleType |
String | - | ルール条件タイプ
|
ruleConditions |
Array | - | ルール条件リスト |
ruleDefinitionType |
String | - | キャッシュオプション
|
cacheRevalidateConfig |
Object | - | 古いオブジェクトの再検証設定
|
cacheRevalidateConfig.type |
String | - | 再検証のタイプ
|
cacheRevalidateConfig.ageType |
String | - | キャッシュ最大保管期間の単位 |
cacheRevalidateConfig.age |
String | - | キャッシュの最大保管期間 |
ruleBasedRoutingConfig |
Object | - | ルールベースのオリジンルーティング設定
|
ruleBasedRoutingConfig.enabled |
Boolean | - | 機能を使用するか
|
ruleBasedRoutingConfig.originalCopyLocation |
Object | - | オリジンサーバ設定 |
ruleBasedRoutingConfig.originalCopyLocation.type |
String | - | オリジンタイプ
|
ruleBasedRoutingConfig.originalCopyLocation.region |
String | - | サービスリージョン
|
ruleBasedRoutingConfig.originalCopyLocation.bucketName |
String | - | バケット名
|
ruleBasedRoutingConfig.originalCopyLocation.customLocation |
String | - | ドメイン名
|
browserCache |
Object | - | ブラウザキャッシュの設定
|
browserCache.enabled |
Boolean | - | 機能を使用するか
|
browserCache.type |
String | - | ブラウザのキャッシュを許可するか
|
browserCache.ageType |
String | - | キャッシュ最大保管期間の単位 |
browserCache.age |
Integer | - | キャッシュの最大保管期間 |
cacheKeyQueryParameter |
Object | - | キャッシュキークエリパラメータ設定
|
cacheKeyQueryParameter.enabled |
Boolean | - | 機能を使用するか
|
cacheKeyQueryParameter.type |
String | - | 設定タイプ
|
cacheKeyQueryParameter.queryParameters |
Array | - | 対象の文字列リスト
|
accessDeny |
Boolean | - | ルール条件(ruleConditions)へのアクセスをブロックするか
|
urlRedirect |
Object | - | URLリダイレクト設定
|
urlRedirect.enabled |
Boolean | - | 機能を使用するか
|
urlRedirect.destinationProtocol |
String | - | リダイレクト目的地プロトコル
|
urlRedirect.destinationHostname |
String | - | リダイレクト目的地ホスト |
urlRedirect.destinationPath |
String | - | リダイレクト目的地の詳細パス |
urlRedirect.responseCode |
String | - | リダイレクトの状態コード
|
urlRewrite |
Object | - | URLリライト設定
|
urlRewrite.enabled |
Boolean | - | 機能を使用するか
|
urlRewrite.rewriteTarget |
String | - | 目的地の詳細パス |
ManagedRule
ManagedRuleの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
cors |
Boolean | - | CORSヘッダ(オリジン間リソース共有ヘッダ)を追加するか
|
corsPolicy |
Object | Conditional | CORSヘッダ(オリジン間リソース共有ヘッダ)の詳細設定 |
corsPolicy.allowOrigin |
String | Required | Access-Control-Allow-Origin設定
|
corsPolicy.allowMethods |
Array | Conditional | Access-Control-Allow-Methods設定
|
corsPolicy.allowHeaders |
Array | Conditional | Access-Control-Allow-Headers設定
|
corsPolicy.allowCredentials |
Boolean | Conditional | Access-Control-Allow-Credentials設定
|
corsPolicy.useMaxAge |
Boolean | Conditional | Access-Control-Max-Age設定
|
http2 |
Boolean | - | HTTP/2(オープンネットワークプロトコル)を使用するか
|
trueClientIpHeader |
Boolean | - | オリジンサーバへのリクエストフォワード時にヘッダにクライアント IPアドレスヘッダを追加するか
|
hsts |
Boolean | - | ブラウザアクセスに HTTPSを使用するか
|
HeaderPolicy
HeaderPolicyの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
String | - | ヘッダタイプ
|
ruleName |
String | - | ヘッダ設定名 |
header |
Object | - | ヘッダの詳細設定 |
header.type |
String | - | アクションタイプ
|
header.name |
String | - | ヘッダ名 |
header.value |
String | - | ヘッダ値
|
OptimizationConfig
OptimizationConfigの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
httpCompression |
Boolean | - | Gzip、Brotli圧縮転送を使用するか
|
largeFileOptimization |
Boolean | - | 大容量ファイル転送を使用するか
|
headerMaxSize |
Object | Conditional | Request Header Size設定 |
headerMaxSize.singleSize |
String | Required | 単一 Header Size設定
|
headerMaxSize.totalSize |
String | Required | 全 Header Size設定
|
AccessControl
AccessControlの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
String | - | アクセス制御タイプ
|
ipPolicies |
Array | - | クライアント IPアドレスまたは CIDRブロック
|
geoPolicies |
Array | - | クライアント国コード
|
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"
}
}