{ "components": { "schemas": { "Models.Appliance.Appliance": { "properties": { "Availability": { "description": "稼働状態", "enum": [ "available", "unavailable", "migrating" ], "type": "string" }, "Class": { "description": "クラス名", "enum": [ "serviceendpointgateway" ], "type": "string" }, "CreatedAt": { "description": "作成日時", "type": "string" }, "Description": { "description": "説明", "type": "string" }, "Disk": { "allOf": [ { "$ref": "#/components/schemas/Models.Disk.Disk" } ], "description": "ディスク情報" }, "Generation": { "description": "世代", "format": "int32", "type": "integer" }, "ID": { "type": "string" }, "Icon": { "description": "アイコン情報", "type": "null" }, "Instance": { "allOf": [ { "$ref": "#/components/schemas/Models.Instance.Instance" } ], "description": "インスタンス情報" }, "Interfaces": { "description": "インターフェース情報", "items": { "$ref": "#/components/schemas/Models.Network.Interface" }, "type": "array" }, "Name": { "description": "名前", "type": "string" }, "Plan": { "allOf": [ { "$ref": "#/components/schemas/Models.Plan.Plan" } ], "description": "プラン情報" }, "Remark": { "allOf": [ { "$ref": "#/components/schemas/Models.Remark.ApplianceRemark" } ], "description": "備考情報" }, "ServiceClass": { "description": "サービスクラス", "enum": [ "cloud/appliance/serviceendpointgateway/1" ], "type": "string" }, "Settings": { "anyOf": [ { "$ref": "#/components/schemas/Models.Settings.ApplianceSettings" }, { "type": "null" } ], "description": "設定情報" }, "SettingsHash": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "設定情報のハッシュ値" }, "Switch": { "allOf": [ { "$ref": "#/components/schemas/Models.Network.Switch" } ], "description": "接続先スイッチ情報" }, "Tags": { "description": "タグ情報", "prefixItems": [], "type": "array" } }, "required": [ "ID", "Class", "Name", "Description", "Plan", "Settings", "SettingsHash", "Remark", "Availability", "Instance", "Disk", "ServiceClass", "Generation", "CreatedAt", "Icon", "Switch", "Interfaces", "Tags" ], "type": "object" }, "Models.Appliance.ApplianceCreateBody": { "properties": { "Class": { "description": "クラス名", "enum": [ "serviceendpointgateway" ], "type": "string" }, "Plan": { "allOf": [ { "$ref": "#/components/schemas/Models.Plan.Plan" } ], "description": "プラン情報" }, "Remark": { "allOf": [ { "$ref": "#/components/schemas/Models.Remark.ApplianceCreateRemark" } ], "description": "備考情報" } }, "required": [ "Class", "Plan", "Remark" ], "type": "object" }, "Models.Appliance.ApplianceUpdateBody": { "properties": { "Settings": { "allOf": [ { "$ref": "#/components/schemas/Models.Settings.ApplianceSettings" } ], "description": "設定情報" } }, "required": [ "Settings" ], "type": "object" }, "Models.Appliance.CreateServiceEndpointGatewayRequest": { "examples": [ { "Appliance": { "Class": "serviceendpointgateway", "Plan": { "ID": 1 }, "Remark": { "Network": { "NetworkMaskLen": 24 }, "Servers": [ { "IPAddress": "192.0.2.15" } ], "Switch": { "ID": "123456789012" } } } } ], "properties": { "Appliance": { "$ref": "#/components/schemas/Models.Appliance.ApplianceCreateBody" } }, "required": [ "Appliance" ], "type": "object" }, "Models.Appliance.CreateServiceEndpointGatewayResponseBody": { "examples": [ { "Appliance": { "Availability": "migrating", "Class": "serviceendpointgateway", "CreatedAt": "2026-02-09T23:40:29+09:00", "Description": "", "Disk": { "DedicatedStorageContract": { "ID": null }, "EncryptionAlgorithm": null, "EncryptionKey": { "KMSKeyID": null } }, "Generation": 100, "ID": "123456789012", "Icon": null, "Instance": { "Host": { "InfoURL": null, "Name": null }, "Hosts": [], "Status": null, "StatusChangedAt": null }, "Interfaces": [], "Name": "Service Endpoint Gateway (123456789012)", "Plan": { "ID": 1 }, "Remark": { "Network": { "NetworkMaskLen": 24 }, "Servers": [ { "IPAddress": "192.0.2.15" } ], "Switch": { "ID": "123456789012" }, "Zone": { "ID": "21001" } }, "ServiceClass": "cloud/appliance/serviceendpointgateway/1", "Settings": null, "SettingsHash": null, "Switch": { "Availability": "available", "ID": "123456789012", "Internet": { "BandWidthMbps": null }, "Name": "Switch", "Scope": "user", "Zone": { "ID": 21001, "Name": "tk1a", "Region": { "ID": 210, "Name": "東京" } } }, "Tags": [] }, "is_ok": true } ], "properties": { "Appliance": { "allOf": [ { "$ref": "#/components/schemas/Models.Appliance.Appliance" } ], "description": "サービスエンドポイントゲートウェイ情報" }, "is_ok": { "description": "操作結果", "type": "boolean" } }, "required": [ "Appliance", "is_ok" ], "type": "object" }, "Models.Appliance.ListServiceEndpointGatewaysResponseBody": { "examples": [ { "Appliances": [ { "Availability": "available", "Class": "serviceendpointgateway", "CreatedAt": "2024-01-01T00:00:00+09:00", "Description": "", "Disk": { "DedicatedStorageContract": null, "EncryptionAlgorithm": "none", "EncryptionKey": null }, "Generation": 100, "ID": "123456789012", "Icon": null, "Instance": { "Host": { "InfoURL": "", "Name": "sac-tk1a-sv001" }, "Hosts": [ { "InfoURL": "", "Name": "sac-tk1a-sv001" } ], "Status": "up", "StatusChangedAt": "2024-01-01T00:00:00+09:00" }, "Interfaces": [ { "HostName": null, "IPAddress": "203.0.113.100", "Switch": { "ID": "123456789012", "Name": "Switch", "Scope": "shared", "Subnet": { "DefaultRoute": "203.0.113.1", "Internet": { "BandWidthMbps": 100 }, "NetworkAddress": "203.0.113.0", "NetworkMaskLen": 24 }, "UserSubnet": { "DefaultRoute": "203.0.113.1", "NetworkMaskLen": 24 } }, "UserIPAddress": null }, { "HostName": null, "IPAddress": null, "Switch": { "ID": "123456789012", "Name": "SwitchForSEG", "Scope": "user", "Subnet": null, "UserSubnet": { "DefaultRoute": "192.0.2.1", "NetworkMaskLen": 24 } }, "UserIPAddress": "192.0.2.15" } ], "Name": "Service Endpoint Gateway (123456789012)", "Plan": { "ID": 1 }, "Remark": { "Network": { "NetworkMaskLen": 24 }, "Servers": [ { "IPAddress": "192.0.2.15" } ], "Switch": { "ID": "123456789012" }, "Zone": { "ID": "21001" } }, "ServiceClass": "cloud/appliance/serviceendpointgateway/1", "Settings": { "ServiceEndpointGateway": { "DNSForwarding": { "Enabled": "True", "PrivateHostedZone": "internal.example.com", "UpstreamDNS1": "ns1.gslbN.sakura.ne.jp", "UpstreamDNS2": "ns2.gslbN.sakura.ne.jp" }, "EnabledServices": [ { "Config": { "Endpoints": [ "s3.isk01.sakurastorage.jp" ] }, "Type": "ObjectStorage" }, { "Config": { "Mode": "Managed" }, "Type": "AppRunDedicatedControlPlane" } ], "MonitoringSuite": { "Enabled": "True" } } }, "SettingsHash": "abcdef1234567890abcdef1234567890", "Switch": { "Availability": "available", "ID": "123456789012", "Internet": null, "Name": "Switch1", "Scope": "user", "Zone": { "ID": 21001, "Name": "tk1a", "Region": { "ID": 210, "Name": "東京" } } }, "Tags": [] } ], "Count": 1, "From": 0, "Total": 1, "is_ok": true } ], "properties": { "Appliances": { "description": "サービスエンドポイントゲートウェイ情報一覧", "items": { "$ref": "#/components/schemas/Models.Appliance.Appliance" }, "type": "array" }, "Count": { "description": "取得件数", "format": "int32", "type": "integer" }, "From": { "description": "取得開始位置", "format": "int32", "type": "integer" }, "Total": { "description": "総件数", "format": "int32", "type": "integer" }, "is_ok": { "description": "操作結果", "type": "boolean" } }, "required": [ "From", "Count", "Total", "Appliances", "is_ok" ], "type": "object" }, "Models.Appliance.ReadServiceEndpointGatewayInterfaceResponseBody": { "examples": [ { "Interface": { "IPAddress": "203.0.113.100", "Switch": { "Scope": "shared" }, "UserIPAddress": null }, "is_ok": true } ], "properties": { "Interface": { "allOf": [ { "$ref": "#/components/schemas/Models.Network.SimpleInterface" } ], "description": "サービスエンドポイントゲートウェイのインターフェース情報" }, "is_ok": { "description": "操作結果", "type": "boolean" } }, "required": [ "Interface", "is_ok" ], "type": "object" }, "Models.Appliance.ReadServiceEndpointGatewayResponseBody": { "examples": [ { "Appliance": { "Availability": "available", "Class": "serviceendpointgateway", "CreatedAt": "2024-01-01T00:00:00+09:00", "Description": "", "Disk": { "DedicatedStorageContract": null, "EncryptionAlgorithm": "none", "EncryptionKey": null }, "Generation": 100, "ID": "123456789012", "Icon": null, "Instance": { "Host": { "InfoURL": "", "Name": "sac-tk1a-sv001" }, "Hosts": [ { "InfoURL": "", "Name": "sac-tk1a-sv001" } ], "Status": "up", "StatusChangedAt": "2024-01-01T00:00:00+09:00" }, "Interfaces": [ { "HostName": null, "IPAddress": "203.0.113.100", "Switch": { "ID": "123456789012", "Name": "Switch", "Scope": "shared", "Subnet": { "DefaultRoute": "203.0.113.1", "Internet": { "BandWidthMbps": 100 }, "NetworkAddress": "203.0.113.0", "NetworkMaskLen": 24 }, "UserSubnet": { "DefaultRoute": "203.0.113.1", "NetworkMaskLen": 24 } }, "UserIPAddress": null }, { "HostName": null, "IPAddress": null, "Switch": { "ID": "123456789012", "Name": "SwitchForSEG", "Scope": "user", "Subnet": null, "UserSubnet": { "DefaultRoute": "192.0.2.1", "NetworkMaskLen": 24 } }, "UserIPAddress": "192.0.2.15" } ], "Name": "Service Endpoint Gateway (123456789012)", "Plan": { "ID": 1 }, "Remark": { "Network": { "NetworkMaskLen": 24 }, "Servers": [ { "IPAddress": "192.0.2.15" } ], "Switch": { "ID": "123456789012" }, "Zone": { "ID": "21001" } }, "ServiceClass": "cloud/appliance/serviceendpointgateway/1", "Settings": { "ServiceEndpointGateway": { "DNSForwarding": { "Enabled": "True", "PrivateHostedZone": "internal.example.com", "UpstreamDNS1": "ns1.gslbN.sakura.ne.jp", "UpstreamDNS2": "ns2.gslbN.sakura.ne.jp" }, "EnabledServices": [ { "Config": { "Endpoints": [ "s3.isk01.sakurastorage.jp" ] }, "Type": "ObjectStorage" }, { "Config": { "Mode": "Managed" }, "Type": "AppRunDedicatedControlPlane" } ], "MonitoringSuite": { "Enabled": "True" } } }, "SettingsHash": "abcdef1234567890abcdef1234567890", "Switch": { "Availability": "available", "ID": "123456789012", "Internet": null, "Name": "Switch1", "Scope": "user", "Zone": { "ID": 21001, "Name": "tk1a", "Region": { "ID": 210, "Name": "東京" } } }, "Tags": [] }, "is_ok": true } ], "properties": { "Appliance": { "allOf": [ { "$ref": "#/components/schemas/Models.Appliance.Appliance" } ], "description": "サービスエンドポイントゲートウェイ情報" }, "is_ok": { "description": "操作結果", "type": "boolean" } }, "required": [ "Appliance", "is_ok" ], "type": "object" }, "Models.Appliance.UpdateServiceEndpointGatewayRequest": { "examples": [ { "Appliance": { "Settings": { "ServiceEndpointGateway": { "DNSForwarding": { "Enabled": "True", "PrivateHostedZone": "internal.example.com", "UpstreamDNS1": "ns1.gslbN.sakura.ne.jp", "UpstreamDNS2": "ns2.gslbN.sakura.ne.jp" }, "EnabledServices": [ { "Config": { "Endpoints": [ "s3.isk01.sakurastorage.jp" ] }, "Type": "ObjectStorage" }, { "Config": { "Mode": "Managed" }, "Type": "AppRunDedicatedControlPlane" } ], "MonitoringSuite": { "Enabled": "True" } } } } } ], "properties": { "Appliance": { "$ref": "#/components/schemas/Models.Appliance.ApplianceUpdateBody" } }, "required": [ "Appliance" ], "type": "object" }, "Models.Common.DefaultErrorResponseBody": { "properties": { "error_code": { "type": "string" }, "error_msg": { "type": "string" }, "is_fatal": { "type": "boolean" }, "serial": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "Models.Disk.DedicatedStorageContract": { "properties": { "ID": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "契約ID" } }, "required": [ "ID" ], "type": "object" }, "Models.Disk.Disk": { "properties": { "DedicatedStorageContract": { "anyOf": [ { "$ref": "#/components/schemas/Models.Disk.DedicatedStorageContract" }, { "type": "null" } ], "description": "専用ストレージ契約情報" }, "EncryptionAlgorithm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "暗号化アルゴリズム" }, "EncryptionKey": { "anyOf": [ { "$ref": "#/components/schemas/Models.Disk.EncryptionKey" }, { "type": "null" } ], "description": "暗号化キー情報" } }, "required": [ "EncryptionAlgorithm", "EncryptionKey", "DedicatedStorageContract" ], "type": "object" }, "Models.Disk.EncryptionKey": { "properties": { "KMSKeyID": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "KMSキーID" } }, "required": [ "KMSKeyID" ], "type": "object" }, "Models.Instance.HostInfo": { "properties": { "InfoURL": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ホスト情報のURL" }, "Name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ホスト名" } }, "required": [ "Name", "InfoURL" ], "type": "object" }, "Models.Instance.Instance": { "properties": { "Host": { "allOf": [ { "$ref": "#/components/schemas/Models.Instance.HostInfo" } ], "description": "ホスト情報" }, "Hosts": { "description": "ホスト情報一覧", "items": { "$ref": "#/components/schemas/Models.Instance.HostInfo" }, "type": "array" }, "Status": { "anyOf": [ { "enum": [ "up", "down", "cleaning" ], "type": "string" }, { "type": "null" } ], "description": "インスタンスの稼働状態" }, "StatusChangedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "状態変更日時" } }, "required": [ "Status", "StatusChangedAt", "Host", "Hosts" ], "type": "object" }, "Models.Instance.InstanceForPower": { "properties": { "Status": { "description": "稼働状態", "enum": [ "up", "down", "cleaning" ], "type": "string" } }, "required": [ "Status" ], "type": "object" }, "Models.Network.Interface": { "properties": { "HostName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ホスト名" }, "IPAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IPアドレス" }, "Switch": { "allOf": [ { "$ref": "#/components/schemas/Models.Network.InterfaceSwitch" } ], "description": "スイッチ情報" }, "UserIPAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ユーザーIPアドレス" } }, "required": [ "IPAddress", "UserIPAddress", "HostName", "Switch" ], "type": "object" }, "Models.Network.InterfaceSwitch": { "properties": { "ID": { "description": "スイッチID", "type": "string" }, "Name": { "description": "スイッチ名", "type": "string" }, "Scope": { "description": "スイッチのスコープ", "enum": [ "user", "shared" ], "type": "string" }, "Subnet": { "anyOf": [ { "$ref": "#/components/schemas/Models.Network.Subnet" }, { "type": "null" } ], "description": "サブネット情報" }, "UserSubnet": { "allOf": [ { "$ref": "#/components/schemas/Models.Network.UserSubnet" } ], "description": "ユーザーサブネット情報" } }, "required": [ "ID", "Name", "Scope", "Subnet", "UserSubnet" ], "type": "object" }, "Models.Network.InternetInfo": { "properties": { "BandWidthMbps": { "anyOf": [ { "format": "int32", "type": "integer" }, { "type": "null" } ], "description": "帯域幅（Mbps）" } }, "required": [ "BandWidthMbps" ], "type": "object" }, "Models.Network.Region": { "properties": { "ID": { "description": "リージョンID\n\nリージョンIDとリージョン名の対応表は以下の通りです。\n| リージョンID | リージョン名 | 説明 |\n|-------------|---------------|------|\n| 210 | 東京 | 東京リージョン |\n| 310 | 石狩 | 石狩リージョン |", "format": "int32", "type": "integer" }, "Name": { "description": "リージョン名", "type": "string" } }, "required": [ "ID", "Name" ], "type": "object" }, "Models.Network.SimpleInterface": { "properties": { "IPAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IPアドレス" }, "Switch": { "description": "スイッチ情報", "properties": { "Scope": { "description": "スイッチのスコープ", "enum": [ "user", "shared" ], "type": "string" } }, "required": [ "Scope" ], "type": "object" }, "UserIPAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ユーザーIPアドレス" } }, "required": [ "IPAddress", "UserIPAddress", "Switch" ], "type": "object" }, "Models.Network.Subnet": { "properties": { "DefaultRoute": { "description": "デフォルトルート", "type": "string" }, "Internet": { "allOf": [ { "$ref": "#/components/schemas/Models.Network.InternetInfo" } ], "description": "インターネット接続情報" }, "NetworkAddress": { "description": "ネットワークアドレス", "type": "string" }, "NetworkMaskLen": { "description": "ネットマスク長", "format": "int32", "type": "integer" } }, "required": [ "NetworkAddress", "NetworkMaskLen", "DefaultRoute", "Internet" ], "type": "object" }, "Models.Network.Switch": { "properties": { "Availability": { "description": "稼働状態", "enum": [ "available", "unavailable" ], "type": "string" }, "ID": { "description": "スイッチID", "type": "string" }, "Internet": { "anyOf": [ { "$ref": "#/components/schemas/Models.Network.InternetInfo" }, { "type": "null" } ], "description": "インターネット接続情報" }, "Name": { "description": "スイッチ名", "type": "string" }, "Scope": { "description": "スイッチのスコープ", "enum": [ "user", "shared" ], "type": "string" }, "Zone": { "allOf": [ { "$ref": "#/components/schemas/Models.Network.Zone" } ], "description": "スイッチのゾーン情報" } }, "required": [ "ID", "Name", "Internet", "Scope", "Availability", "Zone" ], "type": "object" }, "Models.Network.UserSubnet": { "properties": { "DefaultRoute": { "description": "デフォルトルート", "type": "string" }, "NetworkMaskLen": { "description": "ネットマスク長", "format": "int32", "type": "integer" } }, "required": [ "DefaultRoute", "NetworkMaskLen" ], "type": "object" }, "Models.Network.Zone": { "properties": { "ID": { "description": "ゾーンID\n\nゾーンIDとゾーン名の対応表は以下の通りです。\n\n| ゾーンID | ゾーン名 | 説明 |\n|---------|---------|------|\n| 21001 | tk1a | 東京第1ゾーン |\n| 21002 | tk1b | 東京第2ゾーン |\n| 29001 | tk1v | サンドボックスゾーン名 |\n| 31001 | is1a | 石狩第1ゾーン |\n| 31002 | is1b | 石狩第2ゾーン |\n| 31003 | is1c | 石狩第3ゾーン |", "format": "int32", "type": "integer" }, "Name": { "description": "ゾーン名", "type": "string" }, "Region": { "allOf": [ { "$ref": "#/components/schemas/Models.Network.Region" } ], "description": "リージョン情報" } }, "required": [ "ID", "Name", "Region" ], "type": "object" }, "Models.Plan.Plan": { "properties": { "ID": { "description": "プランID", "enum": [ 1 ], "type": "number" } }, "required": [ "ID" ], "type": "object" }, "Models.Power.ReadServiceEndpointGatewayPowerStatusResponseBody": { "examples": [ { "Instance": { "Status": "up" }, "is_ok": true } ], "properties": { "Instance": { "allOf": [ { "$ref": "#/components/schemas/Models.Instance.InstanceForPower" } ], "description": "サービスエンドポイントゲートウェイの稼働状態情報" }, "is_ok": { "description": "操作結果", "type": "boolean" } }, "required": [ "Instance", "is_ok" ], "type": "object" }, "Models.Power.UpdateServiceEndpointGatewayPowerStatusResponseBody": { "examples": [ { "Success": true, "is_ok": true } ], "properties": { "Success": { "anyOf": [ { "type": "boolean" }, { "type": "string" } ] }, "is_ok": { "description": "操作結果", "type": "boolean" } }, "required": [ "Success", "is_ok" ], "type": "object" }, "Models.Remark.ApplianceCreateRemark": { "properties": { "Network": { "allOf": [ { "$ref": "#/components/schemas/Models.Remark.NetworkRemark" } ], "description": "ネットワーク情報" }, "Servers": { "description": "サーバー情報", "items": { "$ref": "#/components/schemas/Models.Remark.ServerRemark" }, "type": "array" }, "Switch": { "allOf": [ { "$ref": "#/components/schemas/Models.Remark.SwitchRemark" } ], "description": "スイッチ情報" } }, "required": [ "Switch", "Network", "Servers" ], "type": "object" }, "Models.Remark.ApplianceRemark": { "properties": { "Network": { "allOf": [ { "$ref": "#/components/schemas/Models.Remark.NetworkRemark" } ], "description": "ネットワーク情報" }, "Servers": { "description": "サーバー情報", "items": { "$ref": "#/components/schemas/Models.Remark.ServerRemark" }, "type": "array" }, "Switch": { "allOf": [ { "$ref": "#/components/schemas/Models.Remark.SwitchRemark" } ], "description": "スイッチ情報" }, "Zone": { "allOf": [ { "$ref": "#/components/schemas/Models.Remark.ZoneRemark" } ], "description": "ゾーン情報" } }, "required": [ "Switch", "Network", "Servers", "Zone" ], "type": "object" }, "Models.Remark.NetworkRemark": { "properties": { "NetworkMaskLen": { "description": "ネットワークマスク長", "format": "int32", "type": "integer" } }, "required": [ "NetworkMaskLen" ], "type": "object" }, "Models.Remark.ServerRemark": { "properties": { "IPAddress": { "description": "サーバーIPアドレス", "type": "string" } }, "required": [ "IPAddress" ], "type": "object" }, "Models.Remark.SwitchRemark": { "properties": { "ID": { "description": "スイッチID", "type": "string" } }, "required": [ "ID" ], "type": "object" }, "Models.Remark.ZoneRemark": { "properties": { "ID": { "description": "ゾーンID\n\nゾーンIDとゾーン名の対応表は以下の通りです。\n| ゾーンID | ゾーン名 | 説明 |\n|----------|----------|------|\n| 21001 | tk1a | 東京第1ゾーン |\n| 21002 | tk1b | 東京第2ゾーン |\n| 29001 | tk1v | サンドボックスゾーン |\n| 31001 | is1a | 石狩第1ゾーン |\n| 31002 | is1b | 石狩第2ゾーン |\n| 31003 | is1c | 石狩第3ゾーン |", "type": "string" } }, "required": [ "ID" ], "type": "object" }, "Models.Settings.ApplianceSettings": { "properties": { "ServiceEndpointGateway": { "allOf": [ { "$ref": "#/components/schemas/Models.Settings.ServiceEndpointGatewaySettings" } ], "description": "サービスエンドポイントゲートウェイの設定情報" } }, "required": [ "ServiceEndpointGateway" ], "type": "object" }, "Models.Settings.DNSForwardingSettings": { "properties": { "Enabled": { "description": "有効化・無効化の選択", "enum": [ "True", "False" ], "type": "string" }, "PrivateHostedZone": { "description": "ゾーン名", "type": "string" }, "UpstreamDNS1": { "description": "フォワード先のDNSサーバ(1)", "type": "string" }, "UpstreamDNS2": { "description": "フォワード先のDNSサーバ(2)", "type": "string" } }, "required": [ "Enabled", "PrivateHostedZone", "UpstreamDNS1", "UpstreamDNS2" ], "type": "object" }, "Models.Settings.EnabledService": { "properties": { "Config": { "allOf": [ { "$ref": "#/components/schemas/Models.Settings.ServiceConfig" } ], "description": "接続先マネージドサービスの設定" }, "Type": { "description": "接続先マネージドサービス\n\n| Type | 説明 |\n|---|---|\n| ObjectStorage | オブジェクトストレージ |\n| ContainerRegistry | コンテナレジストリ |\n| MonitoringSuite | モニタリングスイート |\n| AppRunDedicatedControlPlane | AppRun専有型コントロールプレーン |", "enum": [ "ObjectStorage", "ContainerRegistry", "MonitoringSuite", "AppRunDedicatedControlPlane" ], "type": "string" } }, "required": [ "Type", "Config" ], "type": "object" }, "Models.Settings.MonitoringSuiteSettings": { "properties": { "Enabled": { "description": "有効化・無効化の選択", "enum": [ "True", "False" ], "type": "string" } }, "required": [ "Enabled" ], "type": "object" }, "Models.Settings.ServiceConfig": { "properties": { "Endpoints": { "description": "### ObjectStorage Type\nエンドポイントは以下に限定されます。\n\n| 名前 | エンドポイント |\n|---|---|\n| 石狩第1サイト | `s3.isk01.sakurastorage.jp` |\n| 東京第1サイト | `s3.tky01.sakurastorage.jp` |\n| 東京第1サイト（アーカイブプラン） | `s3.arc02.sakurastorage.jp` |\n\n### ContainerRegistry Type\nsakuracr.jp のサブドメインを指定してください。\n\n### MonitoringSuite Type\nモニタリングスイートのログストレージ・メトリクスストレージのエンドポイントを指定してください。\n\n| ストレージ | エンドポイントの形式 |\n|---|---|\n| ログストレージ | `[0-9]{12}.logs.monitoring.global.api.sacloud.jp` |\n| メトリクスストレージ | `[0-9]{12}.metrics.monitoring.global.api.sacloud.jp` |\n\n### AppRunDedicatedControlPlane Type\nエンドポイントは指定できません。", "items": { "type": "string" }, "type": "array" }, "Mode": { "description": "接続先マネージドサービスのエンドポイントの自動設定モード。\n\nAppRunDedicatedControlPlaneのみ利用できます。", "enum": [ "Managed", "" ], "type": "string" } }, "type": "object" }, "Models.Settings.ServiceEndpointGatewaySettings": { "properties": { "DNSForwarding": { "allOf": [ { "$ref": "#/components/schemas/Models.Settings.DNSForwardingSettings" } ], "description": "DNSプライベートホストゾーンの設定" }, "EnabledServices": { "description": "接続先マネージドサービスの設定", "items": { "$ref": "#/components/schemas/Models.Settings.EnabledService" }, "type": "array" }, "MonitoringSuite": { "allOf": [ { "$ref": "#/components/schemas/Models.Settings.MonitoringSuiteSettings" } ], "description": "モニタリングスイート連携の設定" } }, "required": [ "EnabledServices" ], "type": "object" } } }, "info": { "contact": { "name": "SAKURA internet Inc.", "url": "https://www.sakura.ad.jp/" }, "description": "---\n「サービスエンドポイントゲートウェイ」が提供するAPIの利用方法とサンプルを公開しております。\n# 基本的な使い方\n## APIキーの発行\nAPIを利用するためには、認証のための「APIキー」が必要です。事前にキーを発行しておきます。\nAPIキーは「ユーザID」「パスワード」に相当する「トークン」と呼ばれる認証情報で構成されています。\n| 項目名 | APIキー発行時の項目名 | このドキュメント内での例 |\n|------------|------------------------------|--------------------------------------|\n| ユーザID | アクセストークン(UUID) | 01234567-89ab-cdef-0123-456789abcdef |\n| パスワード | アクセストークンシークレット | SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM |\n\u003cdiv class=\"warning\"\u003e\n \u003cb\u003e操作マニュアル\u003c/b\u003e\u003cbr /\u003e\n \u003cul\u003e\u003cli\u003e\u003ca href=\"https://manual.sakura.ad.jp/cloud/api/apikey.html\"\u003eAPIキー | さくらのクラウド ドキュメント\u003c/a\u003e\u003c/li\u003e\u003c/ul\u003e\n\u003c/div\u003e\n\n## APIエンドポイント\n| ゾーン名 | APIエンドポイントURL |\n|---------------|-----------------------------------------------------------|\n| 東京第1ゾーン | https://secure.sakura.ad.jp/cloud/zone/tk1a/api/cloud/1.1 |\n| 東京第2ゾーン | https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1 |\n| サンドボックスゾーン | https://secure.sakura.ad.jp/cloud/zone/tk1v/api/cloud/1.1 |\n| 石狩第1ゾーン | https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1 |\n| 石狩第2ゾーン | https://secure.sakura.ad.jp/cloud/zone/is1b/api/cloud/1.1 |\n| 石狩第3ゾーン | https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1 |\n\n## 入力パラメータ\nAPIの入力には送信先URLに対して、いくつかのヘッダーとAPIキーを送信します。\n\n- 認証方式はHTTP Basic認証です。APIキーのアクセストークンをユーザーID、アクセストークンシークレットをパスワードとして指定します。\n\n```\n# 入力サンプル\ncurl \\\n -u '01234567-89ab-cdef-0123-456789abcdef:SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM' \\\n -X GET \\\n 'https://secure.sakura.ad.jp/cloud/zone/tk1a/api/cloud/1.1/appliances'\n```", "license": { "name": "Copyright(C) SAKURA internet Inc. all rights reserved." }, "title": "Service Endpoint Gateway API", "version": "1.1.0" }, "openapi": "3.1.0", "paths": { "/appliance": { "get": { "description": "サービスエンドポイントゲートウェイの一覧を取得します。", "operationId": "listServiceEndpointGateways", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Appliance.ListServiceEndpointGatewaysResponseBody" } } }, "description": "成功時のレスポンス" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Common.DefaultErrorResponseBody" } } }, "description": "デフォルトのエラーレスポンス" } }, "summary": "サービスエンドポイントゲートウェイ一覧取得API", "tags": [ "ServiceEndpointGateway" ] }, "post": { "description": "指定したサービスエンドポイントゲートウェイを作成します。", "operationId": "createServiceEndpointGateway", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Appliance.CreateServiceEndpointGatewayRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Appliance.CreateServiceEndpointGatewayResponseBody" } } }, "description": "成功時のレスポンス" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Common.DefaultErrorResponseBody" } } }, "description": "デフォルトのエラーレスポンス" } }, "summary": "サービスエンドポイントゲートウェイ作成API", "tags": [ "ServiceEndpointGateway" ] } }, "/appliance/{applianceID}": { "delete": { "description": "指定したサービスエンドポイントゲートウェイを削除します。", "operationId": "deleteServiceEndpointGateway", "parameters": [ { "in": "path", "name": "applianceID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Appliance.ReadServiceEndpointGatewayResponseBody" } } }, "description": "成功時のレスポンス" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Common.DefaultErrorResponseBody" } } }, "description": "デフォルトのエラーレスポンス" } }, "summary": "サービスエンドポイントゲートウェイ削除API", "tags": [ "ServiceEndpointGateway" ] }, "get": { "description": "指定したサービスエンドポイントゲートウェイの情報を取得します。", "operationId": "readServiceEndpointGateway", "parameters": [ { "in": "path", "name": "applianceID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Appliance.ReadServiceEndpointGatewayResponseBody" } } }, "description": "成功時のレスポンス" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Common.DefaultErrorResponseBody" } } }, "description": "デフォルトのエラーレスポンス" } }, "summary": "サービスエンドポイントゲートウェイ取得API", "tags": [ "ServiceEndpointGateway" ] }, "put": { "description": "指定したサービスエンドポイントゲートウェイの情報を更新します。\n\n更新後には、別途「サービスエンドポイントゲートウェイ適用API」を呼び出して設定を反映する必要があります。", "operationId": "updateServiceEndpointGateway", "parameters": [ { "in": "path", "name": "applianceID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Appliance.UpdateServiceEndpointGatewayRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Appliance.ReadServiceEndpointGatewayResponseBody" } } }, "description": "成功時のレスポンス" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Common.DefaultErrorResponseBody" } } }, "description": "デフォルトのエラーレスポンス" } }, "summary": "サービスエンドポイントゲートウェイ更新API", "tags": [ "ServiceEndpointGateway" ] } }, "/appliance/{applianceID}/config": { "put": { "description": "指定したサービスエンドポイントゲートウェイの情報を適用します。", "operationId": "applyServiceEndpointGatewayConfig", "parameters": [ { "in": "path", "name": "applianceID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Appliance.UpdateServiceEndpointGatewayRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Appliance.ReadServiceEndpointGatewayResponseBody" } } }, "description": "成功時のレスポンス" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Common.DefaultErrorResponseBody" } } }, "description": "デフォルトのエラーレスポンス" } }, "summary": "サービスエンドポイントゲートウェイ適用API", "tags": [ "ServiceEndpointGateway" ] } }, "/appliance/{applianceID}/interface/{interfaceID}": { "get": { "description": "指定したサービスエンドポイントゲートウェイのインターフェース情報を取得します。", "operationId": "readServiceEndpointGatewayInterface", "parameters": [ { "in": "path", "name": "applianceID", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "interfaceID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Appliance.ReadServiceEndpointGatewayInterfaceResponseBody" } } }, "description": "成功時のレスポンス" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Common.DefaultErrorResponseBody" } } }, "description": "デフォルトのエラーレスポンス" } }, "summary": "サービスエンドポイントゲートウェイインターフェース情報取得API", "tags": [ "インターフェース管理" ] } }, "/appliance/{applianceID}/power": { "delete": { "description": "指定したサービスエンドポイントゲートウェイを停止します。", "operationId": "powerOffServiceEndpointGateway", "parameters": [ { "in": "path", "name": "applianceID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Power.UpdateServiceEndpointGatewayPowerStatusResponseBody" } } }, "description": "成功時のレスポンス" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Common.DefaultErrorResponseBody" } } }, "description": "デフォルトのエラーレスポンス" } }, "summary": "サービスエンドポイントゲートウェイ停止API", "tags": [ "起動状態管理" ] }, "get": { "description": "指定したサービスエンドポイントゲートウェイの起動状態を取得します。", "operationId": "readServiceEndpointGatewayPowerStatus", "parameters": [ { "in": "path", "name": "applianceID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Power.ReadServiceEndpointGatewayPowerStatusResponseBody" } } }, "description": "成功時のレスポンス" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Common.DefaultErrorResponseBody" } } }, "description": "デフォルトのエラーレスポンス" } }, "summary": "サービスエンドポイントゲートウェイ起動状態取得API", "tags": [ "起動状態管理" ] }, "put": { "description": "指定したサービスエンドポイントゲートウェイを起動します。", "operationId": "powerOnServiceEndpointGateway", "parameters": [ { "in": "path", "name": "applianceID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Power.UpdateServiceEndpointGatewayPowerStatusResponseBody" } } }, "description": "成功時のレスポンス" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Common.DefaultErrorResponseBody" } } }, "description": "デフォルトのエラーレスポンス" } }, "summary": "サービスエンドポイントゲートウェイ起動API", "tags": [ "起動状態管理" ] } }, "/appliance/{applianceID}/reset": { "put": { "description": "指定したサービスエンドポイントゲートウェイの起動状態をリセットします。", "operationId": "resetServiceEndpointGateway", "parameters": [ { "in": "path", "name": "applianceID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Power.UpdateServiceEndpointGatewayPowerStatusResponseBody" } } }, "description": "成功時のレスポンス" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Models.Common.DefaultErrorResponseBody" } } }, "description": "デフォルトのエラーレスポンス" } }, "summary": "サービスエンドポイントゲートウェイ起動状態リセットAPI", "tags": [ "起動状態管理" ] } } }, "servers": [ { "description": "さくらのクラウド（石狩第3ゾーン）APIエンドポイント", "url": "https://secure.sakura.ad.jp/cloud/zone/is1c/api/cloud/1.1", "variables": {} }, { "description": "さくらのクラウド（石狩第2ゾーン）APIエンドポイント", "url": "https://secure.sakura.ad.jp/cloud/zone/is1b/api/cloud/1.1", "variables": {} }, { "description": "さくらのクラウド（石狩第1ゾーン）APIエンドポイント", "url": "https://secure.sakura.ad.jp/cloud/zone/is1a/api/cloud/1.1", "variables": {} }, { "description": "さくらのクラウド（サンドボックスゾーン）APIエンドポイント", "url": "https://secure.sakura.ad.jp/cloud/zone/tk1v/api/cloud/1.1", "variables": {} }, { "description": "さくらのクラウド（東京第2ゾーン）APIエンドポイント", "url": "https://secure.sakura.ad.jp/cloud/zone/tk1b/api/cloud/1.1", "variables": {} }, { "description": "さくらのクラウド（東京第1ゾーン）APIエンドポイント", "url": "https://secure.sakura.ad.jp/cloud/zone/tk1a/api/cloud/1.1", "variables": {} } ], "tags": [ { "description": "サービスエンドポイントゲートウェイのインターフェースに関する操作をまとめたタグです。", "name": "インターフェース管理" }, { "description": "サービスエンドポイントゲートウェイの起動状態に関する操作（起動・停止・リセットなど）をまとめたタグです。", "name": "起動状態管理" }, { "description": "Service Endpoint Gateway に関する操作（一覧・取得など）をまとめたタグです。", "name": "ServiceEndpointGateway" } ] }