Call CreateSnapshot to manually back up a cluster snapshot.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request header

This operation uses common request parameters only. For more information, see Common parameters.

Request syntax

POST /openapi/instances/[InstanceId]/snapshots HTTPS|HTTP

Request parameters

Parameter Type Required Example Description
ClientToken String Yes 5A2CFF0E-5718-45B5-9D4D-70B3FF****

A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

InstanceId String Yes es-cn-nif1q9o8r0008****

The ID of the instance.

Response parameters

Parameter Type Example Description
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

The ID of the request.

Result Boolean true

Return results:

  • true: manual snapshot backup successfully
  • false: manual snapshot backup failed


Sample requests

POST /openapi/instances/es-cn-oew1oxiro000f****/snapshots? ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Common request header

Sample success responses

JSON format

    "Result": true,
    "RequestId": "8EA34ABE-8015-4190-9B57-B3079AB2****"

Error codes

For a list of error codes, visit the API Error Center.