All Products
Search
Document Center

Elasticsearch:DeleteSnapshotRepo

Last Updated:Jul 08, 2024

Deletes a cross-cluster OSS referenced repository from an instance.

Debugging

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 headers

This operation does not have operation-specific request headers and uses only common request headers. For more information, refer to the documentation of common request parameters.

Request syntax

DELETE /openapi/instances/{InstanceId}/snapshot-repos HTTP/1.1

Request parameters

Parameter

Type

Position

Required

Example

Description

InstanceId String Path Yes es-cn-n6w1o1x0w001c****

The ID of the ApsaraMQ for RocketMQ instance.

repoPath String Query Yes es-cn-n6w1rux8i000w****

The ID of the reference instance. Obtain parameter information. For more information, see ListSnapshotReposByInstanceId.

.

clientToken String Query No. 5A2CFF0E-5718-45B5-9D4D-70B3FF****

that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Response parameters

Parameter

Type

Example

Description

Result Boolean true

Returned result:

  • true: The referenced repository is deleted.
  • false: The referenced repository fails to be deleted.
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

The ID of the request.

Examples

Sample requests

DELETE /openapi/instances/es-cn-n6w1o1x0w001c****/snapshot-repos?repoPath=es-cn-n6w1rux8i000w**** HTTP/1.1
Common request parameters

Sample success responses

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "93005691-1899-4515-A5CE-FD28D347****"
}

Error codes

HttpCode

Error code

Error message

Error message

400 InstanceActivating Instance is activating. The instance is currently in effect.
400 InstanceNotFound The instanceId provided does not exist. The error message returned because the instance cannot be found. Check the instance status.

For a list of error codes, see Service error codes.