REST Resource: projects.locations.clusters

資源:叢集

叢集執行個體。

JSON 表示法
{
  "name": string,
  "createTime": string,
  "state": enum (State),
  "uid": string,
  "authorizationMode": enum (AuthorizationMode),
  "transitEncryptionMode": enum (TransitEncryptionMode),
  "pscConfigs": [
    {
      object (PscConfig)
    }
  ],
  "discoveryEndpoints": [
    {
      object (DiscoveryEndpoint)
    }
  ],
  "pscConnections": [
    {
      object (PscConnection)
    }
  ],
  "stateInfo": {
    object (StateInfo)
  },
  "nodeType": enum (NodeType),
  "persistenceConfig": {
    object (ClusterPersistenceConfig)
  },
  "redisConfigs": {
    string: string,
    ...
  },
  "zoneDistributionConfig": {
    object (ZoneDistributionConfig)
  },
  "crossClusterReplicationConfig": {
    object (CrossClusterReplicationConfig)
  },
  "pscServiceAttachments": [
    {
      object (PscServiceAttachment)
    }
  ],
  "clusterEndpoints": [
    {
      object (ClusterEndpoint)
    }
  ],
  "automatedBackupConfig": {
    object (AutomatedBackupConfig)
  },
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "availableMaintenanceVersions": [
    string
  ],
  "allowFewerZonesDeployment": boolean,
  "labels": {
    string: string,
    ...
  },
  "aclPolicy": string,
  "aclPolicyInfo": {
    object (AclPolicyInfo)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsSource": {
    object (GcsBackupSource)
  },
  "managedBackupSource": {
    object (ManagedBackupSource)
  }
  // End of mutually exclusive fields.
  "replicaCount": integer,
  "sizeGb": integer,
  "shardCount": integer,
  "preciseSizeGb": number,
  "deletionProtectionEnabled": boolean,
  "maintenancePolicy": {
    object (ClusterMaintenancePolicy)
  },
  "maintenanceSchedule": {
    object (ClusterMaintenanceSchedule)
  },
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean,
  "simulateMaintenanceEvent": boolean,
  "backupCollection": string,
  "kmsKey": string,
  "ondemandMaintenance": boolean,
  "asyncClusterEndpointsDeletionEnabled": boolean,
  "maintenanceVersion": string,
  "effectiveMaintenanceVersion": string,
  "serverCaMode": enum (ServerCaMode),
  "serverCaPool": string,
  "rotateServerCertificate": boolean,
  "aclPolicyInSync": boolean
}
欄位
name

string

這是必要旗標,ID。這個範圍內資源的專屬名稱,包括專案和位置,格式為:projects/{projectId}/locations/{locationId}/clusters/{clusterId}

createTime

string (Timestamp format)

僅供輸出。與叢集建立要求相關聯的時間戳記。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

state

enum (State)

僅供輸出。這個叢集的目前狀態。可能為 CREATING、READY、UPDATING、DELETING 和 SUSPENDED

uid

string

僅供輸出。系統指派的叢集專屬 ID。

authorizationMode

enum (AuthorizationMode)

選用。Redis 叢集的授權模式。如未提供,叢集的驗證功能會停用。

transitEncryptionMode

enum (TransitEncryptionMode)

選用。Redis 叢集的傳輸中資料加密。如未提供,叢集會停用加密功能。

pscConfigs[]

object (PscConfig)

選用。每個 PscConfig 都會設定消費者網路,系統會將 IP 指派給叢集,供用戶端透過 Private Service Connect Automation 存取。目前僅支援一個 PscConfig。

discoveryEndpoints[]

object (DiscoveryEndpoint)

僅供輸出。在每個指定網路上建立端點,供 Redis 用戶端連線至叢集。目前僅支援一個探索端點。

pscConnections[]

object (PscConnection)

僅供輸出。透過服務連線自動化功能自動建立的 PSC 連線清單。

stateInfo

object (StateInfo)

僅供輸出。叢集目前狀態的其他資訊。

nodeType

enum (NodeType)

選用。叢集中的 Redis 節點類型。NodeType 會決定 Redis 節點的基礎機型。

persistenceConfig

object (ClusterPersistenceConfig)

選用。叢集的持續性設定 (RDB、AOF)。

redisConfigs

map (key: string, value: string)

選用。可變動 Redis 設定的客戶覆寫鍵/值組合

包含 "key": value 組合清單的物件,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

zoneDistributionConfig

object (ZoneDistributionConfig)

選用。這項設定會用於判斷客戶希望我們如何在區域內分配叢集資源。

crossClusterReplicationConfig

object (CrossClusterReplicationConfig)

選用。跨叢集複製設定。

pscServiceAttachments[]

object (PscServiceAttachment)

僅供輸出。設定 PSC 連線的服務連結詳細資料

clusterEndpoints[]

object (ClusterEndpoint)

選用。叢集端點清單。

automatedBackupConfig

object (AutomatedBackupConfig)

選用。叢集的自動備份設定。

encryptionInfo

object (EncryptionInfo)

僅供輸出。叢集靜態資料的加密資訊。

availableMaintenanceVersions[]

string

僅供輸出。這個欄位用於判斷自助式更新可用的維護版本。

allowFewerZonesDeployment
(deprecated)

boolean

選用。不可變動。已淘汰,請勿使用。

labels

map (key: string, value: string)

選用。代表使用者提供中繼資料的標籤。

包含 "key": value 組合清單的物件,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

aclPolicy

string

選用。要套用至叢集的 ACL 政策。

aclPolicyInfo

object (AclPolicyInfo)

僅供輸出。套用的 ACL 政策詳細資料。

要匯入的來源。以下列出互斥欄位。回應中最多會設定一個欄位:
gcsSource

object (GcsBackupSource)

選用。備份檔會儲存在 Cloud Storage bucket 中。Cloud Storage bucket 必須與叢集位於相同區域。如要從提供的 Cloud Storage 物件匯入資料,您必須具備讀取權限。

managedBackupSource

object (ManagedBackupSource)

選用。由 Memorystore 服務產生及管理的備份。

互斥欄位的結尾。
replicaCount

integer

選用。每個分片的副本節點數量。

sizeGb

integer

僅供輸出。整個叢集的 Redis 記憶體大小 (以 GB 為單位),向上取整至下一個整數。

shardCount

integer

選用。Redis 叢集的資料分割數量。

preciseSizeGb

number

僅供輸出。整個叢集的 Redis 記憶體大小精確值 (以 GB 為單位)。

deletionProtectionEnabled

boolean

選用。如果值設為 true,刪除作業就會失敗。

maintenancePolicy

object (ClusterMaintenancePolicy)

選用。叢集維護政策會決定何時允許或拒絕更新。

maintenanceSchedule

object (ClusterMaintenanceSchedule)

僅供輸出。ClusterMaintenanceSchedule (僅供輸出) 已發布的維護排程。

satisfiesPzs

boolean

選用。僅供輸出。保留欄位,供日後使用。

satisfiesPzi

boolean

選用。僅供輸出。保留欄位,供日後使用。

simulateMaintenanceEvent

boolean

選用。僅限輸入。模擬維護事件。

backupCollection

string

選用。僅供輸出。備份集合的完整資源名稱。範例:projects/{project}/locations/{location}/backupCollections/{collection}

kmsKey

string

選用。用來加密叢集靜態資料的 KMS 金鑰。

ondemandMaintenance
(deprecated)

boolean

選用。僅限輸入。叢集的隨選維護作業。這個欄位可用於在叢集上觸發隨選重大更新。

asyncClusterEndpointsDeletionEnabled

boolean

選用。如為 true,客戶建立及註冊的叢集端點可以非同步刪除。也就是說,這類叢集端點可以在刪除叢集端點中的轉送規則之前取消註冊。

maintenanceVersion

string

選用。這個欄位可用來觸發自助式更新,指出所需的維護版本。這個欄位的輸入內容取決於可用的 MaintenanceVersions 欄位。

effectiveMaintenanceVersion

string

僅供輸出。這個欄位代表叢集的實際維護版本。

serverCaMode

enum (ServerCaMode)

選用。叢集的伺服器 CA 模式。

serverCaPool

string

選用。叢集的客戶管理 CA 集區。僅適用於 BYOCA,也就是 serverCaMode 為 SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA 時。格式:「projects/{project}/locations/{region}/caPools/{ca_pool}」。

rotateServerCertificate

boolean

選用。僅限輸入。輪換伺服器憑證。

aclPolicyInSync
(deprecated)

boolean

選用。僅供輸出。已淘汰:指出套用至叢集的 ACL 規則是否已同步。

GcsBackupSource

備份檔會儲存在 Cloud Storage bucket 中。Cloud Storage bucket 必須與叢集位於相同區域。

JSON 表示法
{
  "uris": [
    string
  ]
}
欄位
uris[]

string

