View a markdown version of this page

ðŸ“Ē āđāļˆāđ‰āļ‡āđ€āļ•āļ·āļ­āļ™: opensearch service/latest/APIReference/API UpdateClone.html - Kapook Update 2025

UpdateClone

Manages a cloned blue/green upgrade that is in progress on a domain. Use it to shift a percentage of search traffic to the cloned cluster, to cut over to the cloned cluster or back to the primary cluster, or to change the retention period. Specify exactly one of TrafficSplitOptions, CutoverOptions, or RetentionOptions in each request.

Request Syntax

POST /2021-01-01/opensearch/domain/DomainName/clone HTTP/1.1 Content-type: application/json { "CutoverOptions": { "Target": "string" }, "RetentionOptions": { ... }, "TrafficSplitOptions": { "CloneReadTrafficPercent": number, "Strategy": "string" } }

URI Request Parameters

The request uses the following URI parameters.

DomainName

The name of the domain that has a cloned blue/green upgrade in progress.

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

CutoverOptions

Cuts the domain over to the cloned cluster or back to the primary cluster.

Type: CutoverRequestOptions object

Required: No

RetentionOptions

Changes the retention period, or ends it after cutover completes.

Type: RetentionOptions object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

TrafficSplitOptions

Shifts a percentage of search traffic from the primary cluster to the cloned cluster.

Type: TrafficSplitRequestOptions object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ChangeId": "string", "CutoverOptions": { "Status": "string", "Target": "string" }, "DomainName": "string", "RetentionOptions": { ... }, "TrafficSplitOptions": { "Current": { "CloneReadTrafficPercent": number, "PrimaryReadTrafficPercent": number }, "Status": "string", "Target": { "CloneReadTrafficPercent": number, "PrimaryReadTrafficPercent": number } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ChangeId

The unique identifier of the configuration change. Use it with DescribeDomainChangeProgress to track the change.

Type: String

Length Constraints: Fixed length of 36.

Pattern: \p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}

CutoverOptions

The requested cutover target and the status of the cutover.

Type: CutoverOptions object

DomainName

The name of the domain.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

RetentionOptions

The retention settings for the upgrade.

Type: RetentionOptions object

Note: This object is a Union. Only one member of this object can be specified or returned.

TrafficSplitOptions

The current and requested traffic split, and the status of the traffic shift.

Type: TrafficSplitOptions object

Errors

For information about the errors that are common to all actions, see Common Error Types.

BaseException

An error occurred while processing the request.

message

A description of the error.

HTTP Status Code: 400

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: