ページの先頭行へ戻る
Cloud Storage Gateway V1.1.0 リファレンスガイド
FUJITSU Software
第1章 CSG REST API > 1.2 CSG REST API一覧 > 1.2.11 クラウドプロバイダー
前次

1.2.11 クラウドプロバイダー

1.2.11.1 GET /v1/cloud_providers

機能

クラウドプロバイダー一覧表示

処理概要

クラウドプロバイダーの一覧を表示します。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

filter_cols

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

任意

string

query

filter_vals

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

任意

string

query

sort_cols

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

任意

string

query

sort_vals

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

  • 昇順: asc

  • 降順: desc

[例]
asc,asc,desc

任意

string

query

show_cols

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

任意

string

query

hide_cols

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

任意

string

query

limit

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

任意

integer

query

offset

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

任意

integer

query

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

表示

形式

列挙型定数

200

id

クラウドプロバイダーのID

Yes

integer

provider_type

クラウドプロバイダーの種別

Yes

enum

Fujitsu OSS Object Storage :
FUJITSU Cloud Service for OSS Object Storage

Amazon S3:
Amazon S3

NIFCLOUD Object Storage:
ニフクラ Object Storage

OpenStack Swift:
OpenStack Swift

provider_name

クラウドプロバイダー名

Yes

string

provider_uri

クラウドプロバイダーのURI

Yes

string

user_name

ユーザー名

Yes

string

domain_id

ドメインID

Yes

string

project_id

プロジェクトID

Yes

string

network_id

クラウド転送に使用するネットワークID

Yes

integer

実行例

# curl -X GET \
   -d 'token=c7133246-9f5c-4122-b9cf-7fcb72ade251' \
 'https://192.0.2.10:9856/v1/cloud_providers'

1.2.11.2 POST /v1/cloud_providers

機能

クラウドプロバイダー登録

処理概要

クラウドプロバイダーを登録します。

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

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

provider_type

クラウドプロバイダーの種別を指定します

  • 選択: [Fujitsu OSS Object Storage | Amazon S3 | NIFCLOUD Object Storage | OpenStack Swift]

[例]
Fujitsu OSS Object Storage

必須

enum

query

provider_name

クラウドプロバイダー名を指定します。省略すると、自動的に名前が設定されます。

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

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

  • 文字数: 1～32

[例]
FO#001

任意

string

query

provider_uri

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

  • 文字数: 1～65535

[例]
https://cloud.example.com

必須

string

query

domain_id

ドメインIDを指定します。

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

  • 最大文字数: 32

FUJITSU Cloud Service for OSS Object StorageまたはOpenStack Swiftの場合に指定可能です。

[例]
ABCDEFGH

任意

string

query

project_id

プロジェクトIDを指定します。

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

  • 最大文字数: 32

FUJITSU Cloud Service for OSS Object StorageまたはOpenStack Swiftの場合に指定可能です。

[例]
ABCDEFGH

任意

string

query

user_name

  • FUJITSU Cloud Service for OSS Object StorageおよびOpenStack Swiftの場合
    ユーザー名を指定します。

  • Amazon S3およびニフクラ Object Storageの場合
    アクセスキーIDを指定します。

  • 文字数: 1～255

[例]
accesskey

必須

string

query

user_pass

  • FUJITSU Cloud Service for OSS Object StorageおよびOpenStack Swiftの場合
    パスワードを指定します。

  • Amazon S3およびニフクラ Object Storageの場合
    シークレットアクセスキーを指定します。

  • 文字数: 1～255

[例]
password

必須

string

query

network_id

クラウド転送に使用するネットワークIDを指定します。ネットワーク登録時に割り当てられたIDを指定します。

  • 範囲: 0-2

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

任意

integer

query

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

provider_type

クラウドプロバイダーの種別

enum

Fujitsu OSS Object Storage :
FUJITSU Cloud Service for OSS Object Storage

Amazon S3:
Amazon S3

NIFCLOUD Object Storage:
ニフクラ Object Storage

