Updating HA Function Configurations
Function
This API is used to enable or disable high availability (HA) function configurations. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.
URI
PUT /v1/instances/{instance_id}/disaster-recovery-configuration
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_id |
Yes |
String |
Globally unique ID of an IAM Identity Center instance. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Security-Token |
No |
String |
Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
disaster_recovery_choice |
Yes |
String |
Whether to enable the HA function. |
Response Parameters
Status code: 200
Successful
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
request_id |
String |
Unique ID of a request. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
request_id |
String |
Unique ID of a request. |
encoded_authorization_message |
String |
Encrypted error message. |
Example Request
Enabling or disabling the HA function configurations
PUT https://{hostname}/v1/instances/{instance_id}/disaster-recovery-configuration { "disaster_recovery_choice" : "ACCEPT" }
Example Response
None
Status Codes
Status Code |
Description |
---|---|
200 |
Successful. |
400 |
Bad request. |
403 |
Forbidden. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot