Download OpenAPI specification:Download
「NoSQL」が提供するAPIの利用方法とサンプルを公開しております。
APIを利用するためには、認証のための「APIキー」が必要です。事前にキーを発行しておきます。
APIキーは「ユーザーID」「パスワード」に相当する「トークン」と呼ばれる認証情報で構成されています。
項目名 | APIキー発行時の項目名 | このドキュメント内での例 |
---|---|---|
ユーザーID | アクセストークン(UUID) | 01234567-89ab-cdef-0123-456789abcdef |
パスワード | アクセストークンシークレット | SAMPLETOKENSAMPLETOKENSAMPLETOKENSAM |
NoSQLの一覧取得を行います。
Filter.Appliance.Class required | string <string> Example: Filter.Appliance.Class=nosql Class固定 |
{- "From": 0,
- "Count": 1,
- "Total": 1,
- "Appliances": [
- {
- "Class": "nosql",
- "Name": "CassandraName",
- "Description": "説明",
- "Tags": [
- "tag1"
], - "ID": "113600097295",
- "Plan": {
- "ID": 51004
}, - "Settings": {
- "Backup": {
- "Connect": "nfs://192.168.100.250/export",
- "DayOfWeek": [
- "sun",
- "mon"
], - "Time": "00:00",
- "Rotate": 3
}, - "SourceNetwork": [
- "192.168.100.200",
- "192.168.100.201",
- "192.168.100.202"
]
}, - "SettingsHash": "d41d8cd98f00b204e9800998ecf8427e",
- "Remark": {
- "Nosql": {
- "DatabaseEngine": "Cassandra",
- "DatabaseVersion": "4",
- "DefaultUser": "defaultUser01",
- "DiskSize": 102400,
- "Memory": 8192,
- "Nodes": 3,
- "Port": 9042,
- "Storage": "SSD",
- "Virtualcore": 3
}, - "Servers": [
- {
- "UserIPAddress": "192.168.100.11"
}
], - "Zone": {
- "ID": "30293"
}, - "ServiceClass": "cloud/nosql/beta"
}, - "Availability": "available",
- "Instance": {
- "Status": "up",
- "StatusChangedAt": "2021-01-01T00:00:00Z",
- "Host": {
- "Name": "host_name",
- "InfoURL": ""
}, - "Hosts": [
- {
- "Name": "string",
- "InfoURL": "string"
}
]
}, - "Disk": {
- "EncryptionAlgorithm": "none"
}, - "ServiceClass": "cloud/nosql/beta",
- "Generation": 200,
- "CreatedAt": "2021-01-01T00:00:00Z",
- "Icon": null,
- "Switch": null,
- "Interfaces": [
- {
- "IPAddress": "163.43.142.254",
- "UserIPAddress": "192.168.100.11",
- "HostName": null,
- "Switch": {
- "ID": "113600097295",
- "name": "switch_name",
- "Scope": "user",
- "Subnet": {
- "NetworkAddress": "163.43.142.0",
- "NetworkMaskLen": 24,
- "DefaultRoute": "163.43.142.1",
- "Internet": {
- "BandWidthMbps": 100
}
}, - "UserSubnet": {
- "DefaultRoute": "192.168.100.254",
- "NetworkMaskLen": 24
}
}
}
]
}
], - "is_ok": true
}
NoSQLの作成を行います。
NoSQLの作成を行うためのリクエストボディ
object |
{- "Appliance": {
- "Class": "nosql",
- "Name": "CassandraName",
- "Description": "説明",
- "Tags": [
- "tag1"
], - "ServiceClass": "cloud/nosql/beta",
- "Plan": {
- "ID": 51004
}, - "Settings": {
- "Backup": {
- "Connect": "nfs://192.168.100.250/export",
- "DayOfWeek": [
- "sun",
- "mon"
], - "Time": "00:00",
- "Rotate": 3
}, - "SourceNetwork": [
- "192.168.100.200",
- "192.168.100.201",
- "192.168.100.202"
], - "Password:": "Default-Password01"
}, - "Remark": {
- "Nosql": {
- "DatabaseEngine": "Cassandra",
- "DatabaseVersion": "4",
- "DefaultUser": "defaultUser01",
- "DiskSize": 102400,
- "Memory": 8192,
- "Nodes": 3,
- "Port": 9042,
- "Storage": "SSD",
- "Virtualcore": 3
}, - "Servers": [
- {
- "UserIPAddress": "192.168.100.11"
}
]
}, - "UserInterfaces": [
- {
- "Switch": {
- "ID": "113600097295"
}, - "UserIPAddress1": "192.168.100.11",
- "UserIPAddress2": "192.168.100.12",
- "UserIPAddress3": "192.168.100.13",
- "UserSubnet": {
- "DefaultRoute": "192.168.100.254",
- "NetworkMaskLen": 24
}
}
]
}
}
{- "Appliance": {
- "Class": "nosql",
- "Name": "CassandraName",
- "Description": "説明",
- "Tags": [
- "tag1"
], - "ID": "113600097295",
- "Plan": {
- "ID": 51004
}, - "Settings": {
- "Backup": {
- "Connect": "nfs://192.168.100.250/export",
- "DayOfWeek": [
- "sun",
- "mon"
], - "Time": "00:00",
- "Rotate": 3
}, - "SourceNetwork": [
- "192.168.100.200",
- "192.168.100.201",
- "192.168.100.202"
]
}, - "SettingsHash": "d41d8cd98f00b204e9800998ecf8427e",
- "Remark": {
- "Nosql": {
- "DatabaseEngine": "Cassandra",
- "DatabaseVersion": "4",
- "DefaultUser": "defaultUser01",
- "DiskSize": 102400,
- "Memory": 8192,
- "Nodes": 3,
- "Port": 9042,
- "Storage": "SSD",
- "Virtualcore": 3
}, - "Servers": [
- {
- "UserIPAddress": "192.168.100.11"
}
], - "Zone": {
- "ID": "30293"
}, - "ServiceClass": "cloud/nosql/beta"
}, - "Availability": "available",
- "Instance": {
- "Status": "up",
- "StatusChangedAt": "2021-01-01T00:00:00Z",
- "Host": {
- "Name": "host_name",
- "InfoURL": ""
}, - "Hosts": [
- {
- "Name": "string",
- "InfoURL": "string"
}
]
}, - "Disk": {
- "EncryptionAlgorithm": "none"
}, - "ServiceClass": "cloud/nosql/beta",
- "Generation": 200,
- "CreatedAt": "2021-01-01T00:00:00Z",
- "Icon": null,
- "Switch": null,
- "Interfaces": [
- {
- "IPAddress": "163.43.142.254",
- "UserIPAddress": "192.168.100.11",
- "HostName": null,
- "Switch": {
- "ID": "113600097295",
- "name": "switch_name",
- "Scope": "user",
- "Subnet": {
- "NetworkAddress": "163.43.142.0",
- "NetworkMaskLen": 24,
- "DefaultRoute": "163.43.142.1",
- "Internet": {
- "BandWidthMbps": 100
}
}, - "UserSubnet": {
- "DefaultRoute": "192.168.100.254",
- "NetworkMaskLen": 24
}
}
}
]
}, - "Class": "nosql",
- "Name": "CassandraName",
- "Description": "説明",
- "Plan": {
- "ID": 51004
}, - "Settings": {
- "Backup": {
- "Connect": "nfs://192.168.100.250/export",
- "DayOfWeek": [
- "sun",
- "mon"
], - "Time": "00:00",
- "Rotate": 3
}, - "SourceNetwork": [
- "192.168.100.200",
- "192.168.100.201",
- "192.168.100.202"
]
}, - "Remark": {
- "Nosql": {
- "DatabaseEngine": "Cassandra",
- "DatabaseVersion": "4",
- "DefaultUser": "defaultUser01",
- "DiskSize": 102400,
- "Memory": 8192,
- "Nodes": 3,
- "Port": 9042,
- "Storage": "SSD",
- "Virtualcore": 3
}, - "Servers": [
- {
- "UserIPAddress": "192.168.100.11"
}
]
}, - "ID": "113600097295",
- "Account": {
- "ID": "string"
}, - "Tags": [
- "tag1"
], - "Availability": "available",
- "ServerCount": 1,
- "HiddenRemark": {
- "PlanSpec": {
- "Note": {
- "ID": "string"
}, - "ServiceClass": "cloud/nosql/beta"
}, - "Encripted": {
- "Algorithm": "string",
- "IV": "string",
- "md5": "string",
- "Associative": true,
- "Data": "string"
}
}, - "Success": "Accepted",
- "is_ok": true
}
対象のNoSQLの取得を行います。
applianceID required | string Example: 113600102549 アプライアンスID |
{- "Appliance": {
- "Class": "nosql",
- "Name": "CassandraName",
- "Description": "説明",
- "Tags": [
- "tag1"
], - "ID": "113600097295",
- "Plan": {
- "ID": 51004
}, - "Settings": {
- "Backup": {
- "Connect": "nfs://192.168.100.250/export",
- "DayOfWeek": [
- "sun",
- "mon"
], - "Time": "00:00",
- "Rotate": 3
}, - "SourceNetwork": [
- "192.168.100.200",
- "192.168.100.201",
- "192.168.100.202"
]
}, - "SettingsHash": "d41d8cd98f00b204e9800998ecf8427e",
- "Remark": {
- "Nosql": {
- "DatabaseEngine": "Cassandra",
- "DatabaseVersion": "4",
- "DefaultUser": "defaultUser01",
- "DiskSize": 102400,
- "Memory": 8192,
- "Nodes": 3,
- "Port": 9042,
- "Storage": "SSD",
- "Virtualcore": 3
}, - "Servers": [
- {
- "UserIPAddress": "192.168.100.11"
}
], - "Zone": {
- "ID": "30293"
}, - "ServiceClass": "cloud/nosql/beta"
}, - "Availability": "available",
- "Instance": {
- "Status": "up",
- "StatusChangedAt": "2021-01-01T00:00:00Z",
- "Host": {
- "Name": "host_name",
- "InfoURL": ""
}, - "Hosts": [
- {
- "Name": "string",
- "InfoURL": "string"
}
]
}, - "Disk": {
- "EncryptionAlgorithm": "none"
}, - "ServiceClass": "cloud/nosql/beta",
- "Generation": 200,
- "CreatedAt": "2021-01-01T00:00:00Z",
- "Icon": null,
- "Switch": null,
- "Interfaces": [
- {
- "IPAddress": "163.43.142.254",
- "UserIPAddress": "192.168.100.11",
- "HostName": null,
- "Switch": {
- "ID": "113600097295",
- "name": "switch_name",
- "Scope": "user",
- "Subnet": {
- "NetworkAddress": "163.43.142.0",
- "NetworkMaskLen": 24,
- "DefaultRoute": "163.43.142.1",
- "Internet": {
- "BandWidthMbps": 100
}
}, - "UserSubnet": {
- "DefaultRoute": "192.168.100.254",
- "NetworkMaskLen": 24
}
}
}
]
}, - "is_ok": true
}
対象のNoSQLを更新します。
applianceID required | string Example: 113600102549 アプライアンスID |
NoSQLの更新を行うためのリクエストボディ
object |
{- "Appliance": {
- "Class": "nosql",
- "Name": "CassandraName",
- "Description": "説明",
- "Tags": [
- "tag1"
], - "ID": "113600097295",
- "Settings": {
- "Backup": {
- "Connect": "nfs://192.168.100.250/export",
- "DayOfWeek": [
- "sun",
- "mon"
], - "Time": "00:00",
- "Rotate": 3
}, - "SourceNetwork": [
- "192.168.100.200",
- "192.168.100.201",
- "192.168.100.202"
], - "Password:": "Default-Password01"
}
}
}
{- "Appliance": {
- "Class": "nosql",
- "Name": "CassandraName",
- "Description": "説明",
- "Tags": [
- "tag1"
], - "ID": "113600097295",
- "Plan": {
- "ID": 51004
}, - "Settings": {
- "Backup": {
- "Connect": "nfs://192.168.100.250/export",
- "DayOfWeek": [
- "sun",
- "mon"
], - "Time": "00:00",
- "Rotate": 3
}, - "SourceNetwork": [
- "192.168.100.200",
- "192.168.100.201",
- "192.168.100.202"
]
}, - "SettingsHash": "d41d8cd98f00b204e9800998ecf8427e",
- "Remark": {
- "Nosql": {
- "DatabaseEngine": "Cassandra",
- "DatabaseVersion": "4",
- "DefaultUser": "defaultUser01",
- "DiskSize": 102400,
- "Memory": 8192,
- "Nodes": 3,
- "Port": 9042,
- "Storage": "SSD",
- "Virtualcore": 3
}, - "Servers": [
- {
- "UserIPAddress": "192.168.100.11"
}
], - "Zone": {
- "ID": "30293"
}, - "ServiceClass": "cloud/nosql/beta"
}, - "Availability": "available",
- "Instance": {
- "Status": "up",
- "StatusChangedAt": "2021-01-01T00:00:00Z",
- "Host": {
- "Name": "host_name",
- "InfoURL": ""
}, - "Hosts": [
- {
- "Name": "string",
- "InfoURL": "string"
}
]
}, - "Disk": {
- "EncryptionAlgorithm": "none"
}, - "ServiceClass": "cloud/nosql/beta",
- "Generation": 200,
- "CreatedAt": "2021-01-01T00:00:00Z",
- "Icon": null,
- "Switch": null,
- "Interfaces": [
- {
- "IPAddress": "163.43.142.254",
- "UserIPAddress": "192.168.100.11",
- "HostName": null,
- "Switch": {
- "ID": "113600097295",
- "name": "switch_name",
- "Scope": "user",
- "Subnet": {
- "NetworkAddress": "163.43.142.0",
- "NetworkMaskLen": 24,
- "DefaultRoute": "163.43.142.1",
- "Internet": {
- "BandWidthMbps": 100
}
}, - "UserSubnet": {
- "DefaultRoute": "192.168.100.254",
- "NetworkMaskLen": 24
}
}
}
]
}, - "Success": true,
- "is_ok": true
}
対象のNoSQLを削除します。
applianceID required | string Example: 113600102549 アプライアンスID |
{- "Appliance": {
- "Class": "nosql",
- "Name": "CassandraName",
- "Description": "説明",
- "Tags": [
- "tag1"
], - "ID": "113600097295",
- "Plan": {
- "ID": 51004
}, - "Settings": {
- "Backup": {
- "Connect": "nfs://192.168.100.250/export",
- "DayOfWeek": [
- "sun",
- "mon"
], - "Time": "00:00",
- "Rotate": 3
}, - "SourceNetwork": [
- "192.168.100.200",
- "192.168.100.201",
- "192.168.100.202"
]
}, - "SettingsHash": "d41d8cd98f00b204e9800998ecf8427e",
- "Remark": {
- "Nosql": {
- "DatabaseEngine": "Cassandra",
- "DatabaseVersion": "4",
- "DefaultUser": "defaultUser01",
- "DiskSize": 102400,
- "Memory": 8192,
- "Nodes": 3,
- "Port": 9042,
- "Storage": "SSD",
- "Virtualcore": 3
}, - "Servers": [
- {
- "UserIPAddress": "192.168.100.11"
}
], - "Zone": {
- "ID": "30293"
}, - "ServiceClass": "cloud/nosql/beta"
}, - "Availability": "available",
- "Instance": {
- "Status": "up",
- "StatusChangedAt": "2021-01-01T00:00:00Z",
- "Host": {
- "Name": "host_name",
- "InfoURL": ""
}, - "Hosts": [
- {
- "Name": "string",
- "InfoURL": "string"
}
]
}, - "Disk": {
- "EncryptionAlgorithm": "none"
}, - "ServiceClass": "cloud/nosql/beta",
- "Generation": 200,
- "CreatedAt": "2021-01-01T00:00:00Z",
- "Icon": null,
- "Switch": null,
- "Interfaces": [
- {
- "IPAddress": "163.43.142.254",
- "UserIPAddress": "192.168.100.11",
- "HostName": null,
- "Switch": {
- "ID": "113600097295",
- "name": "switch_name",
- "Scope": "user",
- "Subnet": {
- "NetworkAddress": "163.43.142.0",
- "NetworkMaskLen": 24,
- "DefaultRoute": "163.43.142.1",
- "Internet": {
- "BandWidthMbps": 100
}
}, - "UserSubnet": {
- "DefaultRoute": "192.168.100.254",
- "NetworkMaskLen": 24
}
}
}
]
}, - "Success": true,
- "is_ok": true
}
対象のNoSQLのCassandraの起動状態を取得します。
applianceID required | string Example: 113600102549 アプライアンスID |
{- "Appliance": {
- "ID": "113600097295",
- "SettingsResponse": {
- "Nosql": {
- "Enabled": true,
- "BootStatus": "up"
}
}
}, - "is_ok": true
}
対象のNoSQLのバックアップを取得します。
applianceID required | string Example: 113600102549 アプライアンスID |
{- "nosql": {
- "backups": [
- {
- "backupId": "123e4567-e89b-12d3-a456-426614174000",
- "backupDestination": "nfs://192.168.100.250/export",
- "backupAt": "2024-11-18T16:03:48.844+09:00",
- "restoreAt": "2024-11-18T16:03:51.223+09:00",
- "size": 2,
- "deleteStatus": "2",
- "restoreStatus": "2"
}
]
}, - "is_ok": true
}
対象NoSQLのバックアップ復元を開始します。
バックアップデータの確認はNoSQLバックアップ一覧取得APIにて行ってください。
applianceID required | string Example: 113600102549 アプライアンスID |
backupID required | string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 バックアップID |
{- "nosql": {
- "is_ok": true
}, - "is_ok": true
}
対象NoSQLのバックアップ削除を開始します。
applianceID required | string Example: 113600102549 アプライアンスID |
backupID required | string <uuid> Example: 123e4567-e89b-12d3-a456-426614174000 バックアップID |
{- "nosql": {
- "is_ok": true
}, - "is_ok": true
}