Roll back the DNS records of a domain to the specified backup.

Usage

Request frequency: Maximum of 1 call per second.

Only domains whose edition is ultimate edition or exclusive edition support the DNS record backup feature.

Important notes

If the IP-based line or line group used by the backup has been deleted, the rollback will fail. See What is an IP-based line and What is a line group.

If the backup uses features that exceed your domain's current edition specification, DNS records that exceed the current edition specification cannot be modified. For example, the current edition of your domain is the Ultimate Edition, and the DNS records in the backup use parameters that comply with the specifications of the Exclusive Edition, but these parameters exceed the specifications of the Ultimate Edition. In this case, rollback will succeed. However, you cannot modify DNS records that are beyond the specifications of the current edition. For the specification limits of different editions, see Edition specification limits.

If the DNSSEC status of the backup is different from the current DNSSEC status, the current DNSSEC status will remain unchanged during rollback.

Request

Request method: POST

Request address: https://dns.volcengineapi.com/?Action=RestoreUserZoneBackup&Version=2018-08-01

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

In addition to the following parameters, you also need to authenticate the request.

Parameters	Type	Required or optional	Example value	Description
Action	String	Is	RestoreUserZoneBackup	Operation to be performed: RestoreUserZoneBackup.
Version	String	Is	2018-08-01	API version. Value: 2018-08-01.
ZID	Long	Is	33279	ID of the domain whose DNS record needs to be rolled back. You can call the ListZones API to obtain the domain ID.
BackupID	String	Is	MjAyMy0wNC0wMSAwMzo0Nzo0OV8x	ID of the backup to roll back to. You can call the ListUserZoneBackups API to obtain the backup ID.

Response parameters

The following table lists only the response parameters specific to this interface. For more information, see Return structure.

Parameters	Type	Example value	Description
TotalRecord	Integer	2	Total number of DNS records in the backup.

Request example

Response example

Common error codes

The following table lists the error codes related to this interface and its business logic. For public error codes, see the Public error codes document.

Status code	error codes	Error message	Note
400	ErrParsingParams	parsing params error	Failed to parse the request.
400	ErrParamInvalid	validation fail:%s	Parameter validation failed.
400	ErrDBNotFound	record not found :%s	Database entry not found.
400	ErrZoneNotFound	zone not found	Domain name not found.
400	ErrZoneInactive	zone is inactive	Domain name pending recovery.
400	ErrZoneSpecNotValid	this zone does not support this operation	The current edition does not support this operation.
500	ErrInternalServer	server internal error	Internal service error.

TrafficRoute DNS Suite