このドキュメントでは、Cloud FTP サーバーに関する情報を取得する方法について説明します。プロジェクトとロケーションにあるすべての SFTP サーバーを一覧表示できます。また、サーバーの状態や接続の詳細など、特定のサーバーに関する詳細情報を取得することもできます。
必要なロール
SFTP サーバーに関する情報を取得するために必要な権限を取得するには、プロジェクトに対する Cloud FTP 閲覧者 (roles/ftp.viewer)IAM ロールの付与を管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。
この事前定義ロールには、SFTP サーバーに関する情報を取得するために必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。
必要な権限
SFTP サーバーに関する情報を取得するには、次の権限が必要です。
-
サーバーを一覧表示します:
ftp.servers.list -
サーバーの詳細を取得します。
ftp.servers.get
カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。
サーバーを一覧表示する
コンソール
- Google Cloud コンソールで、[Cloud FTP] ページに移動します。
サーバーのリストが表示されます。
gcloud
SFTP サーバーを一覧表示するには、gcloud alpha storage ftp servers list コマンドを実行します。
後述のコマンドデータを使用する前に、次のように置き換えます。
- LOCATION_ID: サーバーのロケーション(
us-west1など)。
次のコマンドを実行します。
Linux、macOS、Cloud Shell
gcloud alpha storage ftp servers list --location=LOCATION_ID
Windows(PowerShell)
gcloud alpha storage ftp servers list --location=LOCATION_ID
Windows(cmd.exe)
gcloud alpha storage ftp servers list --location=LOCATION_ID
REST
SFTP サーバーを一覧表示するには、servers.list メソッドを使用します。
リクエストのデータを使用する前に、次のように置き換えます。
- PROJECT_ID: Google Cloud プロジェクト ID。
- LOCATION_ID: サーバーのロケーション(
us-west1など)。
HTTP メソッドと URL:
GET https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers
リクエストを送信するには、次のいずれかのオプションを展開します。
レスポンスの本文は、Server リソースのリストを含む JSON オブジェクトです。
サーバーの詳細を取得する
サーバーの IP アドレスやサービス アタッチメント、状態、認証情報、サービス エージェントのメールアドレスなど、特定のサーバーに関する詳細情報を取得するには、次の操作を行います。
コンソール
- Google Cloud コンソールで、[Cloud FTP] ページに移動します。
サーバー名をクリックします。
gcloud
SFTP サーバーの詳細を取得するには、gcloud alpha storage ftp servers describe コマンドを実行します。
後述のコマンドデータを使用する前に、次のように置き換えます。
- SERVER_ID: SFTP サーバー ID。
- LOCATION_ID: サーバーのロケーション(
us-west1など)。
次のコマンドを実行します。
Linux、macOS、Cloud Shell
gcloud alpha storage ftp servers describe SERVER_ID --location=LOCATION_ID
Windows(PowerShell)
gcloud alpha storage ftp servers describe SERVER_ID --location=LOCATION_ID
Windows(cmd.exe)
gcloud alpha storage ftp servers describe SERVER_ID --location=LOCATION_ID
REST
SFTP サーバーの詳細を取得するには、servers.get メソッドを使用します。
リクエストのデータを使用する前に、次のように置き換えます。
- PROJECT_ID: Google Cloud プロジェクト ID。
- LOCATION_ID: サーバーのロケーション(
us-west1など)。 - SERVER_ID: SFTP サーバー ID。
HTTP メソッドと URL:
GET https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID
リクエストを送信するには、次のいずれかのオプションを展開します。
レスポンスの本文は Server リソースです。