API docs by Redocly

ネットワークスイート (β) API (0.1.0)

Download OpenAPI specification:Download

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

ネットワークスイート (β) APIは、さくらのクラウドのネットワークスイート機能 (Networking Suite) を提供するAPIです。

基本的な使い方

APIキーの発行

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

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

APIエンドポイント

ゾーン名 APIエンドポイントURL
サンドボックスゾーン https://secure.sakura.ad.jp/cloud/zone/tk1v/api/cloud/1.1
石狩第3ゾーン https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1

入力パラメータ

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

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

サブネットグループ・サブネット操作

サブネットグループ・サブネット操作に関連するエンドポイント

サブネットグループ・サブネット一覧の取得

サブネットグループ・サブネットの一覧を取得します。

レスポンスには以下のリソースが含まれます。

  • サブネットグループリスト (NetworkTenantGroupBeta)
    • プロジェクトが所有するサブネットグループを集約する仮想的なリソースです。
  • サブネットグループ (NetworkTenantBeta)
  • サブネット (NetworkTenantSegmentBeta)

Responses

Response samples

Content type
application/json
{
  • "NetworkTenantGroupsBeta": [
    ]
}

サブネットグループ・サブネットの作成

サブネットグループ・サブネットを作成します。 1回のAPI呼び出しで、以下のリソースを一括で作成します。

  • サブネットグループリスト (NetworkTenantGroupBeta) 1個
    • プロジェクトが所有するサブネットグループを集約する仮想的なリソースです。
  • サブネットグループ (NetworkTenantBeta) 1個
  • サブネット (NetworkTenantSegmentBeta) 3個

Responses

Response samples

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

サブネットグループ・サブネット詳細の取得

サブネットグループ・サブネット詳細を取得します。

path Parameters
networkTenantGroupBetaID
required
string

サブネットグループリストのID

GET networktenantgroupbeta のレスポンスに含まれる NetworkTenantGroupsBeta[].ID を指定します。

Responses

Response samples

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

サブネットグループ・サブネットの削除

サブネットグループ・サブネットを削除します。

path Parameters
networkTenantGroupBetaID
required
string

サブネットグループリストのID

GET networktenantgroupbeta のレスポンスに含まれる NetworkTenantGroupsBeta[].ID を指定します。 サブネットグループリスト配下の全てのサブネットグループ・サブネットが一括で削除されます。

Responses

Response samples

Content type
application/json
{
  • "error_msg": "string"
}

インタフェース操作

インタフェース操作に関連するエンドポイント

インタフェースとサブネットの接続

インタフェースをサブネットに接続します。

path Parameters
interfaceID
required
string

インタフェースのID

インタフェースのIDは、サーバ情報取得APIのレスポンスに含まれる Server.Interfaces[].ID を指定します。

networkTenantGroupBetaID
required
string

サブネットグループリストのID (NetworkTenantGroupBeta.ID)

networkTenantBetaID
required
string

サブネットグループのID (NetworkTenantBeta.ID)

networkTenantSegmentBetaID
required
string

サブネットのID (NetworkTenantSegmentBeta.ID)

Responses

Response samples

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

インタフェースとサブネットの切断

インタフェースをサブネットから切断します。

path Parameters
interfaceID
required
string

インタフェースのID

インタフェースのIDは、サーバ情報取得APIのレスポンスに含まれる Server.Interfaces[].ID を指定します。

networkTenantGroupBetaID
required
string

サブネットグループリストのID (NetworkTenantGroupBeta.ID)

networkTenantBetaID
required
string

サブネットグループのID (NetworkTenantBeta.ID)

networkTenantSegmentBetaID
required
string

サブネットのID (NetworkTenantSegmentBeta.ID)

Responses

Response samples

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