API docs by Redocly

Service Endpoint Gateway API (1.0.0)

Download OpenAPI specification:Download

URL: https://www.sakura.ad.jp/ License: Copyright(C) SAKURA internet Inc. all rights reserved.

「サービスエンドポイントゲートウェイ」が提供するAPIの利用方法とサンプルを公開しております。

基本的な使い方

APIキーの発行

APIを利用するためには、認証のための「APIキー」が必要です。事前にキーを発行しておきます。 APIキーは「ユーザID」「パスワード」に相当する「トークン」と呼ばれる認証情報で構成されています。

項目名 APIキー発行時の項目名 このドキュメント内での例
ユーザID アクセストークン(UUID) 01234567-89ab-cdef-0123-456789abcdef
パスワード アクセストークンシークレット SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM
操作マニュアル

入力パラメータ

APIの入力には送信先URLに対して、いくつかのヘッダーとAPIキーを送信します。

  • 認証方式はHTTP Basic認証です。APIキーのアクセストークンをユーザーID、アクセストークンシークレットをパスワードとして指定します。
# 入力サンプル
curl \
  -u '01234567-89ab-cdef-0123-456789abcdef:SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM' \
  -X GET \
  'https://secure.sakura.ad.jp/cloud/zone/tk1a/api/cloud/1.1/appliances'

インターフェース管理

サービスエンドポイントゲートウェイのインターフェースに関する操作をまとめたタグです。

サービスエンドポイントゲートウェイインターフェース情報取得API

指定したサービスエンドポイントゲートウェイのインターフェース情報を取得します。

path Parameters
applianceID
required
string
interfaceID
required
string

Responses

Response samples

Content type
application/json
{
  • "Interface": {
    },
  • "is_ok": true
}

起動状態管理

サービスエンドポイントゲートウェイの起動状態に関する操作（起動・停止・リセットなど）をまとめたタグです。

サービスエンドポイントゲートウェイ起動状態取得API

指定したサービスエンドポイントゲートウェイの起動状態を取得します。

path Parameters
applianceID
required
string

Responses

Response samples

Content type
application/json
{
  • "Instance": {
    },
  • "is_ok": true
}

サービスエンドポイントゲートウェイ起動API

指定したサービスエンドポイントゲートウェイを起動します。

path Parameters
applianceID
required
string

Responses

Response samples

Content type
application/json
{
  • "Success": true,
  • "is_ok": true
}

サービスエンドポイントゲートウェイ停止API

指定したサービスエンドポイントゲートウェイを停止します。

path Parameters
applianceID
required
string

Responses

Response samples

Content type
application/json
{
  • "Success": true,
  • "is_ok": true
}

サービスエンドポイントゲートウェイ起動状態リセットAPI

指定したサービスエンドポイントゲートウェイの起動状態をリセットします。

path Parameters
applianceID
required
string

Responses

Response samples

Content type
application/json
{
  • "Success": true,
  • "is_ok": true
}

ServiceEndpointGateway

Service Endpoint Gateway に関する操作（一覧・取得など）をまとめたタグです。

サービスエンドポイントゲートウェイ一覧取得API

サービスエンドポイントゲートウェイの一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "From": 0,
  • "Count": 1,
  • "Total": 1,
  • "Appliances": [
    ],
  • "is_ok": true
}

サービスエンドポイントゲートウェイ作成API

指定したサービスエンドポイントゲートウェイを作成します。

Request Body schema: application/json
required
object (Models.Appliance.ApplianceCreateBody)

Responses

Request samples

Content type
application/json
{
  • "Appliance": {
    }
}

Response samples

Content type
application/json
{
  • "Appliance": {
    },
  • "is_ok": true
}

サービスエンドポイントゲートウェイ取得API

指定したサービスエンドポイントゲートウェイの情報を取得します。

path Parameters
applianceID
required
string

Responses

Response samples

Content type
application/json
{
  • "Appliance": {
    },
  • "is_ok": true
}

サービスエンドポイントゲートウェイ更新API

指定したサービスエンドポイントゲートウェイの情報を更新します。

更新後には、別途「サービスエンドポイントゲートウェイ適用API」を呼び出して設定を反映する必要があります。

path Parameters
applianceID
required
string
Request Body schema: application/json
required
object (Models.Appliance.ApplianceUpdateBody)

Responses

Request samples

Content type
application/json
{
  • "Appliance": {
    }
}

Response samples

Content type
application/json
{
  • "Appliance": {
    },
  • "is_ok": true
}

サービスエンドポイントゲートウェイ削除API

指定したサービスエンドポイントゲートウェイを削除します。

path Parameters
applianceID
required
string

Responses

Response samples

Content type
application/json
{
  • "Appliance": {
    },
  • "is_ok": true
}

サービスエンドポイントゲートウェイ適用API

指定したサービスエンドポイントゲートウェイの情報を適用します。

path Parameters
applianceID
required
string
Request Body schema: application/json
required
object (Models.Appliance.ApplianceUpdateBody)

Responses

Request samples

Content type
application/json
{
  • "Appliance": {
    }
}

Response samples

Content type
application/json
{
  • "Appliance": {
    },
  • "is_ok": true
}