Call the AddSnapshotRepo to create a reference repository when configuring a cross-cluster OSS repository.
Debugging
Request header
This operation uses common request parameters only.
Request syntax
POST /openapi/instances/[InstanceId]/snapshot-repos HTTPS|HTTP
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
InstanceId | String | Yes | es-cn-n6w1o1x0w001c**** |
The ID of the instance for which you want to access OSS repositories across clusters. |
RequestBody
The following parameters must be set in RequestBody to specify the cross-cluster backup information.
Parameter |
Type |
Required |
Example |
Description |
---|---|---|---|---|
repoPath |
String |
Yes |
es-cn-4591jumei000u**** |
The ID of the instance for which you want to restore data. After this parameter is specified, Elasticsearch creates a snapshot of the instance from which you can restore data. The instance and the source instance must meet the following requirements: Instances within the same region belong to the same account, and the version of the source instance is earlier than or equal to the version of the destination instance. For more information, see configure cross-cluster OSS repositories. |
Example:
{
"repoPath" :"es-cn-4591jumei000u****"
}
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1**** |
The ID of the request. |
Result | Boolean | true |
Return results:
|
Examples
Sample requests
POST /openapi/instances/es-cn-n6w1o1x0w001c****/snapshot-repos HTTP/1.1
{
"repoPath" :"es-cn-4591jumei000u****"
}
Sample success responses
JSON
format
{
"Result": true,
"RequestId": "D21379E3-A54E-4C86-A64C-3717365F****"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InstanceNotFound | The instanceId provided does not exist. | The error message returned because the specified instance cannot be found. Check the instance status. |
For a list of error codes, visit the API Error Center.