1. Interface Description
Interface request domain name: vpcdns.api3.convergecloud.com.
This API is used to create a backup record.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-07-02 20:40:21.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CreateBackupRecord |
| Version | Yes | No | String | Public parameter, The value of this interface: 2019-10-25 |
| Region | No | No | String | Public parameter,Regional information This interface does not need to pass this parameter. |
| DomainId | Yes | No | Uint64 | Domain ID Example: 2 |
| RecordType | Yes | No | String | Record type. Valid values: A and MX. Example: A |
| SubDomain | Yes | No | String | The subdomain name. Example: www |
| Value | Yes | No | String | The record value. Example: 3.2.4.1 |
| MasterValue | Yes | No | String | Value of the primary record. Example: 4.3.1.1 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| BackUpRecordId | Uint64 | Backup record ID. Example: 3 |
| Value | String | record value Example: 3.2.4.1 |
| RentBackupRecordCount | Uint64 | Number of disaster recovery records. Example: 34 |
| CreatedAt | Datetime | The response time of the binding request. Example: 2014-08-03 12:00:00 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameter. | Parameter error. |
| InvalidParameterValue.DomainNotExist | The domain name does not exist. |
| InvalidParameter.IllegalCidr | Invalid CIDR block. |
| InvalidParameter.IllegalDomain | Incorrect domain name. |
| InvalidParameter.RecordLevelExceed | The level recorded exceeds the limit. |
| InvalidParameter.IllegalRecord | Invalid records. |
| InvalidParameter.IllegalDomainTld | Top-level domain name. |
| InvalidParameter.IllegalPTRRecord | Invalid PTR record. |
| InvalidParameterValue.CnameNotPrivateZone | You can only use CNAMEs to point to the private domains under the current account. |
| InvalidParameter.IllegalRecordValue | Invalid record value. |
| InvalidParameterValue.IllegalWeightValue | The weight value must be a number from 1 to 100. |
| InvalidParameterValue.IllegalTXTValue | After Punycode encoding, the length of the txt format record value must be between 1 and 255. |
| InvalidParameter.WeightNotSupported | The current record does not support weight settings. |
| FailedOperation.CreateRecordFailed | Failed to create the record. |
| InternalError.UndefiendError | Undefined error. |
| InvalidParameterValue.BackupRecordNotSupport | The current data does not support backup records. |
| InvalidParameterValue.RecordConflict | Record conflict. |
| InvalidParameterValue.RecordExist | Record already exists. |
| InvalidParameterValue.BackupRecordExceed | Setting more than three alternative DNS IP addresses is not supported. |
| InvalidParameterValue.BackupRecordOverLimit | The number of backup records of this tenant exceeds the limit. |