ページの先頭行へ戻る
Cloud Storage Gateway V1.2.0 リファレンスガイド
FUJITSU Software
第1章 CSG REST API > 1.2 CSG REST API一覧 > 1.2.13 データストア
前次

1.2.13 データストア

1.2.13.1 GET /v1/datastores

機能

データストア一覧表示

処理概要

データストアの一覧を表示します。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

filter_cols

フィルターするカラム名を指定します。
“,”で連結して複数のカラムを指定することが可能です。
[例]
id,is_cache_untransferred

任意

string

query

filter_vals

filter_colsで指定したカラム名に対して、指定順にフィルターの条件を指定します。
数値の場合、“~”で範囲を指定することが可能です。
[例]
1~*,false

任意

string

query

sort_cols

ソートするカラム名を指定します。
[例]
id,is_cache_untransferred

任意

string

query

sort_vals

sort_colsで指定したカラム名に対して、指定順にソートの条件を指定します。

  • 昇順: asc

  • 降順: desc

[例]
asc,asc,desc

任意

string

query

show_cols

表示するカラム名を指定します。
[例]
id,is_cache_untransferred

任意

string

query

hide_cols

非表示にするカラム名を指定します。
[例]
id,is_cache_untransferred

任意

string

query

limit

表示する項目数を指定します。

任意

integer

query

offset

項目の表示開始位置を指定します。

任意

integer

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

表示

形式

列挙型定数

200

id

データストアのID

Yes

integer

datastore_level

データストアのレベル
V1.2.0以降に作成したデータストアの場合：1
V1.1.0以前に作成したデータストアの場合：0

Yes

integer

datastore_name

データストア名

Yes

string

datastore_capacity

データストアに割り当てた容量(GB)

Yes

integer

cache_capacity

キャッシュに割り当てた容量(GB)

Yes

integer

compression_mode

キャッシュ領域へのデータ格納時における重複排除後の圧縮実施有無

Yes

enum

Enable:
有

Disable:
無

cloud_provider_id

クラウドプロバイダーID

Yes

integer

cloud_provider_name

クラウドプロバイダー名

Yes

string

bucket_name

バケット名

Yes

string

provider_encryption_mode

クラウドプロバイダーに格納する際の暗号化の実施有無

Yes

enum

Enable:
有

Disable:
無

datastore_usage

データストア 使用量(MB)

Yes

integer

cache_usage

キャッシュ使用量(MB)

Yes

integer

cache_guarantee_period

将来のための予約領域

Yes

timestamp

cache_status

キャッシュ状態

Yes

enum

Normal:
正常状態

Warning:
注意を要する状態

Error:
異常状態

Unknown:
状態が不明

connect_status

ネットワーク接続状態

Yes

enum

Normal:
正常状態

Warning:
注意を要する状態

Error:
異常状態

Unknown:
状態が不明

datastore_status

データストア状態

Yes

enum

Normal:
正常状態

Warning:
注意を要する状態

Error:
異常状態

Unknown:
状態が不明

cache_meta_data

メタデータ容量(MB)

Yes

integer

cache_untransferred

未転送容量(MB)

Yes

integer

cache_transferred

転送済み容量(MB)

Yes

integer

is_cache_untransferred

未転送データの有無

  • true: あり

  • false: なし

Yes

boolean

transfer_completed_at

転送完了時刻
(iso8601の拡張形式

YYYY-MM-DDThh:mm:ss+hh:mm)

Yes

string

reduced_rate

削減率(%)
(小数点以下は切り捨て)

Yes

integer

traffic_control

クラウド転送における転送レートの上限値

Yes

integer

1.2.13.2 POST /v1/datastores

機能

データストア登録

処理概要

データストアを登録します。

クラウド転送における転送レートの上限値を有効にする場合は4-10240の間で指定してください。無効にする場合は0または省略してください。

実行ユーザーのロールが“Monitor”の場合は、実行できません。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

datastore_name

データストア名を指定します。
省略すると、“DS#nnn”という名前が設定されます。
nnnは3桁の数字が入ります。
すでに存在しているデータストア名を指定することはできません。

  • 使用可能文字: 半角英数字

  • 使用可能記号: !@#$%^&*()_+-=[]{}|'

  • 文字数: 1～32

[例]
DS#001

任意

string

query

datastore_capacity

データストアに割り当てる容量を指定します。
容量はGB単位で指定します。

  • 指定範囲: 100～ライセンス容量(1GB単位)

省略時は100が設定されます。

[例]
100

任意

integer

query

cache_capacity

キャッシュに割り当てる容量を指定します。
容量はデータストア容量の10%(最低は20GB)からキャッシュ領域用の仮想ディスクサイズまでの範囲で指定します。
容量はGB単位で指定します。

  • 指定範囲: 20～102,398,976(1GB単位)

省略時はデータストア容量の50%分の容量が設定されます。

[例]
500

任意

integer

query

compression_mode

キャッシュ領域へのデータ格納時における重複排除後の圧縮実施有無を指定します。

  • 選択: [Enable | Disable]

省略された場合、“Enable”が指定されたとみなします。

[例]
Disable

任意

enum

query

