SFTP サーバーを更新する

Cloud FTP サーバーへの接続を許可するユーザーを更新するには、サーバーのアクセス構成を更新します。サーバーの表示名などのメタデータを更新することもできます。

サーバーの作成後に、サーバーが外部か内部かを変更することはできません。

必要なロール

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

この事前定義ロールには、SFTP サーバーを更新するために必要な ftp.servers.update 権限が含まれています。

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

外部サーバーのアクセス権を更新する

REST

外部サーバーのアクセス構成を更新するには、servers.patch メソッドを使用します。updateMask クエリ パラメータで、externalConfig フィールドを指定します。

注意: リクエスト本文で指定した CIDR ブロックは、既存の値をすべて上書きします。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: サーバーの Google Cloud プロジェクト ID。
• LOCATION_ID: サーバーのロケーション（us-west1 など）。
• SERVER_ID: サーバー ID。
• CIDR_BLOCK: サーバーへのアクセスが許可されている CIDR ブロック。たとえば、192.0.2.0/24 です。少なくとも 1 つの値を指定する必要があります。指定できる CIDR ブロックの最大数は 500 個です。すべての IP アドレスからの接続を許可するには、0.0.0.0/0 を使用します。

HTTP メソッドと URL:

PATCH https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID?updateMask=externalConfig

リクエストの本文（JSON）:

{
  "externalConfig": {
    "allowedCidrBlocks": [
      "CIDR_BLOCK"
    ]
  }
}

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

curl（Linux、macOS、Cloud Shell）

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

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID?updateMask=externalConfig"

PowerShell（Windows）

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

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

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

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID?updateMask=externalConfig" | Select-Object -Expand Content

レスポンスで長時間実行オペレーションを識別できます。サーバーの更新には数秒かかります。

内部サーバーのアクセス権を更新する

REST

内部サーバーのアクセス構成を更新するには、servers.patch メソッドを使用します。updateMask クエリ パラメータで、internalConfig フィールドを指定します。

注意: リクエスト本文で指定する許可されたコンシューマー プロジェクトと拒否されたコンシューマー プロジェクトのリストは、既存のすべての値を上書きします。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: サーバーの Google Cloud プロジェクト ID。
• LOCATION_ID: サーバーのロケーション（us-west1 など）。
• SERVER_ID: サーバー ID。
• PROJECT_TO_ALLOW: Private Service Connect を使用してサーバーに接続できるコンシューマー プロジェクトのプロジェクト ID または番号。たとえば、example-allowed-project です。少なくとも 1 つのプロジェクトを指定する必要があります。
• CONNECTION_LIMIT: コンシューマー プロジェクトで作成できる Private Service Connect エンドポイントの最大数。
• （省略可）PROJECT_TO_REJECT: サーバーへの接続が禁止されているコンシューマー プロジェクトのプロジェクト ID または番号。例: example-rejected-projectこのリストに含まれるプロジェクトは、許可されたプロジェクトのリストに含まれていても、サーバーへのアクセスが拒否されます。このリストが空の場合、明示的に拒否されたプロジェクトはありません。

HTTP メソッドと URL:

PATCH https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID?updateMask=internalConfig

リクエストの本文（JSON）:

{
  "internalConfig": {
    "consumerAcceptList": [
      {
        "project": "projects/PROJECT_TO_ALLOW",
        "connectionLimit": CONNECTION_LIMIT
      }
    ],
    "consumerRejectList": [
      {
        "project": "projects/PROJECT_TO_REJECT"
      }
    ]
  }
}

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

curl（Linux、macOS、Cloud Shell）

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

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID?updateMask=internalConfig"

PowerShell（Windows）

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

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

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

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID?updateMask=internalConfig" | Select-Object -Expand Content

レスポンスで長時間実行オペレーションを識別できます。サーバーの更新には数秒かかります。

サーバーの表示名を更新する

REST

SFTP サーバーの表示名などのメタデータを更新するには、servers.patch メソッドを使用します。updateMask クエリ パラメータで、更新するフィールドのカンマ区切りのリストを指定します。リクエストの本文に、設定する値を含む JSON オブジェクトを指定します。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: サーバーの Google Cloud プロジェクト ID。
• LOCATION_ID: サーバーのロケーション（us-west1 など）。
• SERVER_ID: サーバー ID。
• FIELDS_TO_UPDATE: 更新するフィールドのカンマ区切りのリスト（サーバー リソースを基準とした相対パス）。たとえば、表示名を更新するには、クエリ パラメータ updateMask=displayName を指定します。
• DISPLAY_NAME: サーバーの表示名。

HTTP メソッドと URL:

PATCH https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID?updateMask=FIELDS_TO_UPDATE

リクエストの本文（JSON）:

{
  "displayName": "DISPLAY_NAME"
}

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

curl（Linux、macOS、Cloud Shell）

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

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID?updateMask=FIELDS_TO_UPDATE"

PowerShell（Windows）

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

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

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

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://ftp.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/servers/SERVER_ID?updateMask=FIELDS_TO_UPDATE" | Select-Object -Expand Content

レスポンスで長時間実行オペレーションを識別できます。サーバーの更新には数秒かかります。