預先定義的中繼資料鍵

每個中繼資料項目都會以鍵/值組合的形式儲存在中繼資料伺服器上。中繼資料鍵須區分大小寫。鍵可以是預先定義或自訂的中繼資料鍵。

預先定義的中繼資料鍵是由 Compute Engine 建立的中繼資料鍵。建立 VM 時,Compute Engine 會自動為該 VM 上的部分鍵設定中繼資料值,例如 VM 執行個體 ID 或專案 ID。如果是 Compute Engine 不會自動設定值的預先定義鍵,您可以從一組值中選擇,這些值會視系統設定而定。 您只能更新這些鍵的值,無法更新鍵本身。

本文說明 Compute Engine 在 instance/project/ 中繼資料目錄中提供的預先定義中繼資料金鑰。

如要瞭解如何定義、分類及排列 Compute Engine 的 VM 中繼資料,請參閱「關於 VM 中繼資料」。

預先定義的專案中繼資料鍵

專案中繼資料的預先定義中繼資料鍵會儲存在下列目錄中:

  • http://metadata.google.internal/computeMetadata/v1/project/

下表列出 Compute Engine 在 project/ 中繼資料目錄中自動建立的中繼資料鍵和目錄:

中繼資料項目 說明
attributes/

在啟動或關閉期間傳送至專案中 VM 的自訂中繼資料值目錄。這些自訂值可以是 Trusted Cloud by S3NS 屬性,也可以是使用者建立的中繼資料值。

如需可設定的專案層級 Trusted Cloud by S3NS 屬性清單,請參閱「專案屬性」。

如要進一步瞭解如何設定自訂中繼資料,請參閱「設定自訂中繼資料」一節。

numeric-project-id 執行個體的數值專案 ID (專案編號)Trusted Cloud console中顯示的專案名稱不同。這個值與 project-id 中繼資料項目值不同。
project-id 專案 ID

預先定義的專案屬性中繼資料鍵

專案屬性的預先定義中繼資料鍵會儲存在下列目錄中:

  • http://metadata.google.internal/computeMetadata/v1/project/attributes/

下表列出中繼資料鍵。如果為專案設定這些鍵,Compute Engine 會在 project/attributes/ 中繼資料目錄中建立這些鍵,並附上相關影響:

中繼資料項目 說明
disable-legacy-endpoints

針對專案中的所有 VM 停用舊版中繼資料伺服器端點。

舊版端點已淘汰,請一律設定 disable-legacy-endpoints=TRUE

enable-guest-attributes

設定專案的訪客屬性。

訪客屬性是自訂 VM 執行個體中繼資料值,可用於發布不常見狀態通知、少量資料或低頻率資料。這些值很適合用於指出開機指令碼的完成時間,或用於向其他應用程式提供其他不常見狀態通知。

如要進一步瞭解訪客屬性,請參閱「設定及查詢訪客屬性」。

enable-os-inventory

啟用或停用專案的 OS 清查功能。

收集及儲存作業系統資訊。包括主機名稱、核心版本、架構和已安裝的套件等資訊。

如要進一步瞭解作業系統資產,請參閱「查看作業系統詳細資料」。

enable-windows-ssh

啟用或停用 Windows VM 的 SSH。

詳情請參閱使用 SSH 連線至 Windows VM

google-compute-default-data-protection

如果已設定,則會儲存用於備份專案中建立的新執行個體的預設選項。

詳情請參閱「設定控制台的預設備份設定」。

google-compute-default-region 如果已設定,則會儲存專案使用的預設區域。

如要進一步瞭解如何設定預設地區,請參閱預設地區和區域

google-compute-default-zone 如果已設定,則會儲存專案使用的預設區域。

如要進一步瞭解如何設定預設區域,請參閱預設地區和區域

ssh-keys

如果您是使用中繼資料管理安全殼層 (SSH) 金鑰組,這個屬性能讓您設定可連線至此專案中 VM 的公開安全殼層 (SSH) 金鑰組。如有多個 SSH 金鑰,每個金鑰都將由換行字元 (\n) 分隔開來。ssh-keys 屬性的值是字串。

範例:"user1:ssh-rsa mypublickey user1@host.com\nuser2:ssh-rsa mypublickey user2@host.com"

sshKeys 已淘汰:請改用 ssh-keys
vmdnssetting

為專案中的 VM 啟用區域 DNS 和全域 DNS。

如要進一步瞭解如何為 VM 使用區域 DNS 名稱,請參閱「為內部 DNS 類型使用區域 DNS」。

預先定義的執行個體中繼資料鍵

執行個體中繼資料的預先定義中繼資料鍵會儲存在下列目錄中:

  • http://metadata.google.internal/computeMetadata/v1/instance/

下表列出 Compute Engine 在 instance/ 中繼資料目錄中自動建立的中繼資料鍵和目錄:

中繼資料項目 說明
attributes/

在啟動或關閉期間傳送至 VM 之自訂中繼資料值的目錄。這些自訂值可以是屬性,也可以是使用者建立的中繼資料值。 Trusted Cloud by S3NS

如需可設定的執行個體層級 Trusted Cloud by S3NS 屬性清單,請參閱「執行個體屬性」。

如要進一步瞭解如何設定自訂中繼資料,請參閱「設定自訂中繼資料」一節。

cpu-platform

虛擬機器的 CPU 平台。

如要瞭解 CPU 平台,請參閱「CPU 平台」。

description 執行個體的任意文字說明,使用 Google Cloud CLI 或 API 的 --description 標記指派。
disks/

附加至 VM 的磁碟目錄。每個磁碟都會提供以下資訊:

  • device-name
  • index
  • interface
  • mode
  • type

如要進一步瞭解磁碟,請參閱「儲存空間選項」。

gce-workload-certificates/(預覽)

儲存 VM 中執行的應用程式所用受管理工作負載身分識別功能的下列端點。

  • config-status:包含透過 VM 中繼資料提供的設定值中的任何錯誤。
  • workload-identities:包含由 Compute Engine 控制層管理的 ID。這個端點包含虛擬機信任網域的 X.509 憑證和私密金鑰。
  • trust-anchors:包含一組用於對等 X.509 憑證鏈結驗證的信任憑證。

詳情請參閱「透過 mTLS 向其他工作負載驗證工作負載」。

guest-attributes/

為 VM 設定訪客屬性。這些自訂值可以是屬性,也可以是使用者建立的中繼資料值。 Trusted Cloud by S3NS

如需可設定的執行個體層級 Trusted Cloud by S3NS 屬性清單,請參閱「執行個體訪客屬性

如要進一步瞭解訪客屬性,請參閱「設定及查詢訪客屬性」。

hostname VM 的主機名稱。
id 虛擬機的 ID。這是由 Compute Engine 為專案和 VM 區域產生的唯一數值 ID。您可以使用這個 ID 識別 VM,特別是當您未為 VM 指派自訂名稱時。
image VM 使用的作業系統映像檔。這個值的格式如下:projects/IMAGE_PROJECT/global/images/IMAGE_NAME
legacy-endpoint-access/ 儲存舊版端點清單。值為 0.1v1beta1
licenses/ 用來將授權附加至映像檔、快照和磁碟的授權代碼 ID 清單。
machine-type 這個 VM 的機器類型。這個值的格式如下所示: projects/PROJECT_NUM/machineTypes/MACHINE_TYPE
maintenance-event 指出維護事件是否會影響這個 VM。詳情請參閱即時遷移
name VM 的名稱。
network-interfaces/

網路介面目錄。每個網路介面都會提供下列資訊:

  • access-configs/

    • external-ip
    • type
  • dns-servers
  • forwarded-ips/
  • gateway
  • ip
  • ip-aliases/
  • mac
  • mtu
  • network
  • subnetmask
  • target-instance-ips

如要進一步瞭解網路介面,請參閱多個網路介面總覽

partner-attributes/(預覽)

這個目錄包含命名空間,中繼資料項目會儲存在這些命名空間中。命名空間是由 Trusted Cloud 服務建立,這些服務會使用合作夥伴屬性儲存設定。如果沒有任何服務使用合作夥伴屬性,目錄就會是空白。

舉例來說,受管理的工作負載身分會使用合作夥伴屬性進行設定。

preempted

布林值,指出 VM 是否即將遭到先占。

scheduling/

設定 VM 的排程選項。

排程中繼資料值包括:

  • on-host-maintenance:指出 VM 在主機維護期間是終止還是即時遷移。
  • automatic-restart:如果這個值是 TRUE,VM 會在維護事件或當機後自動重新啟動。
  • preemptible:如果這個值為 TRUE,則 VM 為先占。此值會在您建立 VM 時設定,且無法變更。

如要進一步瞭解排程選項,請參閱設定執行個體可用性政策

service-accounts/

與 VM 相關聯的服務帳戶目錄。每個服務帳戶都會提供下列資訊:

  • aliases
  • email:服務帳戶的電子郵件地址。
  • identity:虛擬機器專屬的 JSON Web Token。您必須針對此 VM 中繼資料值,將 audience 參數包含在要求中。例如:?audience=http://www.example.com

    如要瞭解如何要求及驗證執行個體身分權杖,請參閱「驗證 VM 身分」。

  • scopes:指派給服務帳戶的存取範圍。
  • token:可用於驗證應用程式的OAuth2存取權杖。

    如要瞭解存取憑證,請參閱「 直接透過存取憑證驗證應用程式」。

如要進一步瞭解 Compute Engine 如何使用服務帳戶,請參閱服務帳戶

tags

列出與 VM 相關聯的任何網路標記。

如要進一步瞭解網路標記,請參閱「新增網路標記」。

zone 這個 VM 所在的區域。這個值的格式如下所示: projects/PROJECT_NUM/zones/ZONE

預先定義的執行個體屬性中繼資料鍵

執行個體屬性的預先定義中繼資料鍵會儲存在下列目錄中:

  • http://metadata.google.internal/computeMetadata/v1/instance/attributes/

下表列出中繼資料鍵。如果為執行個體設定這些鍵,Compute Engine 會在 instance/attributes/ 中繼資料目錄中建立這些鍵,並產生相關影響:

中繼資料項目 說明
physical_host

雜湊字串,代表以密集配置政策建立的 VM 位置。

如要進一步瞭解這項屬性,請參閱「驗證 VM 的實際位置」。

enable-windows-ssh (預覽)

啟用或停用 Windows VM 的 SSH。

詳情請參閱使用 SSH 連線至 Windows VM

enable-workload-certificate (預覽)

在 VM 上啟用或停用代管工作負載身分。

詳情請參閱「為個別 VM 啟用代管工作負載身分」。

vmdnssetting

為 VM 啟用區域 DNS 和全域 DNS。

如要進一步瞭解如何為 VM DNS 使用區域 DNS 名稱,請參閱「為內部 DNS 類型使用區域 DNS」。

ssh-keys

如果您是使用中繼資料管理安全殼層 (SSH) 金鑰組,這個屬性能讓您設定可連線至此專案中 VM 的公開安全殼層 (SSH) 金鑰組。如有多個安全殼層 (SSH) 金鑰組,每個金鑰都將由換行字元 (\n) 分隔開來。 ssh-keys 屬性的值是字串。

範例:"user1:ssh-rsa mypublickey user1@host.com\nuser2:ssh-rsa mypublickey user2@host.com"

block-project-ssh-keys

禁止使用中繼資料型安全殼層金鑰的 VM 使用專案安全殼層金鑰。

詳情請參閱「 限制 VM 的 SSH 金鑰」。

disable-https-mds-setup

停用 Compute Engine 的自動 HTTPS 中繼資料伺服器憑證佈建功能。

詳情請參閱「 啟用自動憑證設定」。

enable-https-mds-native-cert-store

啟用這項功能後,Compute Engine 就能在自動佈建 HTTPS 中繼資料伺服器憑證時,將根憑證新增至 OS 信任存放區。

詳情請參閱「 在 OS 信任儲存空間中啟用根憑證儲存空間」。

預先定義的訪客屬性中繼資料鍵

執行個體訪客屬性的預先定義中繼資料鍵會儲存在下列目錄中:

  • http://metadata.google.internal/computeMetadata/v1/instance/guest-attributes/

下表列出 Compute Engine 在 instance/guest-attributes/ 中繼資料目錄中自動建立的中繼資料鍵和目錄:

中繼資料項目 說明
guestInventory/

儲存 VM 的 OS 資產。

收集及儲存 OS 詳細資料。包括主機名稱、核心版本、架構和已安裝套件的詳細資料等資訊。

如要進一步瞭解作業系統資產,請參閱「查看作業系統詳細資料」。

hostkeys/

儲存 SSH 主機金鑰。主機金鑰可用於識別特定主機或機器。

如要瞭解主機金鑰,請參閱「啟用訪客屬性來儲存主機金鑰」。

後續步驟