UpdateCluster - Amazon MemoryDB

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

UpdateCluster

修改叢集的設定。您可以使用此作業透過指定設定和新值來變更一或多個叢集配置設定。

請求語法

{ "ACLName": "string", "ClusterName": "string", "Description": "string", "EngineVersion": "string", "MaintenanceWindow": "string", "NodeType": "string", "ParameterGroupName": "string", "ReplicaConfiguration": { "ReplicaCount": number }, "SecurityGroupIds": [ "string" ], "ShardConfiguration": { "ShardCount": number }, "SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SnsTopicStatus": "string" }

請求參數

如需有關所有動作共用之參數的資訊,請參閱一般參數

請求接受採用 JSON 格式的下列資料。

ACLName

與叢集關聯的存取控制清單

類型:String

長度限制:長度下限為 1。

模式:[a-zA-Z][a-zA-Z0-9\-]*

必要:否

ClusterName

要更新的叢集名稱

類型:String

必要:是

Description

要更新的叢集描述

類型:字串

必要:否

EngineVersion

要在節點上執行的引擎升級版本。您可以升級至更新的引擎版本,但您無法降級至較早的引擎版本。若想要使用舊版的引擎,您必須刪除現有的叢集,再使用舊版引擎建立新的叢集。

類型:字串

必要:否

MaintenanceWindow

指定每週執行叢集維護作業的時間範圍。指定的範圍格式為 ddd:hh24:mi-ddd:hh24:mi (24 小時制 UTC)。而最短的維護時段為 60 分鐘。

ddd的有效值為:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

範例:sun:23:00-mon:01:30

類型:字串

必要:否

NodeType

您要擴展或縮減此叢集的有效節點類型。

類型:字串

必要:否

ParameterGroupName

要更新的參數群組名稱

類型:字串

必要:否

ReplicaConfiguration

將存放在每個碎片中的複本數目

類型:ReplicaConfigurationRequest 物件

必要:否

SecurityGroupIds

SecurityGroupIds 要更新的

類型:字串陣列

必要:否

ShardConfiguration

叢集中的碎片數目

類型:ShardConfigurationRequest 物件

必要:否

SnapshotRetentionLimit

MemoryDB 保留自動叢集快照的天數,在此之後才會刪除快照。例如,若您 SnapshotRetentionLimit 將設為 5,則今天擷取的快照會保留 5 天,才會遭到刪除。

類型:整數

必要:否

SnapshotWindow

MemoryDb 開始拍攝叢集每日快照的每日時間範圍 (UTC)。

類型:字串

必要:否

SnsTopicArn

要更新的 SNS 主題 ARN

類型:字串

必要:否

SnsTopicStatus

Amazon SNS 通知主題的狀態。只有當狀態為作用中時,才會傳送通知。

類型:字串

必要:否

回應語法

{ "Cluster": { "ACLName": "string", "ARN": "string", "AutoMinorVersionUpgrade": boolean, "AvailabilityMode": "string", "ClusterEndpoint": { "Address": "string", "Port": number }, "DataTiering": "string", "Description": "string", "EnginePatchVersion": "string", "EngineVersion": "string", "KmsKeyId": "string", "MaintenanceWindow": "string", "Name": "string", "NodeType": "string", "NumberOfShards": number, "ParameterGroupName": "string", "ParameterGroupStatus": "string", "PendingUpdates": { "ACLs": { "ACLToApply": "string" }, "Resharding": { "SlotMigration": { "ProgressPercentage": number } }, "ServiceUpdates": [ { "ServiceUpdateName": "string", "Status": "string" } ] }, "SecurityGroups": [ { "SecurityGroupId": "string", "Status": "string" } ], "Shards": [ { "Name": "string", "Nodes": [ { "AvailabilityZone": "string", "CreateTime": number, "Endpoint": { "Address": "string", "Port": number }, "Name": "string", "Status": "string" } ], "NumberOfNodes": number, "Slots": "string", "Status": "string" } ], "SnapshotRetentionLimit": number, "SnapshotWindow": "string", "SnsTopicArn": "string", "SnsTopicStatus": "string", "Status": "string", "SubnetGroupName": "string", "TLSEnabled": boolean } }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

Cluster

更新的叢集

類型:Cluster 物件

錯誤

如需所有動作常見的錯誤相關資訊,請參閱常見錯誤

ACLNotFoundFault

HTTP 狀態碼:400

ClusterNotFoundFault

HTTP 狀態碼:400

ClusterQuotaForCustomerExceededFault

HTTP 狀態碼:400

InvalidACLStateFault

HTTP 狀態碼:400

InvalidClusterStateFault

HTTP 狀態碼:400

InvalidKMSKeyFault

HTTP 狀態碼:400

InvalidNodeStateFault

HTTP 狀態碼:400

InvalidParameterCombinationException

HTTP 狀態碼:400

InvalidParameterValueException

HTTP 狀態碼:400

InvalidVPCNetworkStateFault

HTTP 狀態碼:400

NodeQuotaForClusterExceededFault

HTTP 狀態碼:400

NodeQuotaForCustomerExceededFault

HTTP 狀態碼:400

NoOperationFault

HTTP 狀態碼:400

ParameterGroupNotFoundFault

HTTP 狀態碼:400

ServiceLinkedRoleNotFoundFault

HTTP 狀態碼:400

ShardsPerClusterQuotaExceededFault

HTTP 狀態碼:400

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: