ページの先頭行へ戻る
Cloud Storage Gateway V1.2.0 リファレンスガイド
FUJITSU Software
第1章 CSG REST API > 1.2 CSG REST API一覧 > 1.2.11 NAS認証サーバ
前次

1.2.11 NAS認証サーバ

1.2.11.1 GET /v1/auth/servers

機能

認証サーバ一覧表示

処理概要

認証サーバの一覧を表示します。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

filter_cols

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

任意

string

query

filter_vals

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

任意

string

query

sort_cols

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

任意

string

query

sort_vals

sort_colsで指定したカラム名に対して、指定順にソートの条件を正規表現^((desc)|(asc))(,((desc)|(asc)))*$)で指定することが可能です。

  • 昇順: asc

  • 降順: desc

[例]
asc,asc,desc

任意

string

query

show_cols

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

任意

string

query

hide_cols

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

任意

string

query

limit

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

任意

integer

query

offset

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

任意

integer

query

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

表示

形式

列挙型定数

200

id

ユーザーID

Yes

integer

ip_address

IPアドレス

Yes

string

port_no

ポート番号

No

integer

domain

認証サーバドメイン

No

string

bind_user

バインドユーザー

No

string

description

認証サーバの説明

No

string

1.2.11.2 GET /v1/auth/servers/{id}

機能

認証サーバ詳細表示

処理概要

認証サーバの詳細を表示します。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

リソースの識別子を指定します。1つだけ指定することが可能です。
[例]
1

必須

integer

path

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

200

id

認証サーバのID

integer

ip_address

IPアドレス

string

port_no

ポート番号

integer

domain

認証サーバドメイン

string

bind_user

バインドユーザー

string

description

認証サーバの説明

string

1.2.11.3 POST /v1/auth/servers

機能

認証サーバ登録

処理概要

SMBの認証サーバを登録します。
認証サーバはADを1台まで登録可能です。認証サーバには389番ポートを使って通信します。
この操作を実行すると、現在の共有フォルダへのNASアクセスが中断されます。操作前にNASアクセスがないことを確認してください。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

ip_address

IPアドレスを指定します。

  • 形式: ipv4形式

[例]
192.168.1.1

必須

string

query

domain

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

  • 形式: ascii

  • 最大文字数: 255

  • 使用可能記号: -_.

  • 半角スペース使用不可

[例]
domain.local

必須

string

query

bind_user

バインドユーザーを指定します。
「ユーザー ログオン名」 (username@domain)または、
「ユーザー ログオン名 (Windows 2000より前)」 (workgroup\username)を指定します。
domainやworkgroupは省略可能です。

  • 形式: ascii

  • 最大文字数: 255

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

[例]
administrator@domain.local

必須

string

query

bind_password

バインドユーザーのパスワードを指定します。

  • 形式: ascii

  • 最大文字数: 130

[例]
capacity_consumed,stora

必須

string

query

description

認証サーバの説明を指定します。

  • 最大文字数: 256

[例]
Main Server

任意

string

query

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

ip_address

IPアドレス

string

port_no

ポート番号

integer

domain

認証サーバドメイン

string

bind_user

バインドユーザー

string

description

認証サーバの説明

string

1.2.11.4 PUT /v1/auth/servers/{id}

機能

認証サーバ変更

処理概要

認証サーバの登録情報を変更します。
パラメーターで指定した項目のみ変更できます。
変更するパラメーターが指定されなかった場合は、変更せず正常終了で復帰します。
この操作を実行すると、現在の共有フォルダへのNASアクセスが中断されます。操作前にNASアクセスがないことを確認してください。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

認証サーバのID

必須

integer

path

ip_address

IPアドレスを指定します。

  • 形式: ipv4形式

[例]
192.168.1.1

任意

string

query

domain

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

  • 形式: ascii

  • 最大文字数: 255

  • 使用可能記号: -_.

  • 半角スペース使用不可

[例]
domain.local

任意

string

query

bind_user

バインドユーザーを指定します。
「ユーザー ログオン名」 (username@domain)または、
「ユーザー ログオン名 (Windows 2000より前)」 (workgroup\username)を指定します。
domainやworkgroupは省略可能です。

  • 形式: ascii

  • 最大文字数: 255

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

[例]
administrator@domain.local

任意

string

query

bind_password

バインドユーザーのパスワードを指定します。

  • 形式: ascii

  • 最大文字数: 130

[例]
capacity_consumed,stora

任意

string

query

description

認証サーバの説明を指定します。

  • 最大文字数: 256

[例]
Main Server

任意

string

query

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

202

request_id

リクエストID

integer

id

認証サーバのID

integer

ip_address

IPアドレス

string

port_no

ポート番号

integer

domain

認証サーバドメイン

string

bind_user

バインドユーザー

string

description

認証サーバの説明

string

1.2.11.5 DELETE /v1/auth/servers

機能

認証サーバ削除

処理概要

認証サーバを削除します。
この操作を実行すると、現在の共有フォルダへのNASアクセスが中断されます。操作前にNASアクセスがないことを確認してください。

パラメーター

パラメーター名

説明

指定

形式

タイプ

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

1.2.11.6 POST /v1/auth/servers/{id}/test

機能

認証サーバテスト

処理概要

選択された認証サーバの動作テストを行います。
認証サーバのIDとユーザー名、パスワードを指定し、動作テストが成功すると、正常終了で復帰します。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

認証サーバのID

必須

integer

path

user_name

ユーザー名を指定します。

  • 形式: ascii

  • 最大文字数: 255

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


以下のどちらかの形式で指定してください。

  • 「ユーザーログオン名」（username@domainの形式）

  • 「ユーザーログオン名 (Windows 2000より前)」（workgroup\usernameの形式）


[例]
example@domain.local

必須

string

query

password

パスワードを指定します。

  • 形式: ascii

  • 文字数: 1～130

[例]
password

必須

string

query

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

200

id

認証サーバのID

integer

ip_address

IPアドレス

string

port_no

ポート番号

integer

domain

認証サーバドメイン

string

bind_user

バインドユーザー

string

description

認証サーバの説明

string

前次
Copyright FUJITSU LIMITED 2018-20