openapi: 3.2.0 info: title: Sakura Internet Service Endpoint Gateway API version: 1.2.2 contact: name: SAKURA internet Inc. url: https://www.sakura.ad.jp/ license: name: Copyright(C) SAKURA internet Inc. all rights reserved. description: 'Operations tagged ServiceEndpointGateway across 2 of this provider''s published API definitions: seg-api.yaml, sakura-internet-seg-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1 description: さくらのクラウド（石狩第3ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/is1b/api/cloud/1.1 description: さくらのクラウド（石狩第2ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1 description: さくらのクラウド（石狩第1ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/tk1v/api/cloud/1.1 description: さくらのクラウド（サンドボックスゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1 description: さくらのクラウド（東京第2ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/tk1a/api/cloud/1.1 description: さくらのクラウド（東京第1ゾーン）APIエンドポイント variables: {} tags: - name: ServiceEndpointGateway description: Service Endpoint Gateway に関する操作（一覧・取得など）をまとめたタグです。 paths: /appliance: get: operationId: listServiceEndpointGateways summary: サービスエンドポイントゲートウェイ一覧取得API description: サービスエンドポイントゲートウェイの一覧を取得します。 parameters: [] responses: '200': description: 成功時のレスポンス content: application/json: schema: $ref: '#/components/schemas/Models.Appliance.ListServiceEndpointGatewaysResponseBody' default: description: デフォルトのエラーレスポンス content: application/json: schema: $ref: '#/components/schemas/Models.Common.DefaultErrorResponseBody' tags: - ServiceEndpointGateway post: operationId: createServiceEndpointGateway summary: サービスエンドポイントゲートウェイ作成API description: 指定したサービスエンドポイントゲートウェイを作成します。 parameters: [] responses: '202': description: 成功時のレスポンス content: application/json: schema: $ref: '#/components/schemas/Models.Appliance.CreateServiceEndpointGatewayResponseBody' default: description: デフォルトのエラーレスポンス content: application/json: schema: $ref: '#/components/schemas/Models.Common.DefaultErrorResponseBody' tags: - ServiceEndpointGateway requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Models.Appliance.CreateServiceEndpointGatewayRequest' servers: - url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1 description: さくらのクラウド（石狩第3ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/is1b/api/cloud/1.1 description: さくらのクラウド（石狩第2ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1 description: さくらのクラウド（石狩第1ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/tk1v/api/cloud/1.1 description: さくらのクラウド（サンドボックスゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1 description: さくらのクラウド（東京第2ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/tk1a/api/cloud/1.1 description: さくらのクラウド（東京第1ゾーン）APIエンドポイント variables: {} /appliance/{applianceID}: get: operationId: readServiceEndpointGateway summary: サービスエンドポイントゲートウェイ取得API description: 指定したサービスエンドポイントゲートウェイの情報を取得します。 parameters: - name: applianceID in: path required: true schema: type: string responses: '200': description: 成功時のレスポンス content: application/json: schema: $ref: '#/components/schemas/Models.Appliance.ReadServiceEndpointGatewayResponseBody' default: description: デフォルトのエラーレスポンス content: application/json: schema: $ref: '#/components/schemas/Models.Common.DefaultErrorResponseBody' tags: - ServiceEndpointGateway put: operationId: updateServiceEndpointGateway summary: サービスエンドポイントゲートウェイ更新API description: '指定したサービスエンドポイントゲートウェイの情報を更新します。 更新後には、別途「サービスエンドポイントゲートウェイ適用API」を呼び出して設定を反映する必要があります。' parameters: - name: applianceID in: path required: true schema: type: string responses: '200': description: 成功時のレスポンス content: application/json: schema: $ref: '#/components/schemas/Models.Appliance.ReadServiceEndpointGatewayResponseBody' default: description: デフォルトのエラーレスポンス content: application/json: schema: $ref: '#/components/schemas/Models.Common.DefaultErrorResponseBody' tags: - ServiceEndpointGateway requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Models.Appliance.UpdateServiceEndpointGatewayRequest' delete: operationId: deleteServiceEndpointGateway summary: サービスエンドポイントゲートウェイ削除API description: 指定したサービスエンドポイントゲートウェイを削除します。 parameters: - name: applianceID in: path required: true schema: type: string responses: '200': description: 成功時のレスポンス content: application/json: schema: $ref: '#/components/schemas/Models.Appliance.ReadServiceEndpointGatewayResponseBody' default: description: デフォルトのエラーレスポンス content: application/json: schema: $ref: '#/components/schemas/Models.Common.DefaultErrorResponseBody' tags: - ServiceEndpointGateway servers: - url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1 description: さくらのクラウド（石狩第3ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/is1b/api/cloud/1.1 description: さくらのクラウド（石狩第2ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1 description: さくらのクラウド（石狩第1ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/tk1v/api/cloud/1.1 description: さくらのクラウド（サンドボックスゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1 description: さくらのクラウド（東京第2ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/tk1a/api/cloud/1.1 description: さくらのクラウド（東京第1ゾーン）APIエンドポイント variables: {} /appliance/{applianceID}/config: put: operationId: applyServiceEndpointGatewayConfig summary: サービスエンドポイントゲートウェイ適用API description: 指定したサービスエンドポイントゲートウェイの情報を適用します。 parameters: - name: applianceID in: path required: true schema: type: string responses: '200': description: 成功時のレスポンス content: application/json: schema: $ref: '#/components/schemas/Models.Appliance.ApplianceApplyResponseBody' default: description: デフォルトのエラーレスポンス content: application/json: schema: $ref: '#/components/schemas/Models.Common.DefaultErrorResponseBody' tags: - ServiceEndpointGateway requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/Models.Appliance.UpdateServiceEndpointGatewayRequest' servers: - url: https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1 description: さくらのクラウド（石狩第3ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/is1b/api/cloud/1.1 description: さくらのクラウド（石狩第2ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1 description: さくらのクラウド（石狩第1ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/tk1v/api/cloud/1.1 description: さくらのクラウド（サンドボックスゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1 description: さくらのクラウド（東京第2ゾーン）APIエンドポイント variables: {} - url: https://secure.sakura.ad.jp/cloud/zone/tk1a/api/cloud/1.1 description: さくらのクラウド（東京第1ゾーン）APIエンドポイント variables: {} components: schemas: Models.Network.Interface: type: object required: - IPAddress - UserIPAddress - HostName - Switch properties: IPAddress: anyOf: - type: string - type: 'null' description: IPアドレス UserIPAddress: anyOf: - type: string - type: 'null' description: ユーザーIPアドレス HostName: anyOf: - type: string - type: 'null' description: ホスト名 Switch: allOf: - $ref: '#/components/schemas/Models.Network.InterfaceSwitch' description: スイッチ情報 Models.Plan.Plan: type: object required: - ID properties: ID: type: number enum: - 1 description: プランID Models.Disk.Disk: type: object required: - EncryptionAlgorithm - EncryptionKey - DedicatedStorageContract properties: EncryptionAlgorithm: anyOf: - type: string - type: 'null' description: 暗号化アルゴリズム EncryptionKey: anyOf: - $ref: '#/components/schemas/Models.Disk.EncryptionKey' - type: 'null' description: 暗号化キー情報 DedicatedStorageContract: anyOf: - $ref: '#/components/schemas/Models.Disk.DedicatedStorageContract' - type: 'null' description: 専用ストレージ契約情報 Models.Remark.SwitchRemark: type: object required: - ID properties: ID: type: string description: スイッチID Models.Appliance.CreateServiceEndpointGatewayResponseBody: type: object required: - Appliance - is_ok properties: Appliance: allOf: - $ref: '#/components/schemas/Models.Appliance.Appliance' description: サービスエンドポイントゲートウェイ情報 is_ok: type: boolean description: 操作結果 examples: - Appliance: ID: '123456789012' Class: serviceendpointgateway Name: Service Endpoint Gateway (123456789012) Description: '' Plan: ID: 1 Settings: null SettingsHash: null Remark: Switch: ID: '123456789012' Network: NetworkMaskLen: 24 Servers: - IPAddress: 192.0.2.15 Zone: ID: '21001' Availability: migrating Instance: Status: null StatusChangedAt: null Host: Name: null InfoURL: null Hosts: [] Disk: EncryptionAlgorithm: null EncryptionKey: KMSKeyID: null DedicatedStorageContract: ID: null ServiceClass: cloud/appliance/serviceendpointgateway/1 Generation: 100 CreatedAt: '2026-02-09T23:40:29+09:00' Icon: null Switch: ID: '123456789012' Name: Switch Internet: BandWidthMbps: null Scope: user Availability: available Zone: ID: 21001 Name: tk1a Region: ID: 210 Name: 東京 Interfaces: [] Tags: [] is_ok: true Models.Appliance.UpdateServiceEndpointGatewayRequest: type: object required: - Appliance properties: Appliance: $ref: '#/components/schemas/Models.Appliance.ApplianceUpdateBody' examples: - Appliance: Settings: ServiceEndpointGateway: EnabledServices: - Type: ObjectStorage Config: Endpoints: - s3.isk01.sakurastorage.jp - Type: AppRunDedicatedControlPlane Config: Mode: Managed MonitoringSuite: Enabled: 'True' DNSForwarding: Enabled: 'True' PrivateHostedZone: internal.example.com UpstreamDNS1: ns1.gslbN.sakura.ne.jp UpstreamDNS2: ns2.gslbN.sakura.ne.jp Models.Appliance.ListServiceEndpointGatewaysResponseBody: type: object required: - From - Count - Total - Appliances - is_ok properties: From: type: integer format: int32 description: 取得開始位置 Count: type: integer format: int32 description: 取得件数 Total: type: integer format: int32 description: 総件数 Appliances: type: array items: $ref: '#/components/schemas/Models.Appliance.Appliance' description: サービスエンドポイントゲートウェイ情報一覧 is_ok: type: boolean description: 操作結果 examples: - From: 0 Count: 1 Total: 1 Appliances: - ID: '123456789012' Class: serviceendpointgateway Name: Service Endpoint Gateway (123456789012) Description: '' Plan: ID: 1 Settings: ServiceEndpointGateway: EnabledServices: - Type: ObjectStorage Config: Endpoints: - s3.isk01.sakurastorage.jp - Type: AppRunDedicatedControlPlane Config: Mode: Managed MonitoringSuite: Enabled: 'True' DNSForwarding: Enabled: 'True' PrivateHostedZone: internal.example.com UpstreamDNS1: ns1.gslbN.sakura.ne.jp UpstreamDNS2: ns2.gslbN.sakura.ne.jp SettingsHash: abcdef1234567890abcdef1234567890 Remark: Switch: ID: '123456789012' Network: NetworkMaskLen: 24 Servers: - IPAddress: 192.0.2.15 Zone: ID: '21001' Availability: available Instance: Status: up StatusChangedAt: '2024-01-01T00:00:00+09:00' Host: Name: sac-tk1a-sv001 InfoURL: '' Hosts: - Name: sac-tk1a-sv001 InfoURL: '' Disk: EncryptionAlgorithm: none EncryptionKey: null DedicatedStorageContract: null ServiceClass: cloud/appliance/serviceendpointgateway/1 Generation: 100 CreatedAt: '2024-01-01T00:00:00+09:00' Icon: null Switch: ID: '123456789012' Name: Switch1 Internet: null Scope: user Availability: available Zone: ID: 21001 Name: tk1a Region: ID: 210 Name: 東京 Interfaces: - IPAddress: 203.0.113.100 UserIPAddress: null HostName: null Switch: ID: '123456789012' Name: Switch Scope: shared Subnet: NetworkAddress: 203.0.113.0 NetworkMaskLen: 24 DefaultRoute: 203.0.113.1 Internet: BandWidthMbps: 100 UserSubnet: DefaultRoute: 203.0.113.1 NetworkMaskLen: 24 - IPAddress: null UserIPAddress: 192.0.2.15 HostName: null Switch: ID: '123456789012' Name: SwitchForSEG Scope: user Subnet: null UserSubnet: DefaultRoute: 192.0.2.1 NetworkMaskLen: 24 Tags: [] is_ok: true Models.Network.InternetInfo: type: object required: - BandWidthMbps properties: BandWidthMbps: anyOf: - type: integer format: int32 - type: 'null' description: 帯域幅（Mbps） Models.Appliance.ApplianceCreateBody: type: object required: - Class - Plan - Remark properties: Class: type: string enum: - serviceendpointgateway description: クラス名 Plan: allOf: - $ref: '#/components/schemas/Models.Plan.Plan' description: プラン情報 Remark: allOf: - $ref: '#/components/schemas/Models.Remark.ApplianceCreateRemark' description: 備考情報 Models.Settings.ServiceEndpointGatewaySettings: type: object required: - EnabledServices properties: EnabledServices: type: array items: $ref: '#/components/schemas/Models.Settings.EnabledService' description: 接続先マネージドサービスの設定 MonitoringSuite: allOf: - $ref: '#/components/schemas/Models.Settings.MonitoringSuiteSettings' description: モニタリングスイート連携の設定 DNSForwarding: allOf: - $ref: '#/components/schemas/Models.Settings.DNSForwardingSettings' description: DNSプライベートホストゾーンの設定 Models.Instance.Instance: type: object properties: Status: anyOf: - type: string enum: - up - down - cleaning - type: 'null' description: インスタンスの稼働状態 StatusChangedAt: anyOf: - type: string - type: 'null' description: 状態変更日時 Host: anyOf: - $ref: '#/components/schemas/Models.Instance.HostInfo' - type: 'null' description: ホスト情報 Hosts: type: array items: $ref: '#/components/schemas/Models.Instance.HostInfo' description: ホスト情報一覧 Models.Disk.DedicatedStorageContract: type: object required: - ID properties: ID: anyOf: - type: string - type: 'null' description: 契約ID Models.Appliance.ReadServiceEndpointGatewayResponseBody: type: object required: - Appliance - is_ok properties: Appliance: allOf: - $ref: '#/components/schemas/Models.Appliance.Appliance' description: サービスエンドポイントゲートウェイ情報 is_ok: type: boolean description: 操作結果 examples: - Appliance: ID: '123456789012' Class: serviceendpointgateway Name: Service Endpoint Gateway (123456789012) Description: '' Plan: ID: 1 Settings: ServiceEndpointGateway: EnabledServices: - Type: ObjectStorage Config: Endpoints: - s3.isk01.sakurastorage.jp - Type: AppRunDedicatedControlPlane Config: Mode: Managed MonitoringSuite: Enabled: 'True' DNSForwarding: Enabled: 'True' PrivateHostedZone: internal.example.com UpstreamDNS1: ns1.gslbN.sakura.ne.jp UpstreamDNS2: ns2.gslbN.sakura.ne.jp SettingsHash: abcdef1234567890abcdef1234567890 Remark: Switch: ID: '123456789012' Network: NetworkMaskLen: 24 Servers: - IPAddress: 192.0.2.15 Zone: ID: '21001' Availability: available Instance: Status: up StatusChangedAt: '2024-01-01T00:00:00+09:00' Host: Name: sac-tk1a-sv001 InfoURL: '' Hosts: - Name: sac-tk1a-sv001 InfoURL: '' Disk: EncryptionAlgorithm: none EncryptionKey: null DedicatedStorageContract: null ServiceClass: cloud/appliance/serviceendpointgateway/1 Generation: 100 CreatedAt: '2024-01-01T00:00:00+09:00' Icon: null Switch: ID: '123456789012' Name: Switch1 Internet: null Scope: user Availability: available Zone: ID: 21001 Name: tk1a Region: ID: 210 Name: 東京 Interfaces: - IPAddress: 203.0.113.100 UserIPAddress: null HostName: null Switch: ID: '123456789012' Name: Switch Scope: shared Subnet: NetworkAddress: 203.0.113.0 NetworkMaskLen: 24 DefaultRoute: 203.0.113.1 Internet: BandWidthMbps: 100 UserSubnet: DefaultRoute: 203.0.113.1 NetworkMaskLen: 24 - IPAddress: null UserIPAddress: 192.0.2.15 HostName: null Switch: ID: '123456789012' Name: SwitchForSEG Scope: user Subnet: null UserSubnet: DefaultRoute: 192.0.2.1 NetworkMaskLen: 24 Tags: [] is_ok: true Models.Remark.ApplianceCreateRemark: type: object required: - Switch - Network - Servers properties: Switch: allOf: - $ref: '#/components/schemas/Models.Remark.SwitchRemark' description: スイッチ情報 Network: allOf: - $ref: '#/components/schemas/Models.Remark.NetworkRemark' description: ネットワーク情報 Servers: type: array items: $ref: '#/components/schemas/Models.Remark.ServerRemark' description: サーバー情報 Models.Disk.EncryptionKey: type: object required: - KMSKeyID properties: KMSKeyID: anyOf: - type: string - type: 'null' description: KMSキーID Models.Network.Switch: type: object required: - ID - Name - Internet - Scope - Availability - Zone properties: ID: type: string description: スイッチID Name: type: string description: スイッチ名 Internet: anyOf: - $ref: '#/components/schemas/Models.Network.InternetInfo' - type: 'null' description: インターネット接続情報 Scope: type: string enum: - user - shared description: スイッチのスコープ Availability: type: string enum: - available - unavailable description: 稼働状態 Zone: allOf: - $ref: '#/components/schemas/Models.Network.Zone' description: スイッチのゾーン情報 Models.Instance.HostInfo: type: object required: - Name - InfoURL properties: Name: anyOf: - type: string - type: 'null' description: ホスト名 InfoURL: anyOf: - type: string - type: 'null' description: ホスト情報のURL Models.Appliance.ApplianceApplyResponseBody: type: object required: - Success - ReturnCode - ResponseHeaders - Out - is_ok properties: Success: type: boolean description: Apply結果 ReturnCode: type: integer format: int32 description: 実行時のリターンコード ResponseHeaders: type: object properties: Status: type: string description: レスポンスのステータスコード Cause: anyOf: - type: string - type: 'null' description: レスポンスの原因 required: - Status - Cause description: レスポンスヘッダー情報 Out: anyOf: - type: string - type: 'null' description: 出力情報 is_ok: type: boolean description: 操作結果 examples: - Success: true ReturnCode: 0 ResponseHeaders: Status: Ok Cause: null Out: null is_ok: true Models.Settings.EnabledService: type: object required: - Type - Config properties: Type: type: string enum: - ObjectStorage - ContainerRegistry - MonitoringSuite - AIEngine - SimpleAI - AppRunDedicatedControlPlane description: '接続先マネージドサービス | Type | 説明 | |---|---| | ObjectStorage | オブジェクトストレージ | | ContainerRegistry | コンテナレジストリ | | MonitoringSuite | モニタリングスイート | | AIEngine | AI Engine | | SimpleAI | シンプルAI | | AppRunDedicatedControlPlane | AppRun専有型コントロールプレーン |' Config: allOf: - $ref: '#/components/schemas/Models.Settings.ServiceConfig' description: 接続先マネージドサービスの設定 Models.Remark.NetworkRemark: type: object required: - NetworkMaskLen properties: NetworkMaskLen: type: integer format: int32 description: ネットワークマスク長 Models.Settings.MonitoringSuiteSettings: type: object required: - Enabled properties: Enabled: type: string enum: - 'True' - 'False' description: 有効化・無効化の選択 Models.Network.Zone: type: object required: - ID - Name - Region properties: ID: type: integer format: int32 description: 'ゾーンID ゾーンIDとゾーン名の対応表は以下の通りです。 | ゾーンID | ゾーン名 | 説明 | |---------|---------|------| | 21001 | tk1a | 東京第1ゾーン | | 21002 | tk1b | 東京第2ゾーン | | 29001 | tk1v | サンドボックスゾーン名 | | 31001 | is1a | 石狩第1ゾーン | | 31002 | is1b | 石狩第2ゾーン | | 31003 | is1c | 石狩第3ゾーン |' Name: type: string description: ゾーン名 Region: allOf: - $ref: '#/components/schemas/Models.Network.Region' description: リージョン情報 Models.Settings.ServiceConfig: type: object properties: Endpoints: type: array items: type: string description: '### ObjectStorage Type エンドポイントは以下に限定されます。 | 名前 | エンドポイント | |---|---| | 石狩第1サイト | `s3.isk01.sakurastorage.jp` | | 東京第1サイト | `s3.tky01.sakurastorage.jp` | | 東京第1サイト（アーカイブプラン） | `s3.arc02.sakurastorage.jp` | ### ContainerRegistry Type sakuracr.jp のサブドメインを指定してください。 ### MonitoringSuite Type モニタリングスイートのログストレージ・メトリクスストレージのエンドポイントを指定してください。 | ストレージ | エンドポイントの形式 | |---|---| | ログストレージ | `[0-9]{12}.logs.monitoring.global.api.sacloud.jp` | | メトリクスストレージ | `[0-9]{12}.metrics.monitoring.global.api.sacloud.jp` | ### AIEngine Type エンドポイントは以下に限定されます。 - api.ai.sakura.ad.jp ### SimpleAI Type エンドポイントは以下に限定されます。 - simpleai.is1.api.sacloud.jp ### AppRunDedicatedControlPlane Type エンドポイントは指定できません。' Mode: type: string enum: - Managed - '' description: '接続先マネージドサービスのエンドポイントの自動設定モード。 AppRunDedicatedControlPlaneのみ利用できます。' Models.Network.UserSubnet: type: object required: - DefaultRoute - NetworkMaskLen properties: DefaultRoute: anyOf: - type: string - type: 'null' description: デフォルトルート NetworkMaskLen: type: integer format: int32 description: ネットマスク長 Models.Network.Subnet: type: object required: - NetworkAddress - NetworkMaskLen - DefaultRoute - Internet properties: NetworkAddress: type: string description: ネットワークアドレス NetworkMaskLen: type: integer format: int32 description: ネットマスク長 DefaultRoute: anyOf: - type: string - type: 'null' description: デフォルトルート Internet: allOf: - $ref: '#/components/schemas/Models.Network.InternetInfo' description: インターネット接続情報 Models.Appliance.Appliance: type: object required: - ID - Class - Name - Description - Plan - Settings - SettingsHash - Remark - Availability - Instance - Disk - ServiceClass - Generation - CreatedAt - Icon - Switch - Interfaces - Tags properties: ID: type: string Class: type: string enum: - serviceendpointgateway description: クラス名 Name: type: string description: 名前 Description: type: string description: 説明 Plan: allOf: - $ref: '#/components/schemas/Models.Plan.Plan' description: プラン情報 Settings: anyOf: - $ref: '#/components/schemas/Models.Settings.ApplianceSettings' - type: 'null' description: 設定情報 SettingsHash: anyOf: - type: string - type: 'null' description: 設定情報のハッシュ値 Remark: anyOf: - $ref: '#/components/schemas/Models.Remark.ApplianceRemark' - type: 'null' description: 備考情報 Availability: type: string enum: - available - unavailable - migrating description: 稼働状態 Instance: allOf: - $ref: '#/components/schemas/Models.Instance.Instance' description: インスタンス情報 Disk: anyOf: - $ref: '#/components/schemas/Models.Disk.Disk' - type: 'null' description: ディスク情報 ServiceClass: type: string enum: - cloud/appliance/serviceendpointgateway/1 description: サービスクラス Generation: type: integer format: int32 description: 世代 CreatedAt: type: string description: 作成日時 Icon: type: 'null' description: アイコン情報 Switch: allOf: - $ref: '#/components/schemas/Models.Network.Switch' description: 接続先スイッチ情報 Interfaces: type: array items: $ref: '#/components/schemas/Models.Network.Interface' description: インターフェース情報 Tags: type: array prefixItems: [] description: タグ情報 Models.Network.Region: type: object required: - ID - Name properties: ID: type: integer format: int32 description: 'リージョンID リージョンIDとリージョン名の対応表は以下の通りです。 | リージョンID | リージョン名 | 説明 | |-------------|---------------|------| | 210 | 東京 | 東京リージョン | | 310 | 石狩 | 石狩リージョン |' Name: type: string description: リージョン名 Models.Appliance.ApplianceUpdateBody: type: object required: - Settings properties: Settings: allOf: - $ref: '#/components/schemas/Models.Settings.ApplianceSettings' description: 設定情報 Models.Remark.ApplianceRemark: type: object required: - Switch - Network - Servers - Zone properties: Switch: allOf: - $ref: '#/components/schemas/Models.Remark.SwitchRemark' description: スイッチ情報 Network: allOf: - $ref: '#/components/schemas/Models.Remark.NetworkRemark' description: ネットワーク情報 Servers: type: array items: $ref: '#/components/schemas/Models.Remark.ServerRemark' description: サーバー情報 Zone: allOf: - $ref: '#/components/schemas/Models.Remark.ZoneRemark' description: ゾーン情報 Models.Settings.DNSForwardingSettings: type: object required: - Enabled properties: Enabled: type: string enum: - 'True' - 'False' description: 有効化・無効化の選択 PrivateHostedZone: type: string description: ゾーン名 UpstreamDNS1: type: string description: フォワード先のDNSサーバ(1) UpstreamDNS2: type: string description: フォワード先のDNSサーバ(2) Models.Remark.ZoneRemark: type: object required: - ID properties: ID: type: string description: 'ゾーンID ゾーンIDとゾーン名の対応表は以下の通りです。 | ゾーンID | ゾーン名 | 説明 | |----------|----------|------| | 21001 | tk1a | 東京第1ゾーン | | 21002 | tk1b | 東京第2ゾーン | | 29001 | tk1v | サンドボックスゾーン | | 31001 | is1a | 石狩第1ゾーン | | 31002 | is1b | 石狩第2ゾーン | | 31003 | is1c | 石狩第3ゾーン |' Models.Settings.ApplianceSettings: type: object required: - ServiceEndpointGateway properties: ServiceEndpointGateway: allOf: - $ref: '#/components/schemas/Models.Settings.ServiceEndpointGatewaySettings' description: サービスエンドポイントゲートウェイの設定情報 Models.Appliance.CreateServiceEndpointGatewayRequest: type: object required: - Appliance properties: Appliance: $ref: '#/components/schemas/Models.Appliance.ApplianceCreateBody' examples: - Appliance: Class: serviceendpointgateway Plan: ID: 1 Remark: Switch: ID: '123456789012' Network: NetworkMaskLen: 24 Servers: - IPAddress: 192.0.2.15 Models.Remark.ServerRemark: type: object required: - IPAddress properties: IPAddress: type: string description: サーバーIPアドレス Models.Network.InterfaceSwitch: type: object required: - ID - Name - Scope - Subnet - UserSubnet properties: ID: type: string description: スイッチID Name: type: string description: スイッチ名 Scope: type: string enum: - user - shared description: スイッチのスコープ Subnet: anyOf: - $ref: '#/components/schemas/Models.Network.Subnet' - type: 'null' description: サブネット情報 UserSubnet: anyOf: - $ref: '#/components/schemas/Models.Network.UserSubnet' - type: 'null' description: ユーザーサブネット情報 Models.Common.DefaultErrorResponseBody: type: object properties: is_fatal: type: boolean serial: type: string status: type: string error_code: type: string error_msg: type: string x-refined-from: - seg-api.yaml - sakura-internet-seg-openapi.yml