cloud_provider_id

クラウドプロバイダーIDを指定します。

[例]
1

必須

integer

query

bucket_name

バケット名を指定します。

[例]
bucket01

必須

string

query

provider_encryption_mode

クラウドプロバイダーに格納する際の暗号化の実施有無を指定します。

  • 選択: [Enable | Disable]

省略された場合、“Disable”が指定されたとみなします。

[例]
Disable

任意

enum

query

provider_encryption_pass

クラウドプロバイダーに格納する際の暗号化のパスワードを指定します。
provider_encryption_modeを有効にした場合に指定が必要です。

  • 使用可能文字: 半角英数字

  • 使用可能記号:!.-_

  • 文字数: 8～16

アルファベット、数字、記号をすべて含む必要があります。
[例]
password

任意

string

query

traffic_control

クラウド転送における転送レートの上限値を指定します。
データストアへの書込みとデータストアから読込みのそれぞれのデータ転送に対して同じ値が設定されます。
転送レートの単位はMbit/sで指定します。0または4-10240が指定できます。
0を指定した場合は上限値の設定が無効になります。
省略時は0が設定されます。

  • 範囲: 0,4-10240

[例]
500

任意

integer

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

datastore_name

データストア名

string

datastore_capacity

データストアに割り当てた容量

string

cache_capacity

キャッシュに割り当てた容量

string

compression_mode

キャッシュ領域へのデータ格納時における重複排除後の圧縮実施有無

enum

Enable:
有

Disable:
無

cloud_provider_id

クラウドプロバイダーID

string

bucket_name

バケット名

string

provider_encryption_mode

クラウドプロバイダーに格納する際の暗号化の実施有無

enum

Enable:
有

Disable:
無

traffic_control

クラウド転送における転送レートの上限値

string

1.2.13.3 PUT /v1/datastores/{id}

機能

データストア変更

処理概要

データストアの設定を変更します。

クラウド転送における転送レートの上限値を有効にする場合は4-10240の間で指定してください。無効にする場合は0を指定してください。

実行ユーザーのロールが“Monitor”の場合は、実行できません。

V1.1.0以前に作成したデータストアの場合、データストアに割り当てる容量とキャッシュに割り当てる容量の指定可能範囲が異なります。データストアを作成した版数はデータストアレベルで判断してください。データストアレベルは「GET /v1/datastores」で確認できます。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

データストアのID

必須

integer

path

datastore_name

データストア名を指定します。
すでに存在しているデータストア名を指定することはできません。

  • 使用可能文字: 半角英数字

  • 使用可能記号: !@#$%^&*()_+-=[]{}|'

  • 文字数: 1～32

[例]
DS#001

任意

string

query

datastore_capacity

データストアに割り当てる容量を指定します。
容量は100GBからキャッシュ容量の10倍またはライセンス容量の小さいほうまでの範囲で指定します。
注意：V1.1.0以前に作成したデータストア（データストアレベルが0）の場合、指定可能な容量は100GBからキャッシュ容量の5倍またはライセンス容量の小さいほうまでの範囲となります。
容量はGB単位で指定します。

  • 指定範囲: 100～ライセンス容量(1GB単位)

[例]
100

任意

integer

query

cache_capacity

キャッシュに割り当てる容量を指定します。
容量はデータストア容量の10%(最低は20GB)からキャッシュ領域用の仮想ディスクサイズまでの範囲で指定します。
注意：V1.1.0以前に作成したデータストア（データストアレベルが0）の場合、指定可能な容量はデータストア容量の20%からキャッシュ領域用の仮想ディスクサイズまでの範囲となります。
容量はGB単位で指定します。

  • 指定範囲: 20～102,398,976(1GB単位)

[例]
500

任意

integer

query

compression_mode

キャッシュ領域へのデータ格納時における重複排除後の圧縮実施有無を指定します。

  • 選択: [Enable | Disable]

[例]
Disable

任意

enum

query

traffic_control

クラウド転送における転送レートの上限値を指定します。
データストアへの書込みとデータストアから読込みのそれぞれのデータ転送に対して同じ値が設定されます。
転送レートの単位はMbit/sで指定します。0または4-10240が指定できます。
0を指定した場合は上限値の設定が無効になります。

  • 範囲: 0,4-10240

[例]
500

任意

integer

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

id

データストアのID

string

datastore_name

データストア名

string

datastore_capacity

データストアに割り当てた容量

string

cache_capacity

キャッシュに割り当てた容量

string

compression_mode

キャッシュ領域へのデータ格納時における重複排除後の圧縮実施有無

enum

Enable:
有

Disable:
無

traffic_control

クラウド転送における転送レートの上限値

string

1.2.13.4 DELETE /v1/datastores

機能

データストア削除

処理概要

データストアを削除します。

実行ユーザーのロールが“Monitor”の場合は、実行できません。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

ids

削除するデータストアのIDを指定します。
“,”(コンマ)区切りで複数指定することができます。

[例]
1,2,3

必須

string

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

ids

削除されたデータストアのID(複数存在する場合はコンマ区切りの文字列で表示)

string

前次
Copyright FUJITSU LIMITED 2018-20