设置和移除自定义元数据

控制台

1. 在 Google Cloud 控制台中，前往元数据页面。

   转到“自定义元数据”页面

2. 点击页面顶部的 edit 修改。

3. 如需添加新的自定义项目元数据条目，请执行以下操作：

   1. 导航到页面底部，然后点击 add_box 添加项。
   2. 在键字段中，输入自定义元数据键的名称。
   3. 在值字段中，输入自定义项目元数据值。
   4. 可选。如需添加更多自定义项目元数据条目，请针对要添加的每个元数据条目重复上述步骤。
   5. 如需完成添加自定义项目元数据条目，请点击保存。

4. 如需修改现有的自定义项目元数据条目，请执行以下操作：

   1. 转到要修改的元数据条目。
   2. 如需更新特定自定义元数据键的名称，请在该条目的键字段中输入新名称。
   3. 如需更新自定义项目元数据条目的值，请在该条目的值字段中输入新值。
   4. 可选。如需移除特定的自定义项目元数据条目，请点击元数据条目旁边的 delete 删除图标。
   5. 如需修改多个自定义项目元数据条目，请针对要修改的每个元数据条目重复上述步骤。
   6. 如需完成修改自定义项目元数据条目，请点击保存。

gcloud

使用 project-info add-metadata 命令。

gcloud compute project-info add-metadata \
    --metadata=KEY=VALUE

请替换以下内容：

• KEY：元数据键的名称
• VALUE：为此键存储的值

示例

例如，如需在项目上设置两个新条目 foo=bar 和 baz=bat，请运行以下命令：

gcloud compute project-info add-metadata \
    --metadata=foo=bar,baz=bat

您可以视情况使用 --metadata-from-file 标志指定一个或多个要从中读取元数据的文件。

REST

1. 可选。如需执行乐观锁定，您可以选择提供指纹。

   指纹是由 Compute Engine 生成的随机字符串。每次请求后指纹都会更改，因此如果您提供的指纹不匹配，请求会被拒绝。

   如果您未提供指纹，则无需执行一致性检查，且 projects().setCommonInstanceMetadata 请求会成功。此行为与 instances().setMetadata 和 instanceSettings().patch 方法不同，后者始终需要指纹。

   要获取项目的当前指纹，请调用 project().get 方法。

   GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID
   

   输出类似于以下内容：

   {
     "name": "myproject",
     "commonInstanceMetadata": {
       "kind": "compute#metadata",
       "fingerprint": "FikclA7UBC0=",
       ...
     }
   }
   

2. 向 projects().setCommonInstanceMetadata 方法发出请求，并设置您的自定义元数据键值对：

   POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/setCommonInstanceMetadata
   
   {
     "fingerprint": "FikclA7UBC0=",
     "items": [
       {
       "key": "foo",
       "value": "bar"
       }
     ]
   }
   

将 PROJECT_ID 替换为项目 ID。

gcloud

• 如需添加或更新自定义可用区元数据，请使用 gcloud compute project-zonal-metadata add 命令。

  gcloud compute project-zonal-metadata add \
    --zone=ZONE \
    --project=PROJECT_ID  \
    --metadata=KEY1=VALUE1,KEY2=VALUE2,...

  替换以下内容：

  • PROJECT_ID：您的项目 ID
  • ZONE：要添加或更新可用区元数据的可用区。
  • KEY1、KEY2...：要为其添加或更新可用区元数据值的自定义元数据键。

  • VALUE1、VALUE2...：您要为现有和新的自定义元数据键设置的可用区元数据值。根据自定义元数据键和值，会发生以下一种情况：

  • 如果相应的自定义元数据键是具有项目元数据的现有键，则在指定的可用区中，Compute Engine 会使用您指定的可用区元数据值替换该键的项目元数据值。项目中指定可用区中的所有虚拟机都会继承为该键新指定的可用区元数据，而其他可用区中的虚拟机将继续保留其现行的项目或可用区元数据值。如果您对此键的项目元数据值进行任何未来更新，项目中此可用区中的虚拟机将保持不变，并继续使用此键的可用区元数据值。

  • 如果相应的自定义元数据键是未用于现有项目或可用区元数据的新元数据键，则 Compute Engine 会创建自定义元数据键并将此值设置为指定的可用区中的可用区元数据。

  • 如果相应的自定义元数据键是现有的元数据键，且在指定的可用区中具有可用区元数据值：

    • 如果指定的元数据值与现有值不同，Compute Engine 会使用新值更新可用区元数据条目。
    • 如果指定的元数据值与现有值相同，则可用区元数据条目保持不变。

示例：添加新的自定义可用区元数据条目

例如，假设有一个名为 my-project 的项目，其中包含以下自定义元数据：

• 项目元数据："key-1":"value-a"、"key-2":"value-b" 和 "key-3":"value-c"
• us-central1-a 可用区中的可用区元数据："key-1":"value-1" 和 "key-2":"value-2"

如需将 "key-4":"value-4" 添加为 us-central1-a 可用区中的新自定义可用区元数据对，请运行以下命令：

gcloud compute project-zonal-metadata add \
    --metadata=key-4=value-4 \
    --project=my-project \
    --zone=us-central1-a

示例：更新现有自定义可用区元数据条目的值

考虑相同的示例项目 my-project，它现在具有以下自定义元数据：

• 项目元数据："key-1":"value-a"、"key-2":"value-b" 和 "key-3":"value-c"
• us-central1-a 可用区中的可用区元数据："key-1":"value-1"、"key-2":"value-2" 和 "key-4":"value-4"

如需使用新值更新 us-cerntral1-a 可用区中 key-1 和 key-4 的可用区元数据值，请运行以下命令。

gcloud compute project-zonal-metadata add \
    --metadata=key-1=new-value-1,key-4=new-value-4 \
    --project=my-project \
    --zone=us-central1-a

示例：替换键的项目元数据值，并使用可用区元数据值

考虑相同的示例项目 my-project，它现在具有以下自定义元数据：

• 项目元数据："key-1":"value-a"、"key-2":"value-b" 和 "key-3":"value-c"
• us-central1-a 可用区中的可用区元数据："key-1":"new-value-1"、"key-2":"value-2" 和 "key-4":"new-value-4"

在本示例项目中，请考虑 key-3，其项目元数据值为 value-c。假设您要为 us-central1-a 可用区中所有虚拟机的此键设置可用区级元数据值 value-3。执行该操作时，对于 us-central1-a 可用区中的所有虚拟机，Compute Engine 会替换项目元数据值并使用可用区元数据值。项目的所有其他可用区中的虚拟机都会保留 key-3 的现行项目或可用区元数据值。

如需替换 key-3 的项目元数据值并设置可用区元数据值，请运行以下命令：

gcloud compute project-zonal-metadata add \
    --metadata=key-3=value-3 \
    --project=my-project \
    --zone=us-central1-a

REST

1. 获取当前指纹并查看该可用区中项目的任何现有键值对。

   如需执行乐观锁定，您必须提供指纹。指纹是由 Compute Engine 生成的随机字符串。每次您请求添加、更新或移除可用区元数据时，指纹都会发生变化。如果您提供的指纹不匹配，Compute Engine 会拒绝您的请求。

   如果您未提供指纹，系统会执行一致性检查，且您的更新请求不会成功。这样，一次就只能进行一项请求，以免发生冲突。此行为与 instances().setMetadata 匹配，后者始终需要指纹。

   如需获取可用区元数据的当前指纹，请向 instanceSettings().get 方法发出 GET 请求。

   GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instanceSettings
   

   替换以下内容：

   • PROJECT_ID：您的项目 ID
   • ZONE：要设置可用区元数据的可用区。

   以下是此请求的示例输出：

       {
         "fingerprint": "VlRIl8dx9vk=",
         "metadata": {
           ...
         }
       }
   

2. 如需添加或更新可用区元数据，请向 instanceSettings().patch 方法发出 PATCH 请求。 您必须在请求中提供以下信息：

   • 更新掩码。使用 update_mask 查询参数。更新掩码必须包含以下内容的元数据键：

     • 要添加的新自定义可用区元数据
     • 要更新值的现有自定义可用区元数据

     您必须添加字符串 metadata.items. 作为每个键的前缀，例如 metadata.items.key1,metadata.items.key3。

   • 在请求正文中，提供以下信息：

     • 要添加的新自定义可用区元数据的元数据键和值
     • 要更新的现有自定义可用区元数据的元数据键和值
     • 当前的指纹值

   PATCH https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instanceSettings?update_mask=PREFIXED_METADATA_KEYS
   {
     "fingerprint": "FINGER_PRINT",
     "metadata": {
       "items": {
         "KEY1": "VALUE1",
         "KEY2": "VALUE2",
         ...
       }
     }
   }
   

   替换以下内容：

   • PROJECT_ID：项目的 ID。
   • ZONE：要设置可用区元数据的可用区。

   • PREFIXED_METADATA_KEYS：以下各项的元数据键列表，其中每个键都以字符串 metadata.items. 为前缀：

     • 要添加的新自定义可用区元数据
     • 要更新值的现有自定义可用区元数据

     例如，假设您当前在特定可用区中的可用区元数据键为 key-1 和 key-2。如果您要为该可用区中的可用区元数据添加新的键 key-3，同时还要更新其中一个现有键 key-1 的可用区元数据，则您的更新掩码必须具有以下字符串：

     metadata.items.key1,metadata.items.key3

   • FINGER_PRINT：当前的指纹值。

   • KEY1、KEY2...：要为其添加或更新值的自定义可用区元数据键。指定您在更新掩码中指定的所有自定义可用区元数据键。

   • VALUE1、VALUE2...：您要为现有和新的自定义元数据键设置的可用区元数据值。根据自定义元数据键和值，会发生以下一种情况：

     • 如果相应的自定义元数据键是具有项目元数据的现有键，则在指定的可用区中，Compute Engine 会使用您指定的可用区元数据值替换该键的项目元数据值。项目中指定可用区中的所有虚拟机都会继承为该键新指定的可用区元数据，而其他可用区中的虚拟机将继续保留其现行的项目或可用区元数据值。如果您对此键的项目元数据值进行任何未来更新，项目中此可用区中的虚拟机将保持不变，并继续使用此键的可用区元数据值。
     • 如果相应的自定义元数据键是尚未用于现有项目或可用区元数据的新元数据键，则 Compute Engine 会创建自定义元数据键并将此值设置为指定可用区中的可用区元数据。

     • 如果相应的自定义元数据键是现有的元数据键，且在指定的可用区中具有可用区元数据值：

     • 如果指定的元数据值与现有值不同，Compute Engine 会使用新值更新可用区元数据条目。

     • 如果指定的元数据值与现有值相同，则可用区元数据条目保持不变。

示例：添加新的自定义可用区元数据条目

例如，假设有一个名为 my-project 的项目，其中包含以下自定义元数据：

• 项目元数据："key-1":"value-a"、"key-2":"value-b" 和 "key-3":"value-c"
• us-central1-a 可用区中的可用区元数据："key-1":"value-1" 和 "key-2":"value-2"

如需将 "key-4":"value-4" 添加为 us-central1-a 可用区中的新自定义可用区元数据对，请发出以下 PATCH 请求：

PATCH https://compute.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instanceSettings?update_mask=metadata.items.key-4
{
  "fingerprint": "VlRIl8dx9vk=",
  "metadata": {
  "items": {
    "key-4": "value-4"
    }
  }
}

示例：更新现有自定义可用区元数据条目的值

考虑相同的示例项目 my-project，它现在具有以下自定义元数据：

• 项目元数据："key-1":"value-a"、"key-2":"value-b" 和 "key-3":"value-c"
• us-central1-a 可用区中的可用区元数据："key-1":"value-1"、"key-2":"value-2" 和 "key-4":"value-4"

如需使用新值更新 us-cerntral1-a 可用区中 key-1 和 key-4 的可用区元数据值，请发出以下 PATCH 请求：

PATCH https://compute.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instanceSettings?update_mask=metadata.items.key-1,metadata.items.key-4
{
  "fingerprint": "VlRIl8dx9vk=",
  "metadata": {
  "items": {
    "key-1": "new-value-1",
    "key-4": "new-value-4"
    }
  }
}

