設定及移除自訂中繼資料

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

主控台

1. 前往 Google Cloud 控制台的「Metadata」頁面。

   前往「自訂中繼資料」頁面

2. 按一下頁面頂端的 edit「編輯」。

3. 如要新增自訂專案中繼資料項目，請按照下列步驟操作：

   1. 前往頁面底部，然後按一下 add_box「新增項目」。
   2. 在「Key」欄位中，輸入自訂中繼資料鍵的名稱。
   3. 在「Value」欄位中輸入自訂專案中繼資料值。
   4. 選用設定。如要新增更多自訂專案中繼資料項目，請針對每個要新增的中繼資料項目重複上述步驟。
   5. 如要完成新增自訂專案中繼資料項目，請按一下「儲存」。

4. 如要編輯現有的自訂專案中繼資料項目，請按照下列步驟操作：

   1. 前往要編輯的中繼資料項目。
   2. 如要更新特定自訂中繼資料鍵的名稱，請在該項目的「Key」欄位中輸入新名稱。
   3. 如要更新自訂專案中繼資料項目的值，請在該項目的「Value」欄位中輸入新值。
   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 會將該鍵的專案中繼資料值覆寫為您指定的區域中繼資料值。專案中指定區域的所有 VM 都會繼承該鍵的新指定可用區中繼資料，而其他區域的 VM 則會繼續保留其現行專案或可用區中繼資料值。如果您日後更新此鍵的專案中繼資料值，專案中這個區域的 VM 不會受到影響，並繼續使用此鍵的可用區中繼資料值。

  • 如果對應的自訂中繼資料鍵是新中繼資料鍵，且未用於現有專案或區域中繼資料，則 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"

如要在 us-central1-a 區域中新增自訂區域中繼資料組合，請執行下列指令"key-4":"value-4"

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 區域中的所有 VM 設定此鍵的可用區中繼資料值 value-3。執行作業時，對於 us-central1-a 區域中的所有 VM，Compute Engine 會覆寫專案中繼資料值，並使用區域中繼資料值。專案中所有其他可用區的 VM 都會保留 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：目前的 fingerprint 值。

   • KEY1、KEY2...：您要新增或更新值的自訂可用區中繼資料鍵。指定您在更新遮罩中指定的所有自訂區域中繼資料鍵。

   • VALUE1、VALUE2...：您要為現有和新的自訂中繼資料鍵設定的可用區中繼資料值。系統會根據自訂中繼資料鍵和值，執行下列其中一種操作：

     • 如果對應的自訂中繼資料鍵是具有專案中繼資料的現有鍵，則在指定區域中，Compute Engine 會將該鍵的專案中繼資料值覆寫為您指定的區域中繼資料值。專案中指定區域的所有 VM 都會繼承該鍵的新指定可用區中繼資料，而其他區域的 VM 則會繼續保留其現行專案或可用區中繼資料值。如果您日後更新此鍵的專案中繼資料值，專案中這個區域的 VM 不會受到影響，並繼續使用此鍵的可用區中繼資料值。
     • 如果對應的自訂中繼資料鍵是新中繼資料鍵，且未用於現有專案或區域中繼資料，則 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 區域中的所有 VM 設定此鍵的可用區中繼資料值 value-3。執行作業時，對於 us-central1-a 區域中的所有 VM，Compute Engine 會覆寫專案中繼資料值，並使用區域中繼資料值。專案中所有其他可用區的 VM 都會保留 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 控制台的「Create an instance」(建立執行個體) 頁面。

   前往「Create an instance」(建立執行個體)

2. 指定 VM 詳細資料。

3. 展開「Advanced options」(進階選項) 區段，然後執行下列操作：

   1. 展開「管理」部分。
   2. 如要為自訂中繼資料新增多個鍵/值組合，請在「中繼資料」區段中，按一下「新增項目」。

4. 如要建立 VM，請按一下「建立」。

gcloud

如要設定自訂中繼資料，請使用 gcloud compute instances create 指令搭配 --metadata 標記。

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

更改下列內容：

• VM_NAME：VM 名稱
• ZONE：建立 VM 的可用區
• IMAGE_PROJECT：包含 VM 所用映像檔的專案

• IMAGE_FLAG：指定下列其中一個值：

  • 使用 --image IMAGE_NAME 標記指定公開映像檔的特定版本。

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

  • 使用 --image-family IMAGE_FAMILY_NAME 標記指定映像檔系列。

    這會根據映像檔系列中未淘汰的最新 OS 映像檔建立 VM。舉例來說，如果您指定 --image-family debian-12，Compute Engine 會使用 Debian 12 映像檔系列中的最新版 OS 映像檔。

• KEY：中繼資料鍵的名稱

• VALUE：為此鍵儲存的值

示例

舉例來說，如要在名為 example-instance 的 VM 上設定值為 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：建立 VM 的可用區
• MACHINE_TYPE：新 VM 的機器類型，可選用預先定義或自訂
• VM_NAME：新 VM 的名稱
• KEY：中繼資料鍵的名稱
• VALUE：為此鍵儲存的值

主控台

1. 前往 Google Cloud 控制台的「VM instances」(VM 執行個體) 頁面。

   前往「VM instances」(VM 執行個體) 頁面

2. 按一下您要更新中繼資料的執行個體。
3. 按一下頁面頂端的 [編輯] 按鈕。
4. 在「Custom metadata」(自訂中繼資料)下，按一下 [Add item] (新增項目) 或編輯現有中繼資料項目。
5. 儲存變更。

