- 資源:Instance
- GcsBackupSource
- ManagedBackupSource
- 狀態
- StateInfo
- UpdateInfo
- AuthorizationMode
- TransitEncryptionMode
- DiscoveryEndpoint
- PersistenceConfig
- PersistenceMode
- RDBConfig
- SnapshotPeriod
- AOFConfig
- AppendFsync
- NodeConfig
- ZoneDistributionConfig
- ZoneDistributionMode
- PscAutoConnection
- PscConnectionStatus
- ConnectionType
- PscAttachmentDetail
- InstanceEndpoint
- ConnectionDetail
- PscConnection
- 眾數
- MaintenancePolicy
- WeeklyMaintenanceWindow
- MaintenanceSchedule
- CrossInstanceReplicationConfig
- InstanceRole
- RemoteInstance
- 會員資格
- AutomatedBackupConfig
- FixedFrequencySchedule
- AutomatedBackupMode
- 方法
資源:執行個體
Memorystore 執行個體。
JSON 表示法 |
---|
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "state": enum ( |
欄位 | |
---|---|
name |
ID。執行個體的專屬名稱。格式:projects/{project}/locations/{location}/instances/{instance} |
createTime |
僅供輸出。執行個體的建立時間戳記。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
updateTime |
僅供輸出。執行個體的最新更新時間戳記。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
labels |
(選用步驟) 代表使用者提供中繼資料的標籤。 包含 |
state |
僅供輸出。執行個體的目前狀態。 |
stateInfo |
僅供輸出。執行個體狀態的其他資訊。 |
uid |
僅供輸出。系統指派的執行個體專屬 ID。 |
authorizationMode |
(選用步驟) 不可變更。執行個體的授權模式。 |
transitEncryptionMode |
(選用步驟) 不可變更。執行個體的傳輸加密模式。 |
shardCount |
(選用步驟) 執行個體的 shard 數量。 |
discoveryEndpoints[] |
僅供輸出。已淘汰:請改用 endpoints.connections.psc_auto_connection 或 endpoints.connections.psc_connection 值。 |
nodeType |
(選用步驟) 執行個體中個別節點的機器類型。 |
persistenceConfig |
(選用步驟) 執行個體的持續性設定。 |
engineVersion |
(選用步驟) 執行個體的引擎版本。 |
engineConfigs |
(選用步驟) 執行個體的使用者提供引擎設定。 包含 |
nodeConfig |
僅供輸出。執行個體個別節點的設定。 |
zoneDistributionConfig |
(選用步驟) 不可變更。執行個體的可用區分配設定,用於節點分配。 |
pscAutoConnections[] |
(選用步驟) 不可變更。已淘汰:請改用 endpoints.connections.psc_auto_connection 值。 |
pscAttachmentDetails[] |
僅供輸出。設定 PSC 連線的服務連結詳細資料。 |
endpoints[] |
(選用步驟) 執行個體的端點。 |
mode |
(選用步驟) 執行個體的模式設定。 |
maintenancePolicy |
(選用步驟) 執行個體的維護政策。如未提供,系統會根據 Memorystore 內部發布時間表執行維護事件。 |
maintenanceSchedule |
僅供輸出。發布的維護排程。 |
crossInstanceReplicationConfig |
(選用步驟) 跨執行個體複製作業的設定。 |
encryptionInfo |
僅供輸出。叢集靜態資料的加密資訊。 |
automatedBackupConfig |
(選用步驟) 執行個體的自動備份設定。 |
allowFewerZonesDeployment |
(選用步驟) 不可變更。讓客戶指定是否要在少於 3 個區域中部署多區域執行個體。設定完成後,如果執行個體建立期間發生可用區中斷情形,執行個體只會部署在 2 個可用區,且在生命週期內都會留在這 2 個可用區。 |
聯集欄位 import_sources 。要匯入的來源。import_sources 只能是下列其中一項: |
|
gcsSource |
(選用步驟) 不可變更。儲存在 Cloud Storage bucket 中的備份。Cloud Storage 值區必須與執行個體位於相同區域。如要從提供的 Cloud Storage 物件匯入資料,您必須具備讀取權限。 |
managedBackupSource |
(選用步驟) 不可變更。由 Memorystore 服務產生及管理的備份。 |
replicaCount |
(選用步驟) 每個分片的備用節點數量。如未填寫此欄位,預設值為 0 個副本。 |
deletionProtectionEnabled |
(選用步驟) 如果設為 True,系統將無法刪除執行個體。 |
simulateMaintenanceEvent |
(選用步驟) 僅限輸入。模擬維護事件。 |
ondemandMaintenance |
(選用步驟) 僅限輸入。執行個體隨選維護。 |
asyncInstanceEndpointsDeletionEnabled |
(選用步驟) 如為 true,客戶建立及註冊的執行個體端點可以非同步刪除。也就是說,這類執行個體端點可以在刪除執行個體端點中的轉送規則之前取消註冊。 |
kmsKey |
(選用步驟) 用於加密叢集靜態資料的 KMS 金鑰。 |
backupCollection |
僅供輸出。備份集合的完整資源名稱。範例:projects/{project}/locations/{location}/backupCollections/{collection} |
GcsBackupSource
儲存在 Cloud Storage bucket 中的備份。Cloud Storage 值區必須與執行個體位於相同區域。
JSON 表示法 |
---|
{ "uris": [ string ] } |
欄位 | |
---|---|
uris[] |
(選用步驟) 例如:gs://bucket1/object1、gs://bucket2/folder2/object2 |
ManagedBackupSource
由 Memorystore 產生及管理的備份。
JSON 表示法 |
---|
{ "backup": string } |
欄位 | |
---|---|
backup |
(選用步驟) 範例://memorystore.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} 系統也支援備份名稱的較短版本 (不含前置字元),例如 projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backupId} 在這種情況下,系統會假設備份位於 memorystore.googleapis.com 下。 |
狀態
執行個體可能有的狀態。
列舉 | |
---|---|
STATE_UNSPECIFIED |
未設定。 |
CREATING |
正在建立執行個體。 |
ACTIVE |
執行個體已建立完成,可供使用。 |
UPDATING |
正在更新執行個體。 |
DELETING |
正在刪除執行個體。 |
StateInfo
執行個體狀態的其他資訊。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位
|
|
updateInfo |
僅供輸出。當執行個體狀態為 UPDATING 時,說明正在進行的更新。 |
UpdateInfo
代表狀態為 UPDATING 的執行個體相關資訊。
JSON 表示法 |
---|
{
"targetShardCount": integer,
"targetReplicaCount": integer,
"targetEngineVersion": string,
"targetNodeType": enum ( |
欄位 | |
---|---|
targetShardCount |
僅供輸出。執行個體的目標 shard 數量。 |
targetReplicaCount |
僅供輸出。執行個體中每個分片的目標副本節點數量。 |
targetEngineVersion |
僅供輸出。執行個體的目標引擎版本。 |
targetNodeType |
僅供輸出。執行個體的目標節點類型。 |
AuthorizationMode
執行個體可能的授權模式。
列舉 | |
---|---|
AUTHORIZATION_MODE_UNSPECIFIED |
未設定。 |
AUTH_DISABLED |
授權已停用。 |
IAM_AUTH |
IAM 基本授權。 |
TransitEncryptionMode
執行個體可能採用的傳輸中加密模式。
列舉 | |
---|---|
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED |
未設定。 |
TRANSIT_ENCRYPTION_DISABLED |
傳輸加密功能已停用。 |
SERVER_AUTHENTICATION |
伺服器管理的加密機制用於傳輸加密。 |
DiscoveryEndpoint
代表用戶端連線至執行個體的端點。
JSON 表示法 |
---|
{ "address": string, "port": integer, "network": string } |
欄位 | |
---|---|
address |
僅供輸出。公開端點的 IP 位址,用戶端會連線至這個位址。 |
port |
僅供輸出。公開端點的通訊埠編號。 |
network |
僅供輸出。保留探索端點 IP 位址的網路,格式為 projects/{networkProject}/global/networks/{network_id}。 |
PersistenceConfig
代表執行個體的持續性設定。
JSON 表示法 |
---|
{ "mode": enum ( |
欄位 | |
---|---|
mode |
(選用步驟) 目前的常駐模式。 |
rdbConfig |
(選用步驟) RDB 設定。如果模式不是 RDB,系統會忽略這個欄位。 |
aofConfig |
(選用步驟) AOF 設定。如果模式不是 AOF,系統會忽略這個欄位。 |
PersistenceMode
可能的常駐模式。
列舉 | |
---|---|
PERSISTENCE_MODE_UNSPECIFIED |
未設定。 |
DISABLED |
持續性已停用,且所有快照資料都已刪除。 |
RDB |
已啟用以 RDB 為基礎的持續性。 |
AOF |
已啟用以 AOF 為基礎的持續性。 |
RDBConfig
以 RDB 為基礎的持續性設定。
JSON 表示法 |
---|
{
"rdbSnapshotPeriod": enum ( |
欄位 | |
---|---|
rdbSnapshotPeriod |
(選用步驟) RDB 快照之間的間隔時間。 |
rdbSnapshotStartTime |
(選用步驟) 系統嘗試建立第一個快照的時間,以及後續快照的對齊時間。如未提供,系統會使用目前時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
SnapshotPeriod
可能的快照週期。
列舉 | |
---|---|
SNAPSHOT_PERIOD_UNSPECIFIED |
未設定。 |
ONE_HOUR |
一小時。 |
SIX_HOURS |
六小時。 |
TWELVE_HOURS |
12 小時。 |
TWENTY_FOUR_HOURS |
24 小時。 |
AOFConfig
根據 AOF 的持續性設定。
JSON 表示法 |
---|
{
"appendFsync": enum ( |
欄位 | |
---|---|
appendFsync |
(選用步驟) fsync 模式。 |
AppendFsync
可能的 fsync 模式。
列舉 | |
---|---|
APPEND_FSYNC_UNSPECIFIED |
未設定。預設值:EVERY_SEC |
NEVER |
永不執行 fsync。通常 Linux 會使用這項設定每 30 秒清除一次資料,但實際情況取決於核心的確切調整。 |
EVERY_SEC |
每秒執行一次 Fsync。如果發生災難,您可能會遺失 1 秒的資料。 |
ALWAYS |
每次將新的寫入指令附加至 AOF 時,都會執行 Fsync。以效能為代價,提供最佳資料遺失防護。 |
NodeConfig
代表執行個體節點的設定。
JSON 表示法 |
---|
{ "sizeGb": number } |
欄位 | |
---|---|
sizeGb |
僅供輸出。節點的記憶體大小 (GB)。 |
ZoneDistributionConfig
執行個體資源分配的可用區分配設定。
JSON 表示法 |
---|
{
"zone": string,
"mode": enum ( |
欄位 | |
---|---|
zone |
(選用步驟) 定義以 SINGLE_ZONE 模式分配所有資源的區域。在 MULTI_ZONE 模式下會遭到忽略。 |
mode |
(選用步驟) 目前的區域分配模式。預設為 MULTI_ZONE。 |
ZoneDistributionMode
可能的區域分配模式。
列舉 | |
---|---|
ZONE_DISTRIBUTION_MODE_UNSPECIFIED |
未設定。預設值:MULTI_ZONE |
MULTI_ZONE |
在區域內隨機選取的 3 個可用區中分配資源。 |
SINGLE_ZONE |
在單一可用區中佈建資源。必須指定區域欄位。 |
PscAutoConnection
PSC 連線中取用者資源的詳細資料。
JSON 表示法 |
---|
{ "pscConnectionId": string, "ipAddress": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
欄位 | |
---|---|
pscConnectionId |
僅供輸出。與服務連結建立連線的轉送規則 PSC 連線 ID。 |
ipAddress |
僅供輸出。在消費者網路中為 PSC 轉送規則分配的 IP。 |
forwardingRule |
僅供輸出。消費者端轉送規則的 URI。格式:projects/{project}/regions/{region}/forwardingRules/{forwardingRule} |
projectId |
這是必要旗標,建立 PSC 連線的消費者專案 ID。這應與建立執行個體的 projectId 相同。 |
network |
這是必要旗標,建立 PSC 端點的網路,格式為 projects/{projectId}/global/networks/{network_id}。 |
serviceAttachment |
僅供輸出。PSC 連線的目標服務連結,格式為 projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}。 |
pscConnectionStatus |
僅供輸出。PSC 連線狀態:連線是否存在且為「有效」,或已不存在。請注意,這個值會定期更新。如要查看最新狀態,請使用 Private Service Connect API。 |
connectionType |
僅供輸出。Private Service Connect 連線類型。 |
聯集欄位 ports 。公開端點的連接埠。ports 只能是下列其中一項: |
|
port |
選用。連接埠只會為主要/讀取器或探索端點設定。 |
PscConnectionStatus
PSC 連線狀態。
列舉 | |
---|---|
PSC_CONNECTION_STATUS_UNSPECIFIED |
未指定 PSC 連線狀態。 |
ACTIVE |
連線已啟用 |
NOT_FOUND |
找不到連線 |
ConnectionType
Private Service Connect 連線類型
列舉 | |
---|---|
CONNECTION_TYPE_UNSPECIFIED |
未設定連線類型 |
CONNECTION_TYPE_DISCOVERY |
用於拓撲探索的連線。 |
CONNECTION_TYPE_PRIMARY |
用來存取主要端點的主要端點連線。 |
CONNECTION_TYPE_READER |
將做為讀取器端點的連線,用於存取副本。 |
PscAttachmentDetail
叢集的服務連結設定,用於建立 PSC 連線。
JSON 表示法 |
---|
{
"serviceAttachment": string,
"connectionType": enum ( |
欄位 | |
---|---|
serviceAttachment |
僅供輸出。您自行建立的 PscConnection 應做為目標的服務連結 URI。 |
connectionType |
僅供輸出。PSC 端點類型。 |
InstanceEndpoint
InstanceEndpoint 包含在每個虛擬私有雲網路中以群組形式建立的 PSC 連線,用於存取執行個體。在每個群組中,叢集內的每個服務附件都應有一個連線。
JSON 表示法 |
---|
{
"connections": [
{
object ( |
欄位 | |
---|---|
connections[] |
(選用步驟) 一組 PSC 連線。這些介面會在同一個 VPC 網路中建立,叢集中的每個服務附件各有一個介面。 |
ConnectionDetail
每個 PSC 連線的資訊。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 connection 。建立執行個體的 PSC 連線時,可以透過叢集建立期間的服務連線自動化 (自動連線) 建立,也可以由客戶自行建立 (使用者建立的連線)。connection 只能是下列其中一項: |
|
pscAutoConnection |
不可變更。透過服務連線自動化建立的 PSC 連線詳細資訊。 |
pscConnection |
使用者建立的 PSC 連線詳細資訊。 |
PscConnection
使用者建立的 PSC 連線設定。
JSON 表示法 |
---|
{ "pscConnectionId": string, "ipAddress": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
欄位 | |
---|---|
pscConnectionId |
這是必要旗標,與服務連結建立連線的轉送規則 PSC 連線 ID。 |
ipAddress |
這是必要旗標,在消費者網路中為 PSC 轉送規則分配的 IP。 |
forwardingRule |
這是必要旗標,消費者端轉送規則的 URI。格式:projects/{project}/regions/{region}/forwardingRules/{forwardingRule} |
projectId |
僅供輸出。建立轉送規則的消費者專案 ID。 |
network |
這是必要旗標,IP 位址所在的消費者網路,格式為 projects/{projectId}/global/networks/{network_id}。 |
serviceAttachment |
這是必要旗標,PSC 連線的目標服務連結,格式為 projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}。 |
pscConnectionStatus |
僅供輸出。PSC 連線狀態:連線是否存在且為「有效」,或已不存在。請注意,這個值會定期更新。如要查看最新狀態,請使用 Private Service Connect API。 |
connectionType |
僅供輸出。Private Service Connect 連線類型。 |
聯集欄位 ports 。公開端點的連接埠。ports 只能是下列其中一項: |
|
port |
選用。連接埠只會為主要/讀取器或探索端點設定。 |
模式
模式設定,用於啟用/停用叢集模式。
列舉 | |
---|---|
MODE_UNSPECIFIED |
未指定模式。 |
STANDALONE |
已淘汰:請改用 CLUSTER_DISABLED。 |
CLUSTER |
執行個體處於叢集模式。 |
CLUSTER_DISABLED |
執行個體已停用叢集模式。 |
MaintenancePolicy
每個執行個體的維護政策。
JSON 表示法 |
---|
{
"createTime": string,
"updateTime": string,
"weeklyMaintenanceWindow": [
{
object ( |
欄位 | |
---|---|
createTime |
僅供輸出。政策的建立時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
updateTime |
僅供輸出。政策更新時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
weeklyMaintenanceWindow[] |
(選用步驟) 套用至這項政策涵蓋資源的維護期間。至少 1 個。就目前版本而言,weekly_window 的數量上限應為一。 |
WeeklyMaintenanceWindow
每週作業指定的時間範圍。
JSON 表示法 |
---|
{ "day": enum ( |
欄位 | |
---|---|
day |
(選用步驟) 可定義在每週特定日子執行的排程。 |
startTime |
(選用步驟) 時區為世界標準時間的時段開始時間。 |
MaintenanceSchedule
近期維護排程。
JSON 表示法 |
---|
{ "startTime": string, "endTime": string } |
欄位 | |
---|---|
startTime |
僅供輸出。這個執行個體即將進行的排定維護作業開始時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
endTime |
僅供輸出。這個執行個體即將進行的排定維護作業結束時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
CrossInstanceReplicationConfig
跨執行個體複製設定。
JSON 表示法 |
---|
{ "instanceRole": enum ( |
欄位 | |
---|---|
instanceRole |
這是必要旗標,執行個體在跨執行個體複製作業中的角色。 |
primaryInstance |
(選用步驟) 做為這個次要執行個體複製來源的主要執行個體詳細資料。 這個欄位只會針對次要執行個體設定。 |
secondaryInstances[] |
(選用步驟) 從這個主要執行個體複製的次要執行個體清單。 這個欄位只會針對主要執行個體設定。 |
updateTime |
僅供輸出。上次更新跨執行個體複製設定的時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
membership |
僅供輸出。所有參與跨執行個體複寫的成員執行個體,都只能輸出檢視。無論成員執行個體角色(主要或次要) 為何,都會提供這個檢視畫面。 主要執行個體可以提供從中複製的所有次要執行個體相關資訊。不過,次要執行個體只會知道要從哪個主要執行個體複製資料。不過,如果主要執行個體無法使用(例如區域中斷),則可將 Getinstance 要求傳送至任何其他成員執行個體,而這個欄位會列出參與跨執行個體複寫的所有成員執行個體。 |
InstanceRole
執行個體在跨執行個體複製作業中的角色。
列舉 | |
---|---|
INSTANCE_ROLE_UNSPECIFIED |
未設定執行個體角色。行為等同於 NONE。 |
NONE |
這個執行個體不會參與跨執行個體複製作業。這是獨立的執行個體,不會與任何其他執行個體進行複製。 |
PRIMARY |
可讀取及寫入的執行個體。寫入這個執行個體的任何資料也會複製到連結的次要執行個體。 |
SECONDARY |
只能讀取資料,並從主要執行個體複製資料的執行個體。 |
RemoteInstance
與這個執行個體相關聯的遠端執行個體詳細資料,適用於跨執行個體複製設定。
JSON 表示法 |
---|
{ "instance": string, "uid": string } |
欄位 | |
---|---|
instance |
(選用步驟) 遠端執行個體的完整資源路徑,格式為:projects/ |
uid |
僅供輸出。遠端執行個體的專屬 ID。 |
成員資格
參與跨執行個體複寫的所有成員執行個體,僅供輸出檢視。
JSON 表示法 |
---|
{ "primaryInstance": { object ( |
欄位 | |
---|---|
primaryInstance |
僅供輸出。做為次要執行個體複製來源的主要執行個體。 |
secondaryInstances[] |
僅供輸出。從主要執行個體複製的次要執行個體清單。 |
AutomatedBackupConfig
執行個體的自動備份設定。
JSON 表示法 |
---|
{ "automatedBackupMode": enum ( |
欄位 | |
---|---|
automatedBackupMode |
(選用步驟) 自動備份模式。如果停用模式,系統會忽略其他欄位。 |
retention |
(選用步驟) 自動備份的保留時間,時間一到就會刪除備份。值應介於 1 天至 365 天之間。如未指定,預設值為 35 天。 時間長度以秒為單位,最多可有 9 個小數位數,並應以「 |
聯集欄位 schedule 。自動備份的排程。schedule 只能是下列其中一項: |
|
fixedFrequencySchedule |
(選用步驟) 以固定頻率觸發自動備份。 |
FixedFrequencySchedule
這個排程會以固定頻率觸發備份作業 (目前僅支援每日備份)。
JSON 表示法 |
---|
{
"startTime": {
object ( |
欄位 | |
---|---|
startTime |
這是必要旗標,每次自動備份的開始時間 (世界標準時間)。必須設為整點。這是必填欄位。 |
AutomatedBackupMode
自動備份模式。
列舉 | |
---|---|
AUTOMATED_BACKUP_MODE_UNSPECIFIED |
預設值。未指定自動備份設定。 |
DISABLED |
已停用自動備份設定。 |
ENABLED |
已啟用自動備份設定。 |
方法 |
|
---|---|
|
備份執行個體。 |
|
在指定專案和位置建立新執行個體。 |
|
刪除單一執行個體。 |
|
取得單一執行個體的詳細資料。 |
|
取得執行個體的憑證授權單位詳細資料。 |
|
列出指定專案和位置中的執行個體。 |
|
更新單一執行個體的參數。 |
|
重新排定日後的維護事件。 |