ページの先頭行へ戻る
Cloud Storage Gateway V1.1.0 リファレンスガイド
FUJITSU Software
第1章 CSG REST API > 1.2 CSG REST API一覧 > 1.2.13 共有フォルダ
前次

1.2.13 共有フォルダ

1.2.13.1 GET /v1/shared_folders

機能

共有フォルダ一覧表示

処理概要

共有フォルダの一覧を表示します。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

filter_cols

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

任意

string

query

filter_vals

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

任意

string

query

sort_cols

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

任意

string

query

sort_vals

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

  • 昇順: asc

  • 降順: desc

[例]
asc,asc,desc

任意

string

query

show_cols

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

任意

string

query

hide_cols

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

任意

string

query

limit

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

任意

integer

query

offset

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

任意

integer

query

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

表示

形式

列挙型定数

200

id

共有フォルダのID

Yes

integer

shared_folder_name

共有フォルダ名

Yes

string

owner_name

共有フォルダの所有者

Yes

string

group_name

共有フォルダのグループ

Yes

string

datastore_id

共有フォルダを作成するデータストアのID

Yes

integer

datastore_name

データストア名

Yes

string

protocol

使用するストレージプロトコル

Yes

enum

NFS:
Network File System

SMB:
Server Message Block

activation_status

作成した共有フォルダの有効化状態

Yes

enum

Enable:
有効

Disable:
無効

nfs_allow_hosts

アクセスを許可するホスト

Yes

string

nfs_no_root_squash_hosts

共有フォルダに対するroot権限でのアクセスを許可するホスト

Yes

string

smb_allow_hosts

アクセスを許可するホスト

Yes

string

smb_deny_hosts

アクセスを拒否するホスト

Yes

string

smb_encryption

SMB 暗号化機能を、有効にするかどうか

Yes

enum

Enable:
有効

Disable:
無効

op_locks

共有フォルダがファイルをロックすることで競合を回避するOpportunistic locking機能(Oplocks機能)を使用するかどうか

Yes

enum

Enable:
有効

Disable:
無効

nfs_export_path

NFS 接続ホストへのエクスポートが可能なディレクトリパス

Yes

string

status

共有フォルダ状態

Yes

enum

Normal:
正常状態

Warning:
注意を要する状態

Error:
異常状態

Unknown:
状態が不明

1.2.13.2 POST /v1/shared_folders

機能

共有フォルダ登録

処理概要

共有フォルダを作成します。

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

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

shared_folder_name

共有フォルダ名を指定します。
省略すると、“SF#nn”という名前が設定されます。
nnは2桁の数字が入ります。
すでに存在している共有フォルダ名を指定することはできません。

  • 使用可能文字:半角文字および文字コードがUTF-8の全角文字

  • 文字数: 1～76

  • 半角スペースおよび以下の記号は使用できません。
    \/:*?"<>|=,;[]%+

  • 大文字・小文字の区別なく、以下の名前は使用できません。
    「.snap」、「global」、「homes」、「printers」、「ipc$」、「.」(ドット1文字)、および「..」(ドット2文字)

  • 大文字・小文字の区別なく、先頭に「@gmt」は指定できません。

[例]
SF#01

任意

string

query

owner_name

共有フォルダの所有者を指定します。省略した場合の所有者はrootになります。
本パラメーターを指定した場合はgroup_nameパラメーターの指定が必要です。
ユーザー名の予約語は指定できません。
ユーザー名の予約語については、『ユーザーズガイド』の「NASアクセスユーザー設定」を参照してください。
[例]
user

任意

string

query

group_name

共有フォルダのグループを指定します。省略した場合のグループはrootになります。
本パラメーターを指定した場合はowner_nameパラメーターの指定が必要です。
グループ名の予約語は指定できません。
グループ名の予約語については、『ユーザーズガイド』の「NASアクセスグループ設定」を参照してください。
[例]
group

任意

string

query

datastore_id

共有フォルダを作成するデータストアのIDを指定します。

[例]
1

必須

integer

query

protocol

使用するストレージプロトコルを指定します。

  • 選択: [NFS | SMB]

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

[例]
NFS

任意

enum

query

activation_status

作成した共有フォルダの有効化状態を指定します。

  • 選択: [Enable | Disable]

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

[例]
Disable

任意

enum

query

nfs_allow_hosts

アクセスを許可するホストを指定します。ホストは以下の形式で指定できます。最大10個指定できます。複数指定する場合は、コンマ(,)で区切ってください。複数のホストが指定された場合、指定形式と指定順序によって適用される優先度が異なります。優先度は1が最も高く、3が最も低くなります。また、同一優先度の場合は、先(左側)に記述したホストの優先度が高くなります。

  1. FQDN、IPv4アドレス

  2. IPv4ネットワーク(*1)

  3. 「*」を含むFQDN

(*1) IPv4ネットワークは以下のいずれかの形式で指定してください。

  • CIDR表記(プレフィックス表記) ([例] 192.168.10.0/24)

  • サブネット表記([例] 192.168.10.0/255.255.255.0)


省略すると、すべてのホストからのアクセスを許可します。使用プロトコルがNFSの場合のみ指定できます。
[例]
serv01.example.com

任意

string

query

nfs_no_root_squash_hosts

共有フォルダに対するroot権限でのアクセスを許可するホストを指定します。ホストは以下の形式で指定できます。最大10個指定できます。複数指定する場合は、コンマ(,)で区切ってください。複数のホストが指定された場合、指定形式と指定順序によって適用される優先度が異なります。優先度は1が最も高く、3が最も低くなります。また、同一優先度の場合は、先(左側)に記述したホストの優先度が高くなります。

  1. FQDN、IPv4アドレス

  2. IPv4ネットワーク(*1)

  3. 「*」を含むFQDN

(*1) IPv4ネットワークは以下のいずれかの形式で指定してください。

  • CIDR表記(プレフィックス表記) ([例] 192.168.10.0/24)

  • サブネット表記([例] 192.168.10.0/255.255.255.0)


nfs_allow_hostsで指定したホストと同じ文字列にする必要があります(大文字小文字も区別します)。以下のような指定は許可されません。

[例]
nfs_allows_hosts: *.example.com
nfs_no_root_squash_hosts: srv01.example.com

省略すると、すべてのホストに対してroot権限でのアクセスは許可されません。

使用プロトコルがNFSの場合のみ指定できます。
[例]
serv01.example.com

任意

string

query

smb_allow_hosts

アクセスを許可するホストを指定します。ホストは以下の形式で指定できます。最大10個指定できます。複数指定する場合は、コンマ(,)で区切ってください。複数のホストが指定された場合、先(左側)に記述したホストから照合が行われます。

  • FQDN

  • IPv4アドレス

  • IPv4ネットワーク(*1)

  • 「.」で始まるドメイン名

  • EXCEPT(*2)

(*1) IPv4ネットワークは以下のいずれかの形式で指定してください。

  • CIDR表記(プレフィックス表記) ([例] 192.168.10.0/24)

  • サブネット表記([例] 192.168.10.0/255.255.255.0)

(*2) 「<リスト1> EXCEPT <リスト2>」の形式で指定してください。<リスト1>、<リスト2>は以下の1つ以上の項目から構成される、空白区切りのリストです。

  • FQDN

  • IPv4アドレス

  • IPv4ネットワーク(*1)

  • 「.」で始まるドメイン名

<リスト1>で指定した項目のうち、<リスト2>で指定した項目以外からのアクセスを許可します。

[例1] 192.168.10.1/24 EXCEPT 192.168.10.2

[例2] .example1.com EXCEPT host1.example.com host2.example.com

省略すると、すべてのホストからのアクセスを許可します。使用プロトコルがSMBの場合のみ指定できます。

本パラメーターとsmb_deny_hostsで定義が重複する場合、本パラメーターの指定が優先されます。
[例]
serv01.example.com

任意

string

query

smb_deny_hosts

アクセスを拒否するホストを指定します。ホストは以下の形式で指定できます。最大10個指定できます。複数指定する場合は、コンマ(,)で区切ってください。複数のホストが指定された場合、先(左側)に記述したホストから照合が行われます。

  • FQDN

  • IPv4アドレス

  • IPv4ネットワーク(*1)

  • 「.」で始まるドメイン名

  • EXCEPT(*2)

(*1) IPv4ネットワークは以下のいずれかの形式で指定してください。

  • CIDR表記(プレフィックス表記) ([例] 192.168.10.0/24)

  • サブネット表記([例] 192.168.10.0/255.255.255.0)

(*2) 「<リスト1> EXCEPT <リスト2>」の形式で指定してください。<リスト1>、<リスト2>は以下の1つ以上の項目から構成される、空白区切りのリストです。

  • FQDN

  • IPv4アドレス

  • IPv4ネットワーク(*1)

  • 「.」で始まるドメイン名

<リスト1>で指定した項目のうち、<リスト2>で指定した項目以外からのアクセスを拒否します。

[例1] 192.168.10.1/24 EXCEPT 192.168.10.2

[例2] .example1.com EXCEPT host1.example.com host2.example.com


使用プロトコルがSMBの場合のみ指定できます。本パラメーターとsmb_allow_hostsで定義が重複する場合、smb_allow_hostsの指定が優先されます。

[例]
serv01.example.com

任意

string

query

smb_encryption

SMB 暗号化機能を、有効にするかどうかを指定します。
SMB 暗号化を有効にすると、ファイルアクセスの通信をSMB プロトコルベースで暗号化します。
protocolがSMBの場合のみ指定できます。

  • 選択: [Enable | Disable]

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

[例]
Enable

任意

enum

query

op_locks

共有フォルダがファイルをロックすることで競合を回避するOpportunistic locking機能(Oplocks 機能)を使用するかどうかを指定します。
protocolがSMBの場合のみ指定できます。

  • 選択: [Enable | Disable]

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

[例]
Enable

任意

enum

query

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

shared_folder_name

共有フォルダ名

string

owner_name

共有フォルダの所有者

string

group_name

共有フォルダのグループ

string

datastore_id

共有フォルダを作成したデータストアのID

string

protocol

使用するストレージプロトコル

enum

NFS:
Network File System

SMB:
Server Message Block

activation_status

作成した共有フォルダの有効化状態

enum

Enable:
有効

Disable:
無効

nfs_allow_hosts

アクセスを許可するホスト

string

nfs_no_root_squash_hosts

共有フォルダに対するroot権限でのアクセスを許可するホスト

string

smb_allow_hosts

アクセスを許可するホスト

string

smb_deny_hosts

アクセスを拒否するホスト

string

smb_encryption

SMB暗号化機能を、有効にするかどうか

enum

Enable:
有効

Disable:
無効

op_locks

共有フォルダがファイルをロックすることで競合を回避するOpportunistic locking機能(Oplocks 機能)を使用するかどうか

enum

Enable:
有効

Disable:
無効

1.2.13.3 PUT /v1/shared_folders/{id}

機能

共有フォルダ変更

処理概要

共有フォルダの設定を変更します。

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

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

共有フォルダのID

必須

integer

path

owner_name

共有フォルダの所有者を指定します。空文字列("")を指定した場合の所有者はrootになります。
本パラメーターを空文字列("")で指定した場合は、group_nameパラメーターを空文字列("")で指定する必要があります。
本パラメーターを省略した場合は、owner_nameパラメーターは変更されません。
ユーザー名の予約語は指定できません。
ユーザー名の予約語については、『ユーザーズガイド』の「NASアクセスユーザー設定」を参照してください。
[例]
user

任意

string

query

group_name

共有フォルダのグループを指定します。空文字列("")を指定した場合のグループはrootになります。
本パラメーターを空文字列("")で指定した場合は、owner_nameパラメーターを空文字列("")で指定する必要があります。
本パラメーターを省略した場合は、group_nameパラメーターは変更されません。
グループ名の予約語は指定できません。
グループ名の予約語については、『ユーザーズガイド』の「NASアクセスグループ設定」を参照してください。
[例]
group

任意

string

query

activation_status

作成した共有フォルダの有効化状態を指定します。

  • 選択: [Enable | Disable]

[例]
Disable

任意

enum

query

nfs_allow_hosts

アクセスを許可するホストを指定します。ホストは以下の形式で指定できます。最大10個指定できます。複数指定する場合は、コンマ(,)で区切ってください。複数のホストが指定された場合、指定形式と指定順序によって適用される優先度が異なります。優先度は1が最も高く、3が最も低くなります。また、同一優先度の場合は、先(左側)に記述したホストの優先度が高くなります。

  1. FQDN、IPv4アドレス

  2. IPv4ネットワーク(*1)

  3. 「*」を含むFQDN

(*1) IPv4ネットワークは以下のいずれかの形式で指定してください。

  • CIDR表記(プレフィックス表記) ([例] 192.168.10.0/24)

  • サブネット表記([例] 192.168.10.0/255.255.255.0)


設定を削除する場合は、空文字列("")を指定します。
設定を削除すると、すべてのホストからのアクセスを許可します。
使用プロトコルがNFSの場合のみ指定できます。
[例]
serv01.example.com

任意

string

query

nfs_no_root_squash_hosts

共有フォルダに対するroot権限でのアクセスを許可するホストを指定します。ホストは以下の形式で指定できます。最大10個指定できます。複数指定する場合は、コンマ(,)で区切ってください。複数のホストが指定された場合、指定形式と指定順序によって適用される優先度が異なります。優先度は1が最も高く、3が最も低くなります。また、同一優先度の場合は、先(左側)に記述したホストの優先度が高くなります。

  1. FQDN、IPv4アドレス

  2. IPv4ネットワーク(*1)

  3. 「*」を含むFQDN

(*1) IPv4ネットワークは以下のいずれかの形式で指定してください。

  • CIDR表記(プレフィックス表記) ([例] 192.168.10.0/24)

  • サブネット表記([例] 192.168.10.0/255.255.255.0)


nfs_allow_hostsで指定したホストと同じ文字列にする必要があります(大文字小文字も区別します)。以下のような指定は許可されません。

[例]
nfs_allows_hosts: *.example.com
nfs_no_root_squash_hosts: srv01.example.com

設定を削除する場合は、空文字列("")を指定します。設定を削除すると、すべてのホストに対してroot権限でのアクセスは許可されません。

使用プロトコルがNFSの場合のみ指定できます。
[例]
serv01.example.com

任意

string

query

smb_allow_hosts

アクセスを許可するホストを指定します。ホストは以下の形式で指定できます。最大10個指定できます。複数指定する場合は、コンマ(,)で区切ってください。複数のホストが指定された場合、先(左側)に記述したホストから照合が行われます。

  • FQDN

  • IPv4アドレス

  • IPv4ネットワーク(*1)

  • 「.」で始まるドメイン名

  • EXCEPT(*2)

(*1) IPv4ネットワークは以下のいずれかの形式で指定してください。

  • CIDR表記(プレフィックス表記) ([例] 192.168.10.0/24)

  • サブネット表記([例] 192.168.10.0/255.255.255.0)

(*2) 「<リスト1> EXCEPT <リスト2>」の形式で指定してください。<リスト1>、<リスト2>は以下の1つ以上の項目から構成される、空白区切りのリストです。

  • FQDN

  • IPv4アドレス

  • IPv4ネットワーク(*1)

  • 「.」で始まるドメイン名