選用。要匯入的 Cloud Storage 物件 URI。例如:gs://bucket1/object1、gs://bucket2/folder2/object2

ManagedBackupSource

由 Memorystore 產生及管理的備份。

JSON 表示法
{
  "backup": string
}
欄位
backup

string

選用。範例://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 授權停用模式
AUTH_MODE_TOKEN_AUTH 權杖式授權模式

TransitEncryptionMode

可用的傳輸中資料加密模式。

列舉
TRANSIT_ENCRYPTION_MODE_UNSPECIFIED 未設定傳輸加密。
TRANSIT_ENCRYPTION_MODE_DISABLED 傳輸加密已停用。
TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION 使用伺服器管理的加密金鑰,加密傳輸中的資料。

PscConfig

JSON 表示法
{
  "network": string
}
欄位
network

string

這是必要旗標,保留探索端點 IP 位址的網路,格式為 projects/{networkProject}/global/networks/{network_id}。

DiscoveryEndpoint

各網路上的端點,供 Redis 用戶端連線至叢集。

JSON 表示法
{
  "address": string,
  "port": integer,
  "pscConfig": {
    object (PscConfig)
  }
}
欄位
address

string

僅供輸出。用戶端用來連線至服務的公開 Redis 端點位址。位址可以是 IP 或主機名稱。

port

integer

僅供輸出。公開 Redis 端點的通訊埠號碼。

pscConfig

object (PscConfig)

僅供輸出。客戶設定,用於建立及存取端點。

PscConnection

PSC 連線中取用者資源的詳細資料。

JSON 表示法
{
  "pscConnectionId": string,
  "address": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "port": integer
  // End of mutually exclusive fields.
}
欄位
pscConnectionId

string

這是必要旗標,與服務連結建立連線的轉送規則 PSC 連線 ID。

address

string

這是必要旗標,在消費者網路中為 PSC 轉送規則分配的 IP。

forwardingRule

string

這是必要旗標,消費者端轉送規則的 URI。範例:projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}。

projectId

string

選用。建立轉送規則的消費端專案 ID。

network

string

這是必要旗標,IP 位址所在的消費者網路,格式為 projects/{projectId}/global/networks/{network_id}。

serviceAttachment

string

這是必要旗標,PSC 連線的目標服務連結,格式為 projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}。

pscConnectionStatus

enum (PscConnectionStatus)

僅供輸出。PSC 連線的狀態。請注意,這個值會定期更新。如要取得 PSC 連線的最新狀態,請按照 https://cloud.google.com/vpc/docs/configure-private-service-connect-services#endpoint-details 操作。

connectionType

enum (ConnectionType)

僅供輸出。PSC 連線類型。

公開探索端點的通訊埠編號。以下列出互斥欄位。回應中最多會設定一個欄位:
port

integer

僅供輸出。只有主要/讀取器或探索端點會設定連接埠。

互斥欄位的結尾。

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 表示法
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "updateInfo": {
    object (UpdateInfo)
  }
  // End of mutually exclusive fields.
}
欄位
以下列出互斥欄位。回應中最多會設定一個欄位:
updateInfo

object (UpdateInfo)

說明叢集狀態為 UPDATING 時,叢集正在進行的更新。

互斥欄位的結尾。

UpdateInfo

代表更新叢集的相關資訊。

JSON 表示法
{
  "targetShardCount": integer,
  "targetReplicaCount": integer,
  "targetNodeType": enum (NodeType)
}
欄位
targetShardCount

integer

Redis 叢集的目標資料分割數

targetReplicaCount

integer

每個分片的目標副本節點數量。

targetNodeType

enum (NodeType)

Redis 叢集的目標節點類型。

ClusterPersistenceConfig

設定持續性功能。

JSON 表示法
{
  "mode": enum (PersistenceMode),
  "rdbConfig": {
    object (RDBConfig)
  },
  "aofConfig": {
    object (AOFConfig)
  }
}
欄位
mode

enum (PersistenceMode)

選用。持續性模式。

rdbConfig

object (RDBConfig)

選用。RDB 設定。如果模式不是 RDB,系統就會忽略這個欄位。

aofConfig

object (AOFConfig)

選用。AOF 設定。如果模式不是 AOF,系統會忽略這個欄位。

PersistenceMode

可用的持續性模式。

列舉
PERSISTENCE_MODE_UNSPECIFIED 未設定。
DISABLED 持續性已停用,且所有快照資料都已刪除。
RDB 已啟用以 RDB 為基礎的持續性。
AOF 已啟用以 AOF 為基礎的持續性。

RDBConfig

以 RDB 為基礎的持續性設定。

JSON 表示法
{
  "rdbSnapshotPeriod": enum (SnapshotPeriod),
  "rdbSnapshotStartTime": string
}
欄位
rdbSnapshotPeriod

enum (SnapshotPeriod)

選用。RDB 快照之間的間隔時間。

rdbSnapshotStartTime

string (Timestamp format)

選用。系統嘗試建立第一個快照的時間,以及後續快照的對齊時間。如未提供,系統會使用目前時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

SnapshotPeriod

可用的快照週期。

列舉
SNAPSHOT_PERIOD_UNSPECIFIED 未設定。
ONE_HOUR 1 小時。
SIX_HOURS 六小時。
TWELVE_HOURS 12 小時。
TWENTY_FOUR_HOURS 24 小時。

AOFConfig

設定以 AOF 為基礎的持續性。

JSON 表示法
{
  "appendFsync": enum (AppendFsync)
}
欄位
appendFsync

enum (AppendFsync)

選用。fsync 設定。

AppendFsync

可用的 fsync 模式。

列舉
APPEND_FSYNC_UNSPECIFIED 未設定。預設值:EVERYSEC
NO 永不執行 fsync。通常 Linux 會使用這項設定每 30 秒清除一次資料,但實際情況取決於核心的確切調整。
EVERYSEC 每秒執行一次 fsync。速度不夠快,如果發生災害,可能會遺失 1 秒的資料
ALWAYS 每次將新的寫入指令附加至 AOF 時,都會執行 fsync。以效能為代價,提供最佳資料遺失防護

ZoneDistributionConfig

叢集資源分配的可用區分配設定。

JSON 表示法
{
  "mode": enum (ZoneDistributionMode),
  "zone": string,
  "zones": [
    string
  ]
}
欄位
mode

enum (ZoneDistributionMode)

選用。區域分配模式。如未指定,預設為 MULTI_ZONE。

zone

string

選用。選取「單一可用區」分配方式後,系統會使用可用區欄位,在該可用區中分配所有資源。這不適用於 MULTI_ZONE,且會遭到 MULTI_ZONE 叢集忽略。

zones[]

string

選用。指定 Redis 叢集分配資源的多可用區叢集可用區。這個標記不適用於單一可用區叢集。

ZoneDistributionMode

定義各種區域分配模式。

列舉
ZONE_DISTRIBUTION_MODE_UNSPECIFIED 未設定。預設值:MULTI_ZONE
MULTI_ZONE 將所有資源分散到區域內隨機選取的 3 個可用區。
SINGLE_ZONE 將所有資源分配到單一可用區。選取這個模式時,必須指定可用區欄位。

CrossClusterReplicationConfig

跨叢集複製設定。

JSON 表示法
{
  "clusterRole": enum (ClusterRole),
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ],
  "updateTime": string,
  "membership": {
    object (Membership)
  }
}
欄位
clusterRole

enum (ClusterRole)

僅供輸出。叢集在跨叢集複製中的角色。

primaryCluster

object (RemoteCluster)

做為這個次要叢集複製來源的主要叢集詳細資料。

這個欄位只會針對次要叢集設定。

secondaryClusters[]

object (RemoteCluster)

從這個主要叢集複製資料的次要叢集清單。

這個欄位只會針對主要叢集設定。

updateTime

string (Timestamp format)

僅供輸出。上次更新跨叢集複寫設定的時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

membership

object (Membership)

僅供輸出。僅供輸出,顯示參與跨叢集複製的所有成員叢集。無論叢集角色(主要或次要) 為何,每個成員叢集都會提供這個檢視畫面。

主要叢集可以提供所有從中複製資料的次要叢集相關資訊。不過,次要叢集只會知道要從哪個主要叢集複製資料。不過,如果主要叢集無法使用(例如區域中斷),則可將 clusters.get 要求傳送至任何其他成員叢集,這個欄位會列出參與跨叢集複製的所有成員叢集。

ClusterRole

叢集在跨叢集複製中的角色。

列舉
CLUSTER_ROLE_UNSPECIFIED 未設定叢集角色。這項行為等同於 NONE。
NONE 這個叢集不會參與跨叢集複製作業。這是獨立的叢集,不會與任何其他叢集複製資料。
PRIMARY 允許讀取和寫入的叢集。寫入這個叢集的任何資料也會複製到附加的次要叢集。
SECONDARY 這類叢集只允許讀取,並從主要叢集複製資料。

RemoteCluster

與這個叢集相關聯的遠端叢集詳細資料,適用於跨叢集複製設定。

JSON 表示法
{
  "cluster": string,
  "uid": string
}
欄位
cluster

string

僅供輸出。遠端叢集的完整資源路徑,格式為:projects//locations//clusters/

uid

string

僅供輸出。遠端叢集的專屬 ID。

成員資格

僅供輸出,顯示參與跨叢集複製的所有成員叢集。

JSON 表示法
{
  "primaryCluster": {
    object (RemoteCluster)
  },
  "secondaryClusters": [
    {
      object (RemoteCluster)
    }
  ]
}
欄位
primaryCluster

object (RemoteCluster)

僅供輸出。主要叢集會做為次要叢集的複製來源。

secondaryClusters[]

object (RemoteCluster)

僅供輸出。從主要叢集複製資料的次要叢集清單。

ClusterMaintenancePolicy

每個叢集的維護政策。

JSON 表示法
{
  "createTime": string,
  "updateTime": string,
  "weeklyMaintenanceWindow": [
    {
      object (ClusterWeeklyMaintenanceWindow)
    }
  ]
}
欄位
createTime

string (Timestamp format)

僅供輸出。建立政策的時間,也就是指派維護期間或拒絕期間的時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

updateTime

string (Timestamp format)

僅供輸出。政策更新時間,也就是維護期間或拒絕期更新時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

weeklyMaintenanceWindow[]

object (ClusterWeeklyMaintenanceWindow)

選用。套用至這項政策涵蓋資源的維護期間。最少 1 個。目前版本每週最多只能有一個維護時段。

ClusterWeeklyMaintenanceWindow

每週作業的指定時間範圍。

JSON 表示法
{
  "day": enum (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}
欄位
day

enum (DayOfWeek)

選用。可定義在指定星期幾執行的排程。

startTime

object (TimeOfDay)

選用。時段開始時間 (世界標準時間)。

ClusterMaintenanceSchedule

近期維護排程。

JSON 表示法
{
  "startTime": string,
  "endTime": string
}
欄位
startTime

string (Timestamp format)

僅供輸出。這個執行個體即將進行的排定維護作業開始時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

endTime

string (Timestamp format)

僅供輸出。這個執行個體即將進行的排定維護作業結束時間。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

PscServiceAttachment

叢集的服務連結設定,用於建立 PSC 連線。

JSON 表示法
{
  "serviceAttachment": string,
  "connectionType": enum (ConnectionType)
}
欄位
serviceAttachment

string

僅供輸出。您自行建立的 PscConnection 應做為目標的服務連結 URI

connectionType

enum (ConnectionType)

僅供輸出。指定這個服務連結的 PSC 連線類型。

ClusterEndpoint

ClusterEndpoint 包含在每個虛擬私有雲網路中建立的 PSC 連線群組,用於存取叢集。在每個群組中,叢集中的每個服務附件都應有一個連線。

JSON 表示法
{
  "connections": [
    {
      object (ConnectionDetail)
    }
  ]
}
欄位
connections[]

object (ConnectionDetail)

這是必要旗標,一組 PSC 連線。這些介面會在同一個虛擬私有雲網路中建立,叢集中的每個服務附件各有一個介面。

ConnectionDetail

每項 PSC 連線的詳細資訊。

JSON 表示法
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "pscAutoConnection": {
    object (PscAutoConnection)
  },
  "pscConnection": {
    object (PscConnection)
  }
  // End of mutually exclusive fields.
}
欄位
叢集的 PSC 連線可透過服務連線自動化 (自動註冊連線) 在叢集建立期間建立,也可由客戶自行建立 (使用者註冊連線)。以下列出互斥欄位。回應中最多會設定一個欄位:
pscAutoConnection

object (PscAutoConnection)

透過服務連線自動化建立的 PSC 連線詳細資訊。

pscConnection

object (PscConnection)

由叢集擁有者建立的 PSC 連線詳細資訊。

互斥欄位的結尾。

PscAutoConnection

透過服務連線自動化建立的 PSC 連線中,用戶資源的詳細資料。

JSON 表示法
{
  "pscConnectionId": string,
  "address": string,
  "forwardingRule": string,
  "projectId": string,
  "network": string,
  "serviceAttachment": string,
  "pscConnectionStatus": enum (PscConnectionStatus),
  "connectionType": enum (ConnectionType)
}
欄位
pscConnectionId

string

僅供輸出。與服務連結建立連線的轉送規則 PSC 連線 ID。

address

string

僅供輸出。在消費者網路中為 PSC 轉送規則分配的 IP。

forwardingRule

string

僅供輸出。消費者端轉送規則的 URI。範例:projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}。

projectId

string

這是必要旗標,建立轉送規則的消費者專案 ID。

network

string

這是必要旗標,IP 位址所在的消費者網路,格式為 projects/{projectId}/global/networks/{network_id}。

serviceAttachment

string

僅供輸出。PSC 連線的目標服務連結,格式為 projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}。

pscConnectionStatus

enum (PscConnectionStatus)

僅供輸出。PSC 連線的狀態。請注意,這個值會定期更新。如要查看最新狀態,請使用 Private Service Connect API。

connectionType

enum (ConnectionType)

僅供輸出。PSC 連線類型。

AutomatedBackupConfig

叢集的自動備份設定。

JSON 表示法
{
  "automatedBackupMode": enum (AutomatedBackupMode),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fixedFrequencySchedule": {
    object (FixedFrequencySchedule)
  }
  // End of mutually exclusive fields.
  "retention": string
}
欄位
automatedBackupMode

enum (AutomatedBackupMode)

選用。自動備份模式。如果停用模式,系統會忽略其他欄位。

自動備份的排程。以下列出互斥欄位。回應中最多會設定一個欄位:
fixedFrequencySchedule

object (FixedFrequencySchedule)

選用。以固定頻率觸發自動備份。

互斥欄位的結尾。
retention

string (Duration format)

選用。自動備份的保留期限,到期後系統就會刪除備份。值應介於 1 天至 365 天之間。如未指定,預設值為 35 天。

以秒為單位的時間長度,最多 9 個小數位數,結尾為「s」。示例:"3.5s"。

FixedFrequencySchedule

這個排程會以固定頻率觸發備份作業 (目前僅支援每日備份)。

JSON 表示法
{
  "startTime": {
    object (TimeOfDay)
  }
}
欄位
startTime

object (TimeOfDay)

這是必要旗標,每次自動備份的開始時間 (世界標準時間)。必須設為整點。這是必填欄位。

AutomatedBackupMode

自動備份模式。

列舉
AUTOMATED_BACKUP_MODE_UNSPECIFIED 預設值。未指定自動備份設定。
DISABLED 已停用自動備份設定。
ENABLED 已啟用自動備份設定。

ServerCaMode

叢集的伺服器 CA 模式。

列舉
SERVER_CA_MODE_UNSPECIFIED 未指定伺服器 CA 模式。
SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA 每個叢集都有自己的 Google 管理 CA。
SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA 叢集會使用該區域中 Google 代管的共用 CA。
SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA 叢集使用 CAS 的客戶自行管理 CA。

AclPolicyInfo

套用的 ACL 政策詳細資料。

JSON 表示法
{
  "appliedAclPolicy": string,
  "appliedAclPolicyRevision": string,
  "appliedAclPolicyRevisionNumber": string,
  "aclPolicyRevisionStatuses": [
    {
      object (AclPolicyRevisionStatus)
    }
  ]
}
欄位
appliedAclPolicy

string

僅供輸出。已套用 ACL 政策的資源名稱。格式:「projects/{project}/locations/{location}/aclPolicies/{aclPolicy}」

appliedAclPolicyRevision

string

僅供輸出。已套用 ACL 政策修訂版本的資源名稱。格式:「projects/{project}/locations/{location}/aclPolicies/{aclPolicy}/revisions/{revision}」

appliedAclPolicyRevisionNumber

string (int64 format)

僅供輸出。已套用 ACL 政策修訂版本的修訂版本號碼。

aclPolicyRevisionStatuses[]

object (AclPolicyRevisionStatus)

僅供輸出。叢集上這個存取控管清單政策各項修訂版本的狀態清單。

方法

addTokenAuthUser

為已啟用權杖驗證的叢集新增權杖驗證使用者。

backup

備份 Redis 叢集。

create

根據指定屬性建立 Redis 叢集。

delete

刪除特定 Redis 叢集。

get

取得特定 Redis 叢集的詳細資料。

getCertificateAuthority

取得 Redis 叢集的憑證授權單位資訊詳細資料。

list

列出專案在指定位置 (區域) 或所有位置擁有的所有 Redis 叢集。

patch

更新特定 Redis 叢集的中繼資料和設定。

rescheduleClusterMaintenance

重新安排近期維護事件。