- URL:
- https://<root>/data/<datastoreID>/resetStandby
- Methods:
POST- Version Introduced:
- 11.2
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The reset operation resets the tracking mechanism used to identify a failure of the primary relational data store and forces a reconfiguration of the standby relational data store. If administrators choose to redeploy the standby's underlying PersistentVolumeClaim (PVC), the PVC is deleted as part of the reset. Doing so allows for the standby's StatefulSet to be rescheduled to a separate availability zone without a volume affinity conflict with the existing PersistentVolume.
Request parameters
| Parameter | Details |
|---|---|
| Specifies whether the underlying PVC is deleted as part of the standby instance reset. The default value is Values: |
| Specifies whether the operation should run synchronously or asynchronously. If Values: |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the reset operation:
POST /<context>/admin/data/438a9119c8dc4eb2900abd075327e2c5/resetStandby HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
redeploy=true&async=true&f=pjson&token=P4Vn2uao41gcVGxM8p3lwYgQnt9t20hRo8s4TDsH2XRtiF3xh-lNTfn1dIOaw3ke2P8nCQwjxeLV4kNiftyKCESSEPXiIbQGt9Ph7Bx_LQIGkIoXYZBNOWnOi7Fw8Z5GRg2_xYSWoLg8zzZcO3utdVsIG1Ew7Ab8f-Ti28TfUvtv7cWM9BzRaw00EtqbdJj0zu23kTYNsOO0KaXkJ5IR8wF1qGxD6-KmVyOdfC9ms51khCiq473WAo4Ho8zwkdwVJSON Response example
{
"jobsUrl": "https://organization.example.com/<context>/admin/jobs/ja2ca1a35-881c-400c-a49a-b26883002d6c",
"jobID": "ja2ca1a35-881c-400c-a49a-b26883002d6c",
"jobStatus": "SUBMITTED"
}