View Edge

Prev Next

Overview

Search the created CDN Edge information.

Requests

Request URL

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

Request parameters

Parameter name Requirement status Type Restrictions Description
edgeId Yes Long ID information of the created Edge

Responses

Every response returns success or failure with an HTTP status code.

HTTP status code Code message Description
200 Success Search succeeded
401 Unauthorized Authentication failed
500 Internal Server Error Server error

Examples

Request Examples

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

Response examples

{
    "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"
            ]
        }
    }
}

Errors

Error code Description
0032 Unauthorized request
9999 Server error occurred