<リスト1>で指定した項目のうち、<リスト2>で指定した項目以外からのアクセスを許可します。

[例1] 192.168.10.1/24 EXCEPT 192.168.10.2

[例2] .example1.com EXCEPT host1.example.com host2.example.com

設定を削除する場合は、空文字列("")を指定します。
設定を削除すると、すべてのホストからのアクセスを許可します。
使用プロトコルがSMBの場合のみ指定できます。

本パラメーターとsmb_deny_hostsで定義が重複する場合、本パラメーターの指定が優先されます。
[例]
serv01.example.com

任意

string

query

smb_deny_hosts

アクセスを拒否するホストを指定します。ホストは以下の形式で指定できます。最大10個指定できます。複数指定する場合は、コンマ(,)で区切ってください。複数のホストが指定された場合、先(左側)に記述したホストから照合が行われます。

  • FQDN

  • IPv4アドレス

  • IPv4ネットワーク(*1)

  • 「.」で始まるドメイン名

  • EXCEPT(*2)

(*1) IPv4ネットワークは以下のいずれかの形式で指定してください。

  • CIDR表記(プレフィックス表記) ([例] 192.168.10.0/24)

  • サブネット表記([例] 192.168.10.0/255.255.255.0)

(*2) 「<リスト1> EXCEPT <リスト2>」の形式で指定してください。<リスト1>、<リスト2>は以下の1つ以上の項目から構成される、空白区切りのリストです。

  • FQDN

  • IPv4アドレス

  • IPv4ネットワーク(*1)

  • 「.」で始まるドメイン名

<リスト1>で指定した項目のうち、<リスト2>で指定した項目以外からのアクセスを拒否します。

[例1] 192.168.10.1/24 EXCEPT 192.168.10.2

[例2] .example1.com EXCEPT host1.example.com host2.example.com


設定を削除する場合は、空文字列("")を指定します。
使用プロトコルがSMBの場合のみ指定できます。本パラメーターとsmb_allow_hostsで定義が重複する場合、smb_allow_hostsの指定が優先されます。
[例]
serv01.example.com

任意

string

query

smb_encryption

SMB 暗号化機能を、有効にするかどうかを指定します。
SMB 暗号化を有効にすると、ファイルアクセスの通信をSMB プロトコルベースで暗号化します。
protocolがSMBの場合のみ指定できます。

  • 選択: [Enable | Disable]

[例]
Enable

任意

enum

query

op_locks

共有フォルダがファイルをロックすることで競合を回避するOpportunistic locking機能(Oplocks 機能)を使用するかどうかを指定します。
protocolがSMBの場合のみ指定できます。

  • 選択: [Enable | Disable]

[例]
Enable

任意

enum

query

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

id

共有フォルダのID

string

owner_name

共有フォルダの所有者

string

group_name

共有フォルダのグループ

string

activation_status

作成した共有フォルダの有効化状態

enum

Enable:
有効

Disable:
無効

nfs_allow_hosts

アクセスを許可するホスト(IPv4アドレスまたはFQDN)

string

nfs_no_root_squash_hosts

共有フォルダに対するroot権限でのアクセスを許可するホスト(IPv4アドレスまたはFQDN)

string

smb_allow_hosts

アクセスを許可するホスト(IPv4アドレスまたはFQDN)

string

smb_deny_hosts

アクセスを拒否するホスト(IPv4アドレスまたはFQDN)

string

smb_encryption

SMB 暗号化機能を、有効にするかどうか

enum

Enable:
有効

Disable:
無効

op_locks

共有フォルダがファイルをロックすることで競合を回避するOpportunistic locking機能(Oplocks 機能)を使用するかどうか

enum

Enable:
有効

Disable:
無効

1.2.13.4 DELETE /v1/shared_folders

機能

共有フォルダ削除

処理概要

共有フォルダを削除します。

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