エッジ状態の照会

Prev Next

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

エッジの状態を照会します。

リクエスト

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

メソッド URI
GET /api/v1/cdn-edges/{edgeId}/status

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
edgeId Number Required エッジ ID

リクエスト例

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

curl --location --request GET 'https://edge.apigw.ntruss.com/api/v1/cdn-edges/5707/status' \
--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 String - エッジの状態
  • PUBLISHING | RUNNING | STOPPING | STOPPED | ACTIVATING | DELETING | DELETED
    • PUBLISHING: デプロイ中
    • RUNNING: 運用中
    • STOPPING: 停止中
    • STOPPED: 停止
    • ACTIVATING: 再起動中
    • DELETING: 削除中
    • DELETED: 削除

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

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

レスポンス例

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

{
  "code": "0000",
  "message": "Success",
  "result": "RUNNING"
}