SFTP サーバー情報を取得する

このドキュメントでは、Cloud FTP サーバーに関する情報を取得する方法について説明します。プロジェクトとロケーション内のすべての SFTP サーバーを一覧表示できます。また、サーバーの状態や接続の詳細など、特定のサーバーに関する詳細情報を取得することもできます。

必要なロール

SFTP サーバーに関する情報を取得するために必要な権限を取得するには、プロジェクトに対するCloud FTP 閲覧者 （roles/ftp.viewer）IAM ロールの付与を管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

この事前定義ロールには SFTP サーバーに関する情報を取得するために必要な権限が設定されています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

SFTP サーバーに関する情報を取得するには、次の権限が必要です。

• サーバーを一覧表示する: ftp.servers.list
• サーバーの詳細を取得する: ftp.servers.get

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

サーバーを一覧表示する

gcloud

SFTP サーバーを一覧表示するには、 gcloud alpha storage ftp servers list コマンドを実行します。

後述のコマンドデータを使用する前に、 次のように置き換えます。

• LOCATION_ID：サーバーのロケーション（us-west1など）。

次のコマンドを実行します。

Linux、macOS、Cloud Shell

注: 認証とプロジェクトを使用して Google Cloud CLI を初期化するには、gcloud init、gcloud auth login、または gcloud config set project のいずれかを実行します。

gcloud alpha storage ftp servers list --location=LOCATION_ID

Windows（PowerShell）

注: 認証とプロジェクトを使用して Google Cloud CLI を初期化するには、gcloud init、gcloud auth login、または gcloud config set project のいずれかを実行します。

gcloud alpha storage ftp servers list --location=LOCATION_ID

Windows（cmd.exe）

注: 認証とプロジェクトを使用して Google Cloud CLI を初期化するには、gcloud init、gcloud auth login、または gcloud config set project のいずれかを実行します。

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

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers" | Select-Object -Expand Content

レスポンスの本文は、 Server リソースのリストを含む JSON オブジェクトです。

サーバーの詳細を取得する

特定のサーバーに関する詳細情報（サーバーの IP アドレスまたはサービス アタッチメント、状態、認証情報、サービス エージェントのメールアドレスなど）を取得するには、次の手順を行います。

gcloud

SFTP サーバーの詳細を取得するには、 gcloud alpha storage ftp servers describe コマンドを実行します。

後述のコマンドデータを使用する前に、 次のように置き換えます。

• SERVER_ID: SFTP サーバー ID。
• LOCATION_ID：サーバーのロケーション（us-west1など）。

次のコマンドを実行します。

Linux、macOS、Cloud Shell

注: 認証とプロジェクトを使用して Google Cloud CLI を初期化するには、gcloud init、gcloud auth login、または gcloud config set project のいずれかを実行します。

gcloud alpha storage ftp servers describe SERVER_ID --location=LOCATION_ID

Windows（PowerShell）

注: 認証とプロジェクトを使用して Google Cloud CLI を初期化するには、gcloud init、gcloud auth login、または gcloud config set project のいずれかを実行します。

gcloud alpha storage ftp servers describe SERVER_ID --location=LOCATION_ID

Windows（cmd.exe）

注: 認証とプロジェクトを使用して Google Cloud CLI を初期化するには、gcloud init、gcloud auth login、または gcloud config set project のいずれかを実行します。

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

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID" | Select-Object -Expand Content

レスポンスの本文は Server リソースです。