MENU
      View Edge
        • PDF

        View Edge

        • PDF

        Article summary

        Overview

        Search the created CDN Edge information.

        Requests

        Request URL

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

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        edgeIdYesLongID information of the created Edge

        Responses

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

        HTTP status codeCode messageDescription
        200SuccessSearch succeeded
        401UnauthorizedAuthentication failed
        500Internal Server ErrorServer error

        Examples

        Request Examples

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

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

        Errors

        Error codeDescription
        0032Unauthorized request
        9999Server error occurred

        Was this article helpful?

        What's Next
        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.