OpenStack Swift:
OpenStack Swift

provider_name

クラウドプロバイダー名

string

provider_uri

クラウドプロバイダーのURI

string

user_name

ユーザー名またはアクセスキーID

string

domain_id

ドメインID

string

project_id

プロジェクトID

string

network_id

クラウド転送用ネットワークID

string

実行例

ネットワークIDに1を指定してFujitsu Cloud Service for OSS Object Storageのクラウドプロバイダーを登録する場合

curl -X POST \
   -d 'token=c7133246-9f5c-4122-b9cf-7fcb72ade251' \
   -d 'provider_type=Fujitsu OSS Object Storage' \
   -d 'provider_name=FO#001' \
   -d 'provider_uri=https://cloud.example.com' \
   -d 'domain_id=ABCDEFGH' \
   -d 'project_id=ABCDEFGH' \
   -d 'user_name=accesskey' \
   -d 'user_pass=password' \
   -d 'network_id=1' \
 'https://192.0.2.10:9856/v1/cloud_providers'

1.2.11.3 PUT /v1/cloud_providers/{id}

機能

クラウドプロバイダー変更

処理概要

クラウドプロバイダーの設定を変更します。

“provider_name”または“provider_uri”を変更する場合は、指定したクラウドプロバイダーを使用しているすべての共有フォルダの有効化状態が無効になっている必要があります。

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

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

クラウドプロバイダーのID

必須

integer

path

provider_name

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

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

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

  • 文字数: 1～32

[例]
FO#001

任意

string

query

provider_uri

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

  • 文字数: 1～65535

[例]
https://cloud.example.com

任意

string

query

user_name

  • FUJITSU Cloud Service for OSS Object StorageおよびOpenStack Swiftの場合
    ユーザー名を指定します。

  • Amazon S3およびニフクラ Object Storageの場合
    アクセスキーIDを指定します。

  • 文字数: 1～255

[例]
accesskey

任意

string

query

user_pass

  • FUJITSU Cloud Service for OSS Object StorageおよびOpenStack Swiftの場合
    パスワードを指定します。

  • Amazon S3およびニフクラ Object Storageの場合
    シークレットアクセスキーを指定します。

  • 文字数: 1～255

[例]
password

任意

string

query

network_id

クラウド転送に使用するネットワークIDを指定します。ネットワーク登録時に割り当てられたIDを指定します。

  • 範囲: 0-2

任意

integer

query

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

id

クラウドプロバイダーのID

string

provider_name

クラウドプロバイダー名

string

provider_uri

クラウドプロバイダーのURI

string

user_name

ユーザー名またはID

string

network_id

クラウド転送に使用するネットワークID

string

実行例

IDが1のクラウドプロバイダーのパスワードを変更する場合

curl -X PUT \
   -d 'token=c7133246-9f5c-4122-b9cf-7fcb72ade251' \
   -d 'user_pass=newpassword' \
 'https://192.0.2.10:9856/v1/cloud_providers/1'

1.2.11.4 DELETE /v1/cloud_providers

機能

クラウドプロバイダー削除

処理概要

クラウドプロバイダーを削除します。

実行ユーザーが“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

実行例

IDが1のクラウドプロバイダーを削除する場合

curl -X DELETE \
   -d 'token=c7133246-9f5c-4122-b9cf-7fcb72ade251' \
   -d 'ids=1' \
 'https://192.0.2.10:9856/v1/cloud_providers'

1.2.11.5 GET /v1/cloud_providers/{id}/buckets

機能

バケット名一覧表示

処理概要

バケットの一覧をクラウドプロバイダーから取得して表示します。

(本製品からクラウドプロバイダーに対してREST APIを発行することでバケットの一覧を取得します)

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

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

必須

integer

path

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

表示

形式

列挙型定数

200

id

クラウドプロバイダーのID

Yes

string

buckets

バケットの個々の情報

Yes

オブジェクトの配列

bucketsのオブジェクトの配列は以下のとおりです。

前次
Copyright FUJITSU LIMITED 2012-2018