示例：替换键的项目元数据值，并设置可用区元数据值

考虑相同的示例项目 my-project，它现在具有以下自定义元数据：

• 项目元数据："key-1":"value-a"、"key-2":"value-b" 和 "key-3":"value-c"
• us-central1-a 可用区中的可用区元数据："key-1":"new-value-1"、"key-2":"value-2" 和 "key-4":"new-value-4"

在本示例项目中，请考虑 key-3，其项目元数据值为 value-c。假设您要为 us-central1-a 可用区中所有虚拟机的此键设置可用区级元数据值 value-3。执行该操作时，对于 us-central1-a 可用区中的所有虚拟机，Compute Engine 会替换项目元数据值并使用可用区元数据值。项目的所有其他可用区中的虚拟机都会保留 key-3 的现行项目或可用区元数据值。

如需替换 key-3 的项目元数据值，并改用可用区元数据值 value-3，请发出以下 PATCH 请求：

PATCH https://compute.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instanceSettings?update_mask=metadata.items.key-3
{
  "fingerprint": "VlRIl8dx9vk=",
  "metadata": {
  "items": {
    "key-3": "value-3"
    }
  }
}

控制台

1. 在 Google Cloud 控制台中，前往创建实例页面。

   转到“创建实例”

2. 指定虚拟机详情。

3. 展开高级选项部分，然后执行以下操作：

   1. 展开管理部分。
   2. 如需为自定义元数据添加多个键值对，请点击元数据部分中的添加一项。

4. 如需创建虚拟机，请点击创建。

gcloud

如需设置自定义元数据，请使用带有 --metadata 标志的 gcloud compute instances create 命令。

gcloud compute instances create VM_NAME \
--zone=ZONE \
--image-project=IMAGE_PROJECT \
IMAGE_FLAG \
--metadata=KEY=VALUE

请替换以下内容：

• VM_NAME：您的虚拟机的名称
• ZONE：要在其中创建虚拟机的可用区
• IMAGE_PROJECT：包含用于虚拟机的映像的项目

• IMAGE_FLAG：指定以下其中一项：

  • 使用 --image IMAGE_NAME 标志指定公共映像的特定版本。

    例如 --image debian-12-bookworm-v20241112。

  • 使用 --image-family IMAGE_FAMILY_NAME 标志指定映像系列。

    此项表示通过映像系列中最新未弃用的操作系统映像创建虚拟机。例如，如果您指定 --image-family debian-12，Compute Engine 会使用 Debian 12 映像系列中最新版本的操作系统映像。

• KEY：元数据键的名称

• VALUE：为此键存储的值

示例

例如，如需在名为 example-instance 的虚拟机上设置值为 test 的新键 env，请运行以下命令：

 gcloud compute instances create example-instance \
   --zone=us-central1-a --image-project=debian-cloud \
   --image-family=debian-12 \
   --metadata=env=test

REST

使用 instances.insert 方法并在请求中提供自定义元数据作为 metadata 属性的一部分：

POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances

{
  "machineType": "zones/MACHINE_TYPE_ZONE/machineTypes/MACHINE_TYPE",
  "name": "VM_NAME",
  "...": [
    {
    }
    ],
  "metadata": {
    "items": [
      {
        "key": "KEY",
        "value": "VALUE"
      }
    ]
  },
  ..
}

请替换以下内容：

• PROJECT_ID：您的项目 ID
• ZONE：要在其中创建虚拟机的可用区
• MACHINE_TYPE：新虚拟机的预定义或自定义机器类型
• VM_NAME：新虚拟机的名称
• KEY：元数据键的名称
• VALUE：为此键存储的值

控制台

1. 在 Google Cloud 控制台中，前往虚拟机实例页面。

   转到“虚拟机实例”页面

2. 点击您想要更新其元数据的实例。
3. 点击页面顶部的修改按钮。
4. 在自定义元数据下，点击添加一项或修改现有的元数据条目。
5. 保存更改。

gcloud

使用 gcloud CLI 更新虚拟机元数据是一项附加性操作。请仅指定您要添加或更改的元数据键。如果您提供的键已经存在，则系统将使用新值来更新该键对应的值。

