Edgeの照会

Prev Next

概要

作成された CDN Edgeの情報を照会します。

リクエスト

リクエスト URL

GET
https://edge.apigw.ntruss.com/api/v1/cdn-edges/{edgeId}

リクエストパラメータ

パラメータ名 要否 タイプ 制約事項 説明
edgeId Yes Long 作成された Edgeの ID情報

レスポンス

すべてのレスポンスは、HTTP Status Codeで成功または失敗を返します。

HTTPステータスコード コードのメッセージ 説明
200 Success 照会成功
401 Unauthorized 認証失敗
500 Internal Server Error サーバエラー

リクエスト例

https://edge.apigw.ntruss.com/api/v1/cdn-edges/123

レスポンス例

{
    "code": "0000",
    "message": "Success",
    "result": {
        "profileId": 234,
        "edgeName": "sample-edge",
        "distributionConfig": {
            "protocolType": "ALL",
            "regionType": "KOREA",
            "serviceDomain": {
                "domainType": "NCP_DOMAIN_AUTO",
                "domainName": "lurn5qzs123.edge.naverncp.com"
            },
            "edgeLogging": {
                "enabled": true,
                "bucketPrefix": "log/sample",
                "objectStorage": {
                    "region": "KR",
                    "bucketName": "sample-bucket"
                }
            }
        },
        "originalCopyConfig": {
            "originalCopyLocation": {
                "type": "OBJECT_STORAGE",
                "region": "KR",
                "bucketName": "sample-bucket"
            },
            "forwardHostHeader": {
                "type": "ORIGIN_HOSTNAME"
            },
            "originalCopyProtocol": {
                "type": "HTTP",
                "port": 80
            },
            "originShield": {
                "enabled": true,
                "region": "USWN"
            }
        },
        "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"
            },
            "removeVaryHeader": true,
            "edgeAuth": {
                "enabled": true,
                "type": "SIGNED_URL",
                "tokenKey": "902bceb96b2139771716910ff0b9befb",
                "bypassValues":[".ts",".jpg",".exe"],
                "tokenBypassValues":["playlist.m3u8","index.m3u8"]
            }
        },
        "managedRule": {
            "cors": true,
            "http2": true,
            "trueClientIpHeader": true,
            "hsts": false
        },
        "headerPolicies": [
            {
                "type": "ORIGIN_REQUEST",
                "ruleName": "Modify Origin Reqeust 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"
            ]
        }
    }
}

エラーコード

Errorコード 説明
0032 許可されていないリクエスト
9999 サーバエラー発生