エッジリストの照会

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

プロファイルのエッジリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/profiles/{profileId}/cdn-edges

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`profileId`	Number	Required	プロファイル ID プロファイルリストの照会を参照

リクエスト例

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

curl --location --request GET 'https://edge.apigw.ntruss.com/api/v1/profiles/1599/cdn-edges' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	String	-	レスポンスコード
`message`	String	-	レスポンスメッセージ
`result`	Array	-	エッジリスト

`result`

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

フィールド	タイプ	必須の有無	説明
`id`	Number	-	エッジ ID
`profileId`	Number	-	プロファイル ID
`edgeName`	String	-	エッジ名
`statusType`	String	-	エッジの状態 `PUBLISHING` \| `RUNNING` \| `STOPPING` \| `STOPPED` \| `ACTIVATING` \| `DELETING` \| `DELETED` `PUBLISHING`: デプロイ中 `RUNNING`: 運用中 `STOPPING`: 停止中 `STOPPED`: 停止 `ACTIVATING`: 再起動中 `DELETING`: 削除中 `DELETED`: 削除
`serviceRegionType`	String	-	サービス地域 `KOREA` \| `JAPAN` \| `GLOBAL`
`originalCopyDomain`	String	-	オリジンドメイン
`registrationDate`	String	-	作成日時
`modifyDate`	String	-	最終設定変更日時
`domainName`	String	-	エッジドメイン

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

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

レスポンス例

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

{
    "code": "0000",
    "message": "Success",
    "result": [
        {
            "id": 5707,
            "profileId": 1599,
            "edgeName": "edge1",
            "statusType": "STOPPED",
            "serviceRegionType": "KOREA",
            "originalCopyDomain": "*********.kr.object.ncloudstorage.com",
            "registrationDate": "2025-07-15T00:15:05.833Z",
            "modifyDate": "2025-07-15T04:53:00.949Z",
            "domainName": "sd0t********.edge.naverncp.com"
        }
    ]
}