使用 instances add-metadata 命令：

gcloud compute instances add-metadata VM_NAME \
    --metadata=KEY=VALUE,KEY=VALUE

请替换以下内容：

• VM_NAME：您的虚拟机的名称
• KEY：元数据键的名称
• VALUE：为此键存储的值

示例

如果要添加 foo=bar 条目，请使用以下命令：

gcloud compute instances add-metadata VM_NAME \
    --metadata=foo=bar

如果您要将 foo=bar 条目更改为 foo=bat，请使用以下命令：

gcloud compute instances add-metadata VM_NAME \
    --metadata=foo=bat

REST

1. 获取当前指纹，并查看虚拟机的任何现有键值对。为此，请调用 instances().get 方法。

   指纹是由 Compute Engine 生成的随机字符串，可用于执行乐观锁定。 如需更新虚拟机，您需要提供匹配的指纹值。每次请求后指纹都会更改，因此如果您提供的指纹不匹配，请求将被拒绝。这样，一次就只能进行一项更新，以免发生冲突。

   GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/VM_NAME
   

   替换以下内容：

   • PROJECT_ID：您的项目 ID
   • ZONE：虚拟机所在的可用区
   • VM_NAME：您的虚拟机的名称

   输出类似于以下内容：

   {
     ...
     "name": "example-instance",
     "metadata": {
       "kind": "compute#metadata",
       "fingerprint": "zhma6O1w2l8="
       "items": [
         {
           "key": "foo",
           "value": "bar"
         }
       ]
       },
     ...
   }
   

2. 向 instances().setMetadata 方法发出请求。 请提供新元数据值和当前 fingerprint 值的列表。

   如果您想要保留虚拟机的现有键值对，则必须将这些现有键值对和新键值对都加入此请求中。

   示例

   POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/VM_NAME/setMetadata
   
   {
   "fingerprint": "zhma6O1w2l8=",
   "items": [
     {
       "key": "foo",
       "value": "bar"
     },
     {
       "key": "baz",
       "value": "bat"
     }
   ]
   }
   

   请替换以下内容：

   • PROJECT_ID：您的项目 ID
   • ZONE：虚拟机所在的可用区
   • VM_NAME：您的虚拟机的名称

控制台

1. 在 Google Cloud 控制台中，前往元数据页面。

   转到“元数据”页面

2. 点击页面顶部的 edit 修改。

3. 找到要移除的元数据条目，然后点击该条目旁边的 delete 删除按钮。

   对要移除的每个元数据条目重复此步骤。

4. 如需完成自定义项目元数据条目的移除，请点击保存。

gcloud

如需移除自定义项目元数据，请使用 gcloud compute project-info remove-metadata 命令。

• 如果您要移除特定键的自定义元数据条目，请使用 --keys 标志指定这些键，并排除这些键的值。

gcloud compute project-info remove-metadata \
    --keys=KEY1,KEY2,...

• 如果要移除虚拟机的所有自定义元数据，请指定 --all 标志。

gcloud compute project-info remove-metadata \
    --all

替换以下内容：

• KEY1、KEY2...：要移除的自定义实例元数据键。

gcloud

如需移除自定义可用区元数据，请使用 gcloud compute project-zonal-metadata remove 命令，并使用 --keys 标志指定要移除的所有元数据键。

gcloud compute project-zonal-metadata remove \
    --project=PROJECT_ID  \
    --zone=ZONE \
    --keys=KEY1,KEY2,...

替换以下内容：

• PROJECT_ID：您的项目 ID
• ZONE：要移除可用区元数据的可用区。
• KEY1、KEY2...：要移除的自定义可用区元数据键。

运行该命令后，如果任何指定的键具有项目元数据值，则指定可用区中的虚拟机将继承这些项目元数据值。如果元数据条目仅在可用区级设置，且该键没有相应的项目元数据值，则该可用区中的虚拟机将丢失该元数据信息。

示例：

假设有一个示例项目 my-project，其中包含以下自定义项目元数据：

