エッジの編集

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

運用中または停止状態のエッジを設定をします。入力した内容で既存の設定が上書きされます。

リクエスト

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

リクエストヘッダ

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

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

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

リクエストボディ

リクエストボディの説明は次の通りです。

CdnDistributionConfig

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

CdnOriginalCopyConfig

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

CdnCachingConfig

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

CachingRule

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

ManagedRule

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

HeaderPolicy

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

OptimizationConfig

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

AccessControl

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

リクエスト例

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

curl --location --request PUT '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' \
--data '{
    "profileId": 234,
    "edgeName": "sample-edge",
    "distributionConfig": {
        "protocolType": "ALL",
        "regionType": "KOREA",
        "serviceDomain": {
            "domainType": "NCP_DOMAIN_AUTO",
            "domainName": null,
            "certificate": null
        },
        "edgeLogging": {
            "enabled": true,
            "bucketPrefix": "log/sample",
            "objectStorage": {
                "region": "KR",
                "bucketName": "sample-bucket"
            }
        }
    },
    "originalCopyConfig": {
        "originalCopyLocation": {
            "type": "OBJECT_STORAGE",
            "region": "KR",
            "bucketName":"sample-bucket",
            "customLocation": null
        },
        "forwardHostHeader": {
            "type": "ORIGIN_HOSTNAME",
            "customHostHeader": null
        },
        "originalCopyProtocol": {
            "type": "HTTP",
            "port": 80
        },
        "originalCopyPath": null,
        "originFailoverConfig": null
    },
    "cachingConfig": {
        "defaultCaching": {
            "enabled": true,
            "ruleDefinitionType": "CACHING",
            "cacheRevalidateConfig": {
                "type": "IF_POSSIBLE",
                "ageType": "HOURS",
                "age": "10"
            }
        },
        "negativeTtl": true,
        "bypassQueryString": {
            "enabled": true,
            "queryStrings": ["aaa", "bbb", "ccc"]
        },
        "cacheKeyHostname": "INCOMING_HOST_HEADER",
        "cacheKeyIgnoreQueryString": {
            "type": "ALL_ALLOWED",
            "queryStrings": []
        },
        "removeVaryHeader": true,
        "edgeAuth": {
            "enabled": true,
            "type": "SIGNED_URL",
            "tokenName": "name",
            "tokenKey": "902bceb96************10ff0b9befb"
        },
        "cachingRules": [
            {
                "ruleName": "sample",
                "ruleType": "DIRECTORY",
                "ruleConditions": ["/sample/*"],
                "ruleDefinitionType": "CACHING",
                "cacheRevalidateConfig": {
                    "type": "IF_POSSIBLE",
                    "ageType": "SECONDS",
                    "age": 100
                },
                "ruleBasedRoutingConfig": {
                    "enabled": true,
                    "originalCopyLocation": {
                        "type": "OBJECT_STORAGE",
                        "region": "KR",
                        "bucketName": "sample-bucket",
                        "customLocation": null
                    }
                },
                "browserCache": {
                    "enabled": true,
                    "type": "ALLOW_CACHE",
                    "ageType": "SECONDS",
                    "age": 100
                },
                "cacheKeyQueryParameter": {
                    "enabled": true,
                    "type": "IGNORE_SPECIFIC_STRING",
                    "queryParameters": ["aaa", "bbb", "ccc"]
                },
                "accessDeny": false,
                "urlRedirect": {
                    "enabled": true,
                    "destinationProtocol": "HTTP",
                    "destinationHostname": "ncloud.com",
                    "destinationPath": "/home",
                    "responseCode": "FOUND_302"
                },
                "urlRewrite": {
                    "enabled": false,
                    "rewriteTarget": null
                }
            }
        ]
    },
    "managedRule": {
        "cors": true,
        "http2": true,
        "trueClientIpHeader": true,
        "hsts": false
    },
    "headerPolicies": [
        {
            "type": "ORIGIN_REQUEST",
            "ruleName": "Modify Origin Request Header",
            "header": {
                "type": "ADD",
                "name": "name",
                "value": "value"
            }
        },
        {
            "type": "CLIENT_RESPONSE",
            "ruleName": "Modify Client Response Header",
            "header": {
                "type": "MODIFY",
                "name": "name",
                "value": "value"
            }
        }
    ],
    "optimizationConfig": {
        "httpCompression": true,
        "largeFileOptimization": true
    },
    "accessControl": {
        "type": "WHITELIST",
        "ipPolicies": ["1.1.1.1", "2.2.2.2", "3.3.3.3"],
        "geoPolicies": ["AL", "SK", "ZM"],
        "refererPolicies": ["ncloud.com", "naver.com"]
    }
}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

{
    "code": "0000",
    "message": "Success",
    "result": {
        "edgeId": 123
    }
}