更新 SFTP 服务器

您可以更新服务器的访问权限配置，从而更新允许连接到 Cloud FTP 服务器的用户。 您还可以更新元数据，例如服务器的显示名称。

创建服务器后，您无法更改服务器是外部服务器还是内部服务器。

所需的角色

如需获得更新 SFTP 服务器所需的权限，请让您的管理员为您授予项目的 Cloud FTP Admin (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。您必须至少提供一个值，最多可以提供 500 个 CIDR 块。如需允许来自所有 IP 地址的连接，请使用 0.0.0.0/0。

HTTP 方法和网址：

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。您必须至少指定一个项目。
• CONNECTION_LIMIT：可在使用方项目中创建的 Private Service Connect 端点数量上限。
• （可选）PROJECT_TO_REJECT：禁止连接到服务器的使用方项目的项目 ID 或编号。例如 example-rejected-project。 即使此列表中的项目包含在允许的项目列表中，也会被拒绝访问服务器。如果此列表为空，则表示没有项目被明确拒绝。

HTTP 方法和网址：

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 方法和网址：

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

该响应用于标识长时间运行的操作。服务器需要几秒钟的时间才能完成更新。