• 项目元数据："key-1":"value-a"、"key-2":"value-b" 和 "key-3":"value-c"
• us-central1-a 可用区中的可用区元数据："key-1":"new-value-1"、"key-2":"value-2"、"key-3":"value-3" 和 "key-4":"new-value-4"

如需移除 us-central1-a 可用区中的所有可用区元数据，请运行以下命令。

gcloud compute project-zonal-metadata remove \
    --metadata=key-1,key-2,key-3,key-4 \
    --project=my-project \
    --zone=us-central1-a

运行该命令后，us-central1-a 可用区中的虚拟机具有以下自定义项目元数据条目：

• "key-1":"value-a"
• "key-2":"value-b"
• "key-3":"value-c"

REST

1. 获取当前指纹并查看该可用区中项目的任何现有键值对。

   如需执行乐观锁定，您必须提供指纹。指纹是由 Compute Engine 生成的随机字符串。每次您请求添加、更新或移除可用区元数据时，指纹都会发生变化。如果您提供的指纹不匹配，Compute Engine 会拒绝您的请求。

   如果您未提供指纹，系统会执行一致性检查，且您的删除请求不会成功。这样，一次就只能进行一项请求，以免发生冲突。此行为与 instances().setMetadata 匹配，后者始终需要指纹。

   如需获取项目的当前指纹，请调用 instanceSettings().get 方法。

   GET https://compute.googleapis.com/compute/beta/projects/PROJECT_ID/zones/ZONE/instanceSettings
   

   替换以下内容：

   • PROJECT_ID：您的项目 ID
   • ZONE：要移除可用区元数据的可用区。

   以下是此请求的示例输出：

       {
         "fingerprint": "FikclA7UBC0=",
         "metadata": {
           ...
         }
       }
   

2. 如需移除自定义可用区元数据，请向 instanceSettings().patch 方法发出 PATCH 请求，方法是从请求正文中排除要移除其可用区元数据的元数据键。您必须在请求中提供以下信息：

   • 更新掩码。使用 update_mask 查询参数。更新掩码必须包含您要移除其可用区元数据的所有现有自定义元数据键。您必须添加字符串 metadata.items. 作为每个键的前缀，例如 metadata.items.key1,metadata.items.key3。

   • 在请求正文中，仅提供当前指纹值。排除您在更新掩码中指定的所有自定义元数据键。 如果您在更新掩码和请求正文中都添加任何元数据键，则 Compute Engine 不会移除这些键的可用区元数据。

   PATCH https://compute.googleapis.com/compute/beta/projects/PROJECT_ID/zones/ZONE/instanceSettings?update_mask=PREFIXED_METADATA_KEYS
   {
     "fingerprint": "FINGER_PRINT",
     "metadata": {
       "items": {
       }
     }
   }
   

   替换以下内容：

   • PROJECT_ID：项目的 ID。
   • ZONE：要移除可用区元数据的可用区。

   • PREFIXED_METADATA_KEYS：要移除可用区级元数据的所有现有自定义元数据键的列表，其中每个键都以字符串 metadata.items. 为前缀。为确保删除请求成功，请从请求正文中排除这些元数据键。 如果您在更新掩码和请求正文中都添加任何元数据键，则 Compute Engine 不会移除这些键的可用区元数据。

     例如，假设您当前的具有可用区元数据的元数据键为 key-1、key-2、key-3 和 key-4，并且想要移除 key-1 和 key-2 的可用区元数据条目，则更新掩码必须具有以下字符串：

     metadata.items.key1,metadata.items.key2

   • FINGER_PRINT：当前的指纹值。

发出请求后，如果任何指定的键具有项目元数据值，则指定可用区中的虚拟机将继承这些项目元数据值。如果元数据键仅在可用区级设置，且该键没有相应的项目元数据值，则该可用区中的虚拟机将丢失该元数据信息。

示例：

假设有一个示例项目 my-project，其中包含以下自定义项目元数据：

• 项目元数据："key-1":"value-a"、"key-2":"value-b" 和 "key-3":"value-c"
• us-central1-a 可用区中的可用区元数据："key-1":"new-value-1"、"key-2":"value-2"、"key-3":"value-3" 和 "key-4":"new-value-4"

如需移除 us-central1-a 可用区中 key-1 和 key-2 的可用区元数据，请发出以下 PATCH 请求。

PATCH https://compute.googleapis.com/compute/beta/projects/my-project/zones/us-central1-a/instanceSettings?update_mask=metadata.items.key-1,metadata.items.key-2
{
  "fingerprint": "FikclA7UBC0=",
  "metadata": {
  "items": {
    }
  }
}

此请求完成后，us-central1-a 可用区中的虚拟机将具有以下自定义元数据。虚拟机会继承 key-1 和 key-2 的项目元数据值，但会保留 key-3 和 key-4 的可用区元数据。

• 项目元数据："key-1":"value-a" 和 "key-2":"value-b"
• us-central1-a 可用区中的可用区元数据："key-3":"value-3" 和 "key-4":"new-value-4"

控制台

1. 在 Google Cloud 控制台中，前往虚拟机实例页面。

   转到“虚拟机实例”页面

2. 在名称列中，点击要移除其元数据的虚拟机的名称。
3. 点击页面顶部的 edit 修改。
4. 在元数据部分，针对要移除的每个元数据条目点击 delete 删除项。
5. 如需确认您的更改并移除自定义实例元数据，请点击保存。

gcloud

如需移除自定义实例元数据，请使用 gcloud compute instances remove-metadata 命令。

• 如果您要移除特定键的自定义元数据条目，请使用 --keys 标志指定这些键，并排除这些键的值。

gcloud compute instances remove-metadata VM_NAME \
    --zone=ZONE  \
    --keys=KEY1,KEY2,...

• 如果要移除虚拟机的所有自定义元数据，请指定 --all 标志。

gcloud compute instances remove-metadata VM_NAME \
    --zone=ZONE  \
    --all

替换以下内容：

• PROJECT_ID：您的项目 ID。
• ZONE：您的虚拟机所在的可用区。
• VM_NAME：您的虚拟机的名称
• KEY1、KEY2...：要移除的自定义实例元数据键。

REST

1. 获取当前指纹，并查看虚拟机的任何现有键值对。为此，请调用 instances().get 方法。

   指纹是由 Compute Engine 生成的随机字符串，可用于执行乐观锁定。 如需更新虚拟机，您需要提供匹配的指纹值。每次请求后指纹都会更改，因此如果您提供的指纹不匹配，请求将被拒绝。这样，一次就只能进行一项更新，以免发生冲突。

   GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/VM_NAME
   

   替换以下内容：

   • PROJECT_ID：您的项目 ID。
   • ZONE：您的虚拟机所在的可用区。
   • VM_NAME：您的虚拟机的名称

   输出类似于以下内容：

   {
     ...
     "name": "example-instance",
     "metadata": {
       "kind": "compute#metadata",
       "fingerprint": "zhma6O1w2l8="
       "items": [
       {
         "key": "key-1",
         "value": "value-1"
       }
       {
         "key": "key-2",
         "value": "value-2"
       }
       ]
     },
     ...
   }
   

2. 向 instances().setMetadata 方法发出请求。 为了确保请求成功，您必须添加当前的元数据指纹值。

   • 如需从虚拟机中移除所有自定义元数据键值对，请在 items 属性中，移除要为其移除元数据值的元数据键。

     POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/VM_NAME/setMetadata
     
     {
     "fingerprint": "FINGER_PRINT"
     "items": [
       {
         "key": "KEY1"
         "value": "VALUE1"
       }
       {
         "key": "KEY2"
         "value": "VALUE2"
       }
       ...
     ]
     }
     

   • 如需移除虚拟机上的所有自定义实例元数据，请完全排除 items 属性。

     POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/VM_NAME/setMetadata
     
     {
     "fingerprint": FINGER_PRINT
     }
     

   替换以下内容：

   • PROJECT_ID：您的项目 ID。
   • ZONE：您的虚拟机所在的可用区。
   • VM_NAME：您的虚拟机的名称
   • FINGER_PRINT：当前的指纹值。
   • KEY1、KEY2...：要移除的自定义实例元数据键。
   • VALUE1、VALUE2...：要移除的自定义实例元数据键的值。