Help Center/ IAM Identity Center/ API Reference/ API/ Instance Management/ Querying HA Configurations
Updated on 2025-11-27 GMT+08:00
View PDF

Querying HA Configurations

Function

This API is used to query configurations of the HA function. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

GET /v1/instances/{instance_id}/disaster-recovery-configuration

Table 1 Path parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Globally unique ID of an IAM Identity Center instance.

Request Parameters

Table 2 Parameters in the request header

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.

Response Parameters

Status code: 200

Table 3 Parameters in the response body

Parameter

Type

Description

disaster_recovery_choice

String

Whether to enable the HA function.

Status code: 400

Table 4 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Status code: 403

Table 5 Parameters in the response body

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

Querying configurations of the HA function

GET https://{hostname}/v1/instances/{instance_id}/disaster-recovery-configuration

Example Response

Status code: 200

Successful

{
  "disaster_recovery_choice" : "REJECT"
}

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

Error Codes

For details, see Error Codes.

Parent topic: Instance Management