gcloud

使用 gcloud CLI 更新 VM 中繼資料是一個附加的動作。請僅指定您要新增或變更的中繼資料鍵。如果您提供的鍵已經存在，該鍵的值就會更新為新值。

使用 instances add-metadata 指令：

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

更改下列內容：

• VM_NAME：VM 名稱
• 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. 取得目前指紋，並查看 VM 的任何現有鍵值組合。如要這麼做，請呼叫 instances().get 方法。

   指紋是由 Compute Engine 產生的隨機字元字串，可用來執行樂觀鎖定。如要更新 VM，您必須提供相符的指紋值。指紋會在每次要求後變更；如果您提供的指紋不符，系統便會拒絕您的要求。如此一來，一次就只能進行一項更新，而能夠防止發生衝突。

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

   更改下列內容：

   • PROJECT_ID：您的專案 ID
   • ZONE：VM 所在的可用區
   • VM_NAME：VM 名稱

   輸出結果會與下列內容相似：

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

2. 向 instances().setMetadata 方法提出要求。請提供新中繼資料值與目前 fingerprint 值的清單。

   如果您想要保留 VM 的現有鍵值組合，您必須將其包含在對新鍵值組合提出的這個要求中。

   示例

   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 所在的可用區
   • VM_NAME：VM 名稱

主控台

1. 前往 Google Cloud 控制台的「Metadata」頁面。

   前往「Metadata」(中繼資料) 頁面

2. 按一下頁面頂端的 edit「編輯」。

3. 前往要移除的結構描述資料項目，然後按一下該項目旁的 delete 刪除按鈕。

   針對要移除的每個中繼資料項目重複執行這項步驟。

4. 如要完成移除自訂專案中繼資料項目，請按一下「儲存」。

gcloud

如要移除自訂專案中繼資料，請使用 gcloud compute project-info remove-metadata 指令。

• 如果您要移除特定鍵的自訂中繼資料項目，請使用 --keys 標記指定這些鍵，並排除這些鍵的值。

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

• 如要移除 VM 的所有自訂中繼資料，請指定 --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...：您要移除的自訂可用區中繼資料鍵。

執行指令後，如果任何指定鍵都有可用的專案中繼資料值，則指定區域中的 VM 會繼承這些專案中繼資料值。如果中繼資料項目只在可用區層級設定，且該鍵沒有對應的專案中繼資料值，則該可用區中的 VM 會遺失該中繼資料資訊。

範例：

請考慮以下範例專案 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 區域中的 VM 就會擁有下列自訂專案中繼資料項目：

• "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：目前的 fingerprint 值。

提出要求後，如果任何指定鍵都有可用的專案中繼資料值，則指定區域中的 VM 會繼承這些專案中繼資料值。如果中繼資料鍵只在可用區層級設定，且該鍵沒有對應的專案中繼資料值，則該可用區中的 VM 會失去該中繼資料資訊。

範例：

請考慮以下範例專案 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 區中的 VM 就會擁有下列自訂中繼資料。VM 會繼承 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 控制台的「VM instances」(VM 執行個體) 頁面。

   前往「VM instances」(VM 執行個體) 頁面

2. 在「Name」欄中，按一下要移除中繼資料的 VM 名稱。
3. 按一下頁面頂端的 edit 「編輯」。
4. 在「Metadata」部分，針對要移除的每個中繼資料項目，按一下 delete「Delete item」。
5. 如要確認變更並移除自訂執行個體的結構描述，請按一下「儲存」。

gcloud

如要移除自訂執行個體中繼資料，請使用 gcloud compute instances remove-metadata 指令。

• 如果您要移除特定鍵的自訂中繼資料項目，請使用 --keys 標記指定這些鍵，並排除這些鍵的值。

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

• 如要移除 VM 的所有自訂中繼資料，請指定 --all 標記。

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

更改下列內容：

• PROJECT_ID：您的專案 ID。
• ZONE：VM 的可用區。
• VM_NAME：VM 名稱
• KEY1、KEY2...：您要移除的自訂例項中繼資料鍵。

REST

1. 取得目前指紋，並查看 VM 的任何現有鍵值組合。如要這麼做，請呼叫 instances().get 方法。

   指紋是由 Compute Engine 產生的隨機字元字串，可用來執行樂觀鎖定。如要更新 VM，您必須提供相符的指紋值。指紋會在每次要求後變更；如果您提供的指紋不符，系統便會拒絕您的要求。如此一來，一次就只能進行一項更新，而能夠防止發生衝突。

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

   更改下列內容：

   • PROJECT_ID：您的專案 ID。
   • ZONE：VM 的可用區。
   • VM_NAME：VM 名稱

   輸出結果會與下列內容相似：

   {
     ...
     "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 方法提出要求。您必須包含目前的中繼資料指紋值，要求才能成功。

   • 如要從 VM 中移除所有自訂中繼資料鍵值組合，請在 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"
       }
       ...
     ]
     }
     

   • 如要移除 VM 上的所有自訂執行個體中繼資料，請完全排除 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 的可用區。
   • VM_NAME：VM 名稱
   • FINGER_PRINT：目前的 fingerprint 值。
   • KEY1、KEY2...：您要移除的自訂例項中繼資料鍵。
   • VALUE1, VALUE2...：要移除的自訂例項中繼資料鍵的值。