Restoring a Client Access Authentication Configuration

Function

This API is used to restore a client access authentication configuration based on the modification history. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Constraints

Currently, client access authentication cannot be synchronized within a DR relationship. If a DR relationship has been established between two instances, you are advised to perform the same configuration on the peer instance.

Debugging

You can debug this API in API Explorer.

URI

PUT /v3/{project_id}/instances/{instance_id}/restore-hba-info

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

**Table 3** Parameter description
Parameter	Mandatory	Type	Description
hba_history_id	No	String	Definition ID of the historical modification record of a client access authentication configuration. If this parameter is left empty, the configuration will be restored to its default state. Constraints N/A Range N/A Default Value N/A

Response Parameters

None

Example Request

Restoring a client access authentication configuration

PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/{instance_id}/restore-hba-info

{
    "hba_history_id":""
}