翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
提供されたクラスターのリストにサービスの更新を適用します。サービスアップデートとその適用の詳細については、「Applying the service updates」を参照してください。
リクエストの構文
{
"ClusterNames": [ "string
" ],
"ServiceUpdate": {
"ServiceUpdateNameToApply": "string
"
}
}
リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
- ClusterNames
-
更新を適用するクラスター名。
タイプ: 文字列の配列
配列メンバー: 最大数は 20 項目です。
必須: はい
- ServiceUpdate
-
サービス更新の一意の ID
型: ServiceUpdateRequest オブジェクト
必須: いいえ
レスポンスの構文
{
"ProcessedClusters": [
{
"ACLName": "string",
"ARN": "string",
"AutoMinorVersionUpgrade": boolean,
"AvailabilityMode": "string",
"ClusterEndpoint": {
"Address": "string",
"Port": number
},
"DataTiering": "string",
"Description": "string",
"Engine": "string",
"EnginePatchVersion": "string",
"EngineVersion": "string",
"KmsKeyId": "string",
"MaintenanceWindow": "string",
"MultiRegionClusterName": "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
}
],
"UnprocessedClusters": [
{
"ClusterName": "string",
"ErrorMessage": "string",
"ErrorType": "string"
}
]
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- ProcessedClusters
-
更新されたクラスターのリスト。
型: Cluster オブジェクトの配列
- UnprocessedClusters
-
更新が適用されていないクラスターのリスト。
型: UnprocessedCluster オブジェクトの配列
エラー
すべてのアクションに共通のエラーについては、共通エラー を参照してください。
- InvalidParameterValueException
-
HTTP ステータスコード: 400
- ServiceUpdateNotFoundFault
-
HTTP ステータスコード: 400
以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。