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

1.2.15 アーカイブ

1.2.15.1 GET /v1/archives

機能

アーカイブ一覧表示

処理概要

アーカイブの一覧を表示します。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

filter_cols

フィルターするカラム名を指定します。
“,”で連結して複数のカラムを指定できます。

[例]
id,status

任意

string

query

filter_vals

filter_colsパラメーターで指定したカラム名に対して、指定順にフィルターの条件を指定します。
数値の場合、“~”で範囲を指定できます。

[例]
1~*,Archived

任意

string

query

sort_cols

ソートするカラム名を指定します。

[例]
id,datastore_id

任意

string

query

sort_vals

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

  • 昇順: asc

  • 降順: desc

[例]
asc,desc

任意

string

query

show_cols

表示するカラム名を指定します。

[例]
archive_name,status

任意

string

query

hide_cols

非表示にするカラム名を指定します。

[例]
id,storage_class,description

任意

string

query

limit

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

任意

integer

query

offset

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

任意

integer

query

ステータスコード

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

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

レスポンス詳細

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

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

コード

キー

説明

表示

形式

列挙型定数

200

id

アーカイブのID

Yes

integer

archive_name

アーカイブ名

Yes

string

datastore_id

アーカイブを作成したデータストアのID

Yes

integer

datastore_name

アーカイブを作成したデータストア名

Yes

string

status

アーカイブの状態

Yes

enum

Creating: 作成中

Creating (xx%): 作成中(進捗xx%)

Creation Error: 作成エラー

Retrieving: 取出し中

Retrieving (xx%): 取出し中(進捗xx%)

Retrieval Error: 取出しエラー

Readable: 取出し完了

Readable Warning: 取出し完了(注意あり)

Readable Error: 取出し完了(エラーあり)

Readable Unknown: 取出し完了(状態不明)

Releasing: 解放中

Release Error: 解放エラー

Deleting: 削除中

Deleting Error: 削除エラー

archive_usage

アーカイブのデータ量(MB)

Yes

integer

storage_class

アーカイブのストレージクラス

Yes

enum

S3 Glacier: Amazon S3 Glacier

S3 Glacier Deep Archive: Amazon S3 Glacier Deep Archive

description

アーカイブの説明

Yes

string

1.2.15.2 POST /v1/archives

機能

アーカイブ作成

処理概要

アーカイブを作成します。

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

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

archive_name

アーカイブ名を指定します。
省略時は、“AR#nnnn”という名前が設定されます。“nnnn”には1から始まる4桁の数字が入ります。
すでに存在しているアーカイブ名は指定できません。

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

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

  • 文字数: 1～32

[例]

AR#0001

任意

string

query

datastore_id

アーカイブを作成するデータストアのIDを指定します。

[例]
1

必須

integer

query

storage_class

アーカイブのストレージクラスを指定します。

  • 選択: [S3 Glacier | S3 Glacier Deep Archive]

省略時は、“S3 Glacier”を指定したものとみなします。

[例]
S3 Glacier Deep Archive

任意

enum

query

description

アーカイブの説明を指定します。

  • 最大文字数: 256

[例]
Initial archive

任意

string

query

ステータスコード

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

archive_name

アーカイブ名

string

datastore_id

アーカイブを作成したデータストアのID

string

storage_class

アーカイブのストレージクラス

enum

S3 Glacier: Amazon S3 Glacier

S3 Glacier Deep Archive: Amazon S3 Glacier Deep Archive

description

アーカイブの説明

string

1.2.15.3 POST /v1/archives/{id}/retrieve

機能

アーカイブからのデータ取出し

処理概要

アーカイブからデータを取り出します。

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

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

データの取出しを行うアーカイブのID

必須

integer

path

ステータスコード

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

id

データの取出しを行ったアーカイブのID

string

1.2.15.4 POST /v1/archives/{id}/release

機能

アーカイブから取り出したデータの解放

処理概要

アーカイブから取り出したデータを解放します。

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

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

データを解放するアーカイブのID

必須

integer

path

ステータスコード

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

id

データが解放されたアーカイブのID

string

1.2.15.5 DELETE /v1/archives

機能

アーカイブ削除

処理概要

アーカイブを削除します。

実行ユーザーのロールが“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-2021