- 資源:叢集
- GcsBackupSource
- ManagedBackupSource
- 狀態
- AuthorizationMode
- TransitEncryptionMode
- PscConfig
- DiscoveryEndpoint
- PscConnection
- PscConnectionStatus
- ConnectionType
- StateInfo
- UpdateInfo
- ClusterPersistenceConfig
- PersistenceMode
- RDBConfig
- SnapshotPeriod
- AOFConfig
- AppendFsync
- ZoneDistributionConfig
- ZoneDistributionMode
- CrossClusterReplicationConfig
- ClusterRole
- RemoteCluster
- 會員資格
- ClusterMaintenancePolicy
- ClusterWeeklyMaintenanceWindow
- ClusterMaintenanceSchedule
- PscServiceAttachment
- ClusterEndpoint
- ConnectionDetail
- PscAutoConnection
- AutomatedBackupConfig
- FixedFrequencySchedule
- AutomatedBackupMode
- 方法
資源:叢集
叢集執行個體。
JSON 表示法 |
---|
{ "name": string, "createTime": string, "state": enum ( |
欄位 | |
---|---|
name |
這是必要旗標,ID。此範圍中資源的唯一名稱,包括專案和位置,格式為: |
createTime |
僅供輸出。與叢集建立要求相關聯的時間戳記。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
state |
僅供輸出。這個叢集的目前狀態。可能為 CREATING、READY、UPDATING、DELETING 和 SUSPENDED |
uid |
僅供輸出。系統指派的叢集專屬 ID。 |
authorizationMode |
(選用步驟) Redis 叢集的授權模式。如未提供,系統會停用叢集的驗證功能。 |
transitEncryptionMode |
(選用步驟) Redis 叢集的傳輸中資料加密。如果未提供,叢集會停用加密功能。 |
pscConfigs[] |
(選用步驟) 每個 PscConfig 都會設定消費者網路,系統會將 IP 指派給叢集,供用戶透過 Private Service Connect Automation 存取。目前僅支援一個 PscConfig。 |
discoveryEndpoints[] |
僅供輸出。在每個指定網路上建立端點,供 Redis 用戶端連線至叢集。目前僅支援一個探索端點。 |
pscConnections[] |
僅供輸出。透過服務連線自動化功能自動建立的 PSC 連線清單。 |
stateInfo |
僅供輸出。叢集目前狀態的其他資訊。 |
nodeType |
(選用步驟) 叢集中的 Redis 節點類型。NodeType 會決定 Redis 節點的基礎機器類型。 |
persistenceConfig |
(選用步驟) 叢集的持續性設定 (RDB、AOF)。 |
redisConfigs |
(選用步驟) 可變動 Redis 設定的客戶覆寫鍵/值組合 包含 |
zoneDistributionConfig |
(選用步驟) 這項設定會用於判斷客戶希望我們如何在區域內分配叢集資源。 |
crossClusterReplicationConfig |
(選用步驟) 跨叢集複製設定。 |
pscServiceAttachments[] |
僅供輸出。設定 PSC 連線的服務附件詳細資料 |
clusterEndpoints[] |
(選用步驟) 叢集端點清單。 |
automatedBackupConfig |
(選用步驟) 叢集的自動備份設定。 |
encryptionInfo |
僅供輸出。叢集靜態資料的加密資訊。 |
allowFewerZonesDeployment |
(選用步驟) 不可變更。讓客戶指定是否要在少於 3 個可用區中部署多區域叢集。設定完成後,如果叢集建立期間發生可用區中斷情形,叢集只會在 2 個可用區中部署,且在生命週期內都會維持在 2 個可用區中。 |
聯集欄位 import_sources 。要匯入的來源。import_sources 只能是下列其中一項: |
|
gcsSource |
(選用步驟) 儲存在 Cloud Storage bucket 中的備份。Cloud Storage 值區必須與叢集位於相同區域。如要從提供的 Cloud Storage 物件匯入資料,您必須具備讀取權限。 |
managedBackupSource |
(選用步驟) 由 Memorystore 服務產生及管理備份。 |
replicaCount |
(選用步驟) 每個分片的備用節點數量。 |
sizeGb |
僅供輸出。整個叢集的 Redis 記憶體大小 (以 GB 為單位),向上取整至下一個整數。 |
shardCount |
(選用步驟) Redis 叢集的資料分割數量。 |
preciseSizeGb |
僅供輸出。整個叢集的 Redis 記憶體大小精確值 (以 GB 為單位)。 |
deletionProtectionEnabled |
(選用步驟) 如果值設為 true,刪除作業就會失敗。 |
maintenancePolicy |
(選用步驟) ClusterMaintenancePolicy 會決定允許或拒絕更新的時間。 |
maintenanceSchedule |
僅供輸出。ClusterMaintenanceSchedule (僅供輸出) 已發布的維護時間表。 |
simulateMaintenanceEvent |
(選用步驟) 僅限輸入。模擬維護事件。 |
backupCollection |
(選用步驟) 僅供輸出。備份集合的完整資源名稱。範例:projects/{project}/locations/{location}/backupCollections/{collection} |
kmsKey |
(選用步驟) 用於加密叢集靜態資料的 KMS 金鑰。 |
ondemandMaintenance |
(選用步驟) 僅限輸入。叢集的隨選維護作業。這個欄位可用於觸發叢集的隨選重大更新。 |
asyncClusterEndpointsDeletionEnabled |
(選用步驟) 如為 true,客戶建立及註冊的叢集端點可以非同步刪除。也就是說,這類叢集端點可以在刪除叢集端點中的轉送規則前取消註冊。 |
GcsBackupSource
儲存在 Cloud Storage bucket 中的備份。Cloud Storage bucket 必須與叢集位於相同區域。
JSON 表示法 |
---|
{ "uris": [ string ] } |
欄位 | |
---|---|
uris[] |
(選用步驟) 要匯入的 Cloud Storage 物件 URI。例如:gs://bucket1/object1、gs://bucket2/folder2/object2 |
ManagedBackupSource
由 Memorystore 產生及管理的備份。
JSON 表示法 |
---|
{ "backup": string } |
欄位 | |
---|---|
backup |
(選用步驟) 範例://redis.googleapis.com/projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backup} 系統也支援備份名稱的較短版本 (不含前置字元),例如 projects/{project}/locations/{location}/backupCollections/{collection}/backups/{backupId} 在這種情況下,系統會假設備份位於 redis.googleapis.com 下。 |
狀態
代表 Redis 叢集的不同狀態。
列舉 | |
---|---|
STATE_UNSPECIFIED |
未設定。 |
CREATING |
正在建立 Redis 叢集。 |
ACTIVE |
Redis 叢集已建立完成,可供使用。 |
UPDATING |
正在更新 Redis 叢集設定。 |
DELETING |
正在刪除 Redis 叢集。 |
AuthorizationMode
Redis 叢集的可用授權模式。
列舉 | |
---|---|
AUTH_MODE_UNSPECIFIED |
未設定。 |
AUTH_MODE_IAM_AUTH |
IAM 基本授權模式 |
AUTH_MODE_DISABLED |
已停用授權模式 |
TransitEncryptionMode
可用的傳輸中資料加密模式。
列舉 | |
---|---|
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED |
未設定傳輸中資料加密。 |
TRANSIT_ENCRYPTION_MODE_DISABLED |
傳輸中資料加密功能已停用。 |
TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION |
使用伺服器管理的加密金鑰,加密傳輸中的資料。 |
PscConfig
JSON 表示法 |
---|
{ "network": string } |
欄位 | |
---|---|
network |
這是必要旗標,保留探索端點 IP 位址的網路,格式為 projects/{networkProject}/global/networks/{network_id}。 |
DiscoveryEndpoint
各網路的端點,供 Redis 用戶端連線至叢集。
JSON 表示法 |
---|
{
"address": string,
"port": integer,
"pscConfig": {
object ( |
欄位 | |
---|---|
address |
僅供輸出。用戶端用來連線至服務的公開 Redis 端點位址。位址可以是 IP 或主機名稱。 |
port |
僅供輸出。公開 Redis 端點的通訊埠編號。 |
pscConfig |
僅供輸出。客戶設定,用於指定端點的建立和存取位置。 |
PscConnection
PSC 連線中取用者資源的詳細資料。
JSON 表示法 |
---|
{ "pscConnectionId": string, "address": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
欄位 | |
---|---|
pscConnectionId |
這是必要旗標,與服務連結建立連線的轉送規則 PSC 連線 ID。 |
address |
這是必要旗標,在消費者網路中為 PSC 轉送規則分配的 IP。 |
forwardingRule |
這是必要旗標,消費者端轉送規則的 URI。範例:projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}。 |
projectId |
(選用步驟) 在其中建立轉送規則的消費者專案 ID。 |
network |
這是必要旗標,IP 位址所在的消費者網路,格式為 projects/{projectId}/global/networks/{network_id}。 |
serviceAttachment |
這是必要旗標,PSC 連線的目標服務連結,格式為 projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}。 |
pscConnectionStatus |
僅供輸出。Private Service Connect 連線的狀態。請注意,這個值會定期更新。如要取得 PSC 連線的最新狀態,請按照 https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details 的說明操作。 |
connectionType |
僅供輸出。Private Service Connect 連線類型。 |
聯集欄位 ports 。公開探索端點的通訊埠編號。ports 只能是下列其中一項: |
|
port |
僅供輸出。系統只會為主要/讀取器或探索端點設定連接埠。 |
PscConnectionStatus
PSC 連線狀態。
列舉 | |
---|---|
PSC_CONNECTION_STATUS_UNSPECIFIED |
未指定 PSC 連線狀態。 |
PSC_CONNECTION_STATUS_ACTIVE |
連線已啟用 |
PSC_CONNECTION_STATUS_NOT_FOUND |
找不到連線 |
ConnectionType
PSC 連線類型,用於叢集存取。
列舉 | |
---|---|
CONNECTION_TYPE_UNSPECIFIED |
未設定叢集端點類型 |
CONNECTION_TYPE_DISCOVERY |
用於叢集拓撲探索的叢集端點。 |
CONNECTION_TYPE_PRIMARY |
叢集端點,將做為存取主要端點的主要端點。 |
CONNECTION_TYPE_READER |
叢集端點,將做為讀取器端點來存取副本。 |
StateInfo
代表叢集狀態的額外資訊。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位
|
|
updateInfo |
說明叢集狀態為 UPDATING 時,叢集正在進行的更新。 |
UpdateInfo
代表更新叢集的相關資訊。
JSON 表示法 |
---|
{
"targetShardCount": integer,
"targetReplicaCount": integer,
"targetNodeType": enum ( |
欄位 | |
---|---|
targetShardCount |
Redis 叢集的目標資料分割數量 |
targetReplicaCount |
每個分片的目標備用資源節點數量。 |
targetNodeType |
Redis 叢集的目標節點類型。 |
ClusterPersistenceConfig
設定持續性功能。
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 |
未設定。預設值:EVERYSEC |
NO |
永不執行 fsync。通常 Linux 會使用這項設定每 30 秒清除一次資料,但實際情況取決於核心的確切調整。 |
EVERYSEC |
每秒執行一次 fsync。如果發生災難,您可能會遺失 1 秒的資料 |
ALWAYS |
每次將新的寫入指令附加至 AOF 時,都會執行 fsync。以效能為代價,提供最佳資料遺失防護 |
ZoneDistributionConfig
用於分配叢集資源的可用區分配設定。
JSON 表示法 |
---|
{
"mode": enum ( |
欄位 | |
---|---|
mode |
(選用步驟) 區域分配模式。如未指定,預設為 MULTI_ZONE。 |
zone |
(選用步驟) 選取「單一可用區」分配方式後,系統會使用可用區欄位,在該可用區中分配所有資源。這不適用於 MULTI_ZONE,且會遭到 MULTI_ZONE 叢集忽略。 |
ZoneDistributionMode
定義各種區域分配模式。
列舉 | |
---|---|
ZONE_DISTRIBUTION_MODE_UNSPECIFIED |
未設定。預設值:MULTI_ZONE |
MULTI_ZONE |
將所有資源分散到區域內隨機選取的 3 個可用區。 |
SINGLE_ZONE |
將所有資源分配到單一可用區。選取這個模式時,必須指定區域欄位。 |
CrossClusterReplicationConfig
跨叢集複製設定。
JSON 表示法 |
---|
{ "clusterRole": enum ( |
欄位 | |
---|---|
clusterRole |
僅供輸出。叢集在跨叢集複製中的角色。 |
primaryCluster |
做為這個次要叢集複製來源的主要叢集詳細資料。 這個欄位只會針對次要叢集設定。 |
secondaryClusters[] |
從這個主要叢集複製資料的次要叢集清單。 這個欄位只會針對主要叢集設定。 |
updateTime |
僅供輸出。上次更新跨叢集複寫設定的時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
membership |
僅供輸出。輸出內容僅供檢視,顯示參與跨叢集複寫的所有成員叢集。無論叢集角色(主要或次要) 為何,每個成員叢集都會提供這個檢視畫面。 主要叢集可以提供從中複製資料的所有次要叢集相關資訊。不過,次要叢集只會知道要從哪個主要叢集複製資料。不過,如果主要叢集無法使用(例如區域中斷),則可將 clusters.get 要求傳送至任何其他成員叢集,這個欄位會列出參與跨叢集複寫的所有成員叢集。 |
ClusterRole
叢集在跨叢集複製中的角色。
列舉 | |
---|---|
CLUSTER_ROLE_UNSPECIFIED |
未設定叢集角色。行為等同於 NONE。 |
NONE |
這個叢集未參與跨叢集複製作業。這是獨立叢集,不會與任何其他叢集複製資料。 |
PRIMARY |
允許讀取和寫入的叢集。寫入這個叢集的任何資料也會複製到附加的次要叢集。 |
SECONDARY |
這類叢集只允許讀取資料,並從主要叢集複製資料。 |
RemoteCluster
與叢集間複製設定中這個叢集相關聯的遠端叢集詳細資料。
JSON 表示法 |
---|
{ "cluster": string, "uid": string } |
欄位 | |
---|---|
cluster |
僅供輸出。遠端叢集的完整資源路徑,格式為:projects/ |
uid |
僅供輸出。遠端叢集的專屬 ID。 |
成員資格
僅供輸出,顯示參與跨叢集複寫的所有成員叢集。
JSON 表示法 |
---|
{ "primaryCluster": { object ( |
欄位 | |
---|---|
primaryCluster |
僅供輸出。主要叢集會做為次要叢集的複製來源。 |
secondaryClusters[] |
僅供輸出。從主要叢集複製資料的次要叢集清單。 |
ClusterMaintenancePolicy
每個叢集的維護政策。
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 個。目前版本每週最多可有一個維護時段。 |
ClusterWeeklyMaintenanceWindow
每週作業指定的時間範圍。
JSON 表示法 |
---|
{ "day": enum ( |
欄位 | |
---|---|
day |
(選用步驟) 可定義在每週特定日子執行的排程。 |
startTime |
(選用步驟) 時區為世界標準時間的時段開始時間。 |
ClusterMaintenanceSchedule
近期維護排程。
JSON 表示法 |
---|
{ "startTime": string, "endTime": string } |
欄位 | |
---|---|
startTime |
僅供輸出。這個執行個體即將進行的排定維護作業開始時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
endTime |
僅供輸出。這個執行個體即將進行的排定維護作業結束時間。 使用 RFC 3339,產生的輸出內容一律會經過 Z 標準化,並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如: |
PscServiceAttachment
叢集的服務連結設定,用於建立 PSC 連線。
JSON 表示法 |
---|
{
"serviceAttachment": string,
"connectionType": enum ( |
欄位 | |
---|---|
serviceAttachment |
僅供輸出。您自行建立的 PscConnection 應做為目標的服務連結 URI |
connectionType |
僅供輸出。指定這個服務連結的 PSC 連線類型。 |
ClusterEndpoint
ClusterEndpoint 包含在每個虛擬私有雲網路中建立的 PSC 連線群組,用於存取叢集。在每個群組中,叢集內的每個服務附件都應有一個連線。
JSON 表示法 |
---|
{
"connections": [
{
object ( |
欄位 | |
---|---|
connections[] |
這是必要旗標,一組 PSC 連線。這些介面會在同一個 VPC 網路中建立,叢集中的每個服務附件各有一個介面。 |
ConnectionDetail
每項 PSC 連線的詳細資訊。
JSON 表示法 |
---|
{ // Union field |
欄位 | |
---|---|
聯集欄位 connection 。叢集的 PSC 連線可透過叢集建立期間的服務連線自動化 (自動註冊連線) 建立,也可由客戶自行建立 (使用者註冊連線)。connection 只能是下列其中一項: |
|
pscAutoConnection |
透過服務連線自動化建立的 PSC 連線詳細資訊。 |
pscConnection |
由叢集擁有者建立的 PSC 連線詳細資訊。 |
PscAutoConnection
透過服務連線自動化建立的 PSC 連線中,用戶端資源的詳細資料。
JSON 表示法 |
---|
{ "pscConnectionId": string, "address": string, "forwardingRule": string, "projectId": string, "network": string, "serviceAttachment": string, "pscConnectionStatus": enum ( |
欄位 | |
---|---|
pscConnectionId |
僅供輸出。與服務連結建立連線的轉送規則 PSC 連線 ID。 |
address |
僅供輸出。在消費者網路中為 PSC 轉送規則分配的 IP。 |
forwardingRule |
僅供輸出。消費者端轉送規則的 URI。範例:projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}。 |
projectId |
這是必要旗標,建立轉送規則的消費者專案 ID。 |
network |
這是必要旗標,IP 位址所在的消費者網路,格式為 projects/{projectId}/global/networks/{network_id}。 |
serviceAttachment |
僅供輸出。PSC 連線的目標服務連結,格式為 projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}。 |
pscConnectionStatus |
僅供輸出。Private Service Connect 連線的狀態。請注意,這個值會定期更新。如要查看最新狀態,請使用 Private Service Connect API。 |
connectionType |
僅供輸出。Private Service Connect 連線類型。 |
AutomatedBackupConfig
叢集的自動備份設定。
JSON 表示法 |
---|
{ "automatedBackupMode": enum ( |
欄位 | |
---|---|
automatedBackupMode |
(選用步驟) 自動備份模式。如果停用模式,系統會忽略其他欄位。 |
聯集欄位 schedule 。自動備份的排程。schedule 只能是下列其中一項: |
|
fixedFrequencySchedule |
(選用步驟) 以固定頻率觸發自動備份。 |
retention |
(選用步驟) 自動備份的保留時間,期限過後系統會刪除備份。值應介於 1 天至 365 天之間。如未指定,預設值為 35 天。 時間長度以秒為單位,最多可有 9 個小數位數,並應以「 |
FixedFrequencySchedule
這個排程會以固定頻率觸發備份作業 (目前僅支援每日備份)。
JSON 表示法 |
---|
{
"startTime": {
object ( |
欄位 | |
---|---|
startTime |
這是必要旗標,每次自動備份的開始時間 (世界標準時間)。必須設為整點。這是必填欄位。 |
AutomatedBackupMode
自動備份模式。
列舉 | |
---|---|
AUTOMATED_BACKUP_MODE_UNSPECIFIED |
預設值。未指定自動備份設定。 |
DISABLED |
已停用自動備份設定。 |
ENABLED |
已啟用自動備份設定。 |
方法 |
|
---|---|
|
備份 Redis 叢集。 |
|
根據指定屬性建立 Redis 叢集。 |
|
刪除特定 Redis 叢集。 |
|
取得特定 Redis 叢集的詳細資料。 |
|
取得 Redis 叢集的憑證授權單位資訊詳細資料。 |
|
列出指定位置 (區域) 或所有位置中,專案擁有的所有 Redis 叢集。 |
|
更新特定 Redis 叢集的中繼資料和設定。 |
|
重新排定日後的維護事件。 |