Automate DNS Record Creation at Scale via BatchCreateRecords API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

Creates multiple DNS records in a batch. Multiple record types are supported.

Operation description

This API operation allows you to create or update multiple DNS records at a time. It is suitable for scenarios that require managing a large number of DNS configurations. Supported record types include but are not limited to A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI. Detailed configuration items are provided to meet specific requirements, such as Priority, Flag, Tag, and Weight. In addition, for specific record types such as CERT, SSHFP, SMIMEA, and TLSA, advanced settings such as certificate information and encryption algorithms are supported.

Successfully and unsuccessfully processed records are listed separately in the response, so that you can identify which records are processed, which records failed, and the failure reasons.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:BatchCreateRecords

create

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID, which can be obtained by calling the ListSites operation.	1234567890123
RecordList	array<object>	Yes	The list of DNS records to create.
	array<object>	No	A single record object that contains the specific configuration of the record.
RecordName	string	Yes	The record name.	www.example.com
Type	string	Yes	The DNS type of the record.	A/AAAA
Proxied	boolean	Yes	Specifies whether to enable proxied acceleration for the record. Only CNAME records and A/AAAA records support proxied acceleration. Valid values: true: Proxied acceleration is enabled. false: Proxied acceleration is disabled.	true
SourceType	string	No	The origin type of the CNAME record. This parameter is required when you add a CNAME record. Valid values: OSS: OSS origin. S3: S3 origin. LB: load balancing origin. OP: IPAM pool origin. Domain: common domain name origin. If this parameter is left empty or not specified, the default value is Domain, which indicates a common domain name origin.	OSS
BizName	string	No	The business scenario for record acceleration. Valid values: image_video: video and image. api: API. web: web page.	web
Data	object	Yes	The DNS information of the record. Different fields are required based on the record type.	{ "value":"2.2.2.2" }
Usage	integer	No	The usage identifier of the record. Value range: 0 to 255. This parameter applies to SMIMEA and TLSA records.	0
Fingerprint	string	No	The public key fingerprint of the record. This parameter applies to SSHFP records.	abcdef1234567890
Priority	integer	No	The priority of the record. Value range: 0 to 65535. A smaller value indicates a higher priority. This parameter is required when you add MX, SRV, or URI records.	2
Port	integer	No	The port of the record. Value range: 0 to 65535. This parameter applies only to SRV records.	0
Flag	integer	No	The flag of the CAA record, which indicates its priority and processing method. Value range: 0 to 255.	128
Algorithm	integer	No	The encryption algorithm used by the record. Value range: 0 to 255. This parameter applies to CERT and SSHFP records.	0
Weight	integer	No	The weight of the record. Value range: 0 to 65535. This parameter applies to SRV and URI records.	0
Type	integer	No	The certificate type (for CERT records) or public key type (for SSHFP records) of the record.	0
MatchingType	integer	No	The algorithm policy used to match or verify certificates. Value range: 0 to 255. This parameter applies to SMIMEA and TLSA records.	0
Value	string	No	The record value or partial content. The meaning varies by record type: A/AAAA: the IP address. CNAME: the target domain name. MX: a valid target mail server domain name. TXT: a valid text string. CAA: a valid certification authority domain name. SRV: a valid target host domain name. URI: a valid URI string.	example.com
KeyTag	integer	No	The public key identifier of the record. Value range: 0 to 65535. This parameter applies to CERT records.	0
Tag	string	No	The tag of the CAA record, which indicates its specific type and purpose, such as issue, issuewild, or iodef.	issue
Certificate	string	No	The public key certificate information of the record. This parameter applies to CERT, SMIMEA, and TLSA records.	dGVzdGFkYWxrcw==
Selector	integer	No	The type of certificate or public key used by the record. Value range: 0 to 255. This parameter applies to SMIMEA and TLSA records.	0
Ttl	integer	Yes	The time-to-live (TTL) of the record, in seconds. A value of 1 indicates that the TTL is set to automatic.	60
AuthConf	object	No	The origin authentication information of the CNAME record.
SecretKey	string	No	The SecretKey of the account to which the origin belongs. This parameter is required when the origin type is OSS and the authentication type is private cross-account read, or when the origin type is S3 and the authentication type is private read.	VIxuvJSA2S03f******kp208dy5w7
Version	string	No	The signature algorithm version. This parameter is available when the origin type is S3 and the authentication type is private read. Valid values: v2 v4 Default value: v4.	v4
Region	string	No	The region of the origin. This parameter is required when the origin type is S3. Obtain the region from the official S3 website.	us-east-1
AuthType	string	No	The origin authentication type. Different origin types support different authentication types. The origin type refers to the SourceType parameter in this operation. When the origin type is OSS or S3, you must specify the authentication type. Valid values: public: public read. Select this value when the origin type is OSS or S3 and the origin allows public read access. private: private read. Select this value when the origin type is S3 and the origin allows only private read access. private_same_account: private same-account read. Select this value when the origin type is OSS, the origin is under the same Alibaba Cloud account, and the origin allows only private read access. private_cross_account: private cross-account read. Select this value when the origin type is OSS, the origin is under a different Alibaba Cloud account, and the origin allows only private read access.	private
AccessKey	string	No	The AccessKey of the account to which the origin belongs. This parameter is required when the origin type is OSS and the authentication type is private cross-account read, or when the origin type is S3 and the authentication type is private read.	u0Nkg5gBK*******QF5wvKMM504JUHt

Response elements

Element	Type	Description	Example
	object	The response structure for the batch record creation operation.
RequestId	string	The request ID.	2430E05E-1340-5773-B5E1-B743929F46F2
RecordResultList	object	The list of record creation results, including details of successfully and unsuccessfully created records.
Success	array<object>	The list of successfully created records.
	array<object>
RecordName	string	The record name.	www.example.com
Proxied	boolean	Specifies whether to enable proxy acceleration for the record. Only CNAME records and A/AAAA records can have proxy acceleration enabled. Valid values: true: Proxy acceleration is enabled. false: Proxy acceleration is disabled.	true
Description	string	The description of the creation result.	success
RecordType	string	The DNS type of the record, such as A/AAAA, CNAME, or TXT.	A/AAAA
SourceType	string	The origin type of the CNAME record. This field is empty for other record types. Valid values: OSS: OSS origin. S3: S3 origin. LB: load balancing origin. OP: IPAM pool origin. Domain: common domain name origin.	OSS
Data	object	The DNS information of the record.	{"value":"1.1.1.1"}
Usage	integer	The usage identifier of the record. Value range: 0 to 255. Applicable to SMIMEA and TLSA records.	0
Fingerprint	string	The public key fingerprint value of the record. Applicable to SSHFP records.	abcdef1234567890
Priority	integer	The priority of the record. Value range: 0 to 65535. A smaller value indicates a higher priority. Applicable to MX, SRV, and URI records.	10
Port	integer	The port of the record. Value range: 0 to 65535. Applicable only to SRV records.	0
Flag	integer	The flag of the record, which indicates its priority and processing method. Applicable to CAA records.	128
Algorithm	integer	The encryption algorithm used by the record. Value range: 0 to 255. Applicable to CERT and SSHFP records.	0
Weight	integer	The weight of the record. Value range: 0 to 65535. Applicable to SRV and URI records.	0
Type	integer	The certificate type (for CERT records) or public key type (for SSHFP records) of the record.	0
MatchingType	integer	The algorithm policy used to match or verify certificates. Value range: 0 to 255. Applicable to SMIMEA and TLSA records.	0
Value	string	The record value or partial content. This parameter is included in A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records. It has different meanings for different record types: A/AAAA: IP address. Multiple IP addresses are separated by commas (,). At least one IPv4 address is required. CNAME: target domain name. NS: name server of the specified domain name. MX: valid domain name of the target mail server. TXT: valid text string. CAA: valid domain name of the certificate authority. SRV: valid domain name of the target host. URI: valid URI string.	example.com
KeyTag	integer	The public key identifier of the record. Value range: 0 to 65535. Applicable to CERT records.	0
Tag	string	The tag of the CAA record, which indicates its specific type and purpose, such as issue, issuewild, or iodef.	issue
Certificate	string	The public key certificate information of the record. Applicable to CERT, SMIMEA, and TLSA records.	dGVzdGFkYWxrcw==
Selector	integer	The certificate or public key type used by the record. Value range: 0 to 255. Applicable to SMIMEA and TLSA records.	0
BizName	string	The business scenario when the record is accelerated. Valid values: image_video: video and image. api: API. web: web page.	web
RecordId	integer	The record ID.	1234567890123
Ttl	integer	The time-to-live (TTL) of the record, in seconds. A value of 1 indicates that the TTL is set to automatic.	60
Failed	array<object>	The list of records that failed to be created.
	array<object>
RecordName	string	The record name.	a.example.com
Proxied	boolean	Indicates whether proxy acceleration is enabled for the record. Only CNAME records and A/AAAA records can have proxy acceleration enabled. Valid values: true: Proxy acceleration is enabled. false: Proxy acceleration is disabled.	true
Description	string	The description of the result.	The record name is invalid.
RecordType	string	The DNS type of the record, such as A/AAAA, CNAME, or TXT.	A/AAAA
SourceType	string	The origin type of the CNAME record. This field is empty for other record types. Valid values: OSS: OSS origin. S3: S3 origin. LB: load balancing origin. OP: IPAM pool origin. Domain: common domain name origin.	OSS
Data	object	The DNS information of the record, including various record values and their related properties.	{"value":"2.2.2.2"}
Usage	integer	The usage identifier of the record. Value range: 0 to 255. Applicable to SMIMEA and TLSA records.	0
Fingerprint	string	The public key fingerprint value of the record. Applicable to SSHFP records.	abcdef1234567890
Priority	integer	The priority of the record. Value range: 0 to 65535. A smaller value indicates a higher priority. Applicable to MX, SRV, and URI records.	10
Port	integer	The port number of the record, associated with SRV records. Applicable only to SRV records.	0
Flag	integer	The flag of the record, which indicates its priority and processing method. Applicable to CAA records.	128
Algorithm	integer	The encryption algorithm used by the record. Value range: 0 to 255. Applicable to CERT and SSHFP records.	0
Weight	integer	The weight of the record. Applicable to SRV and URI records.	0
Type	integer	The certificate type (for CERT records) or public key type (for SSHFP records) of the record.	0
MatchingType	integer	The algorithm policy used to match or verify certificates. Value range: 0 to 255. Applicable to SMIMEA and TLSA records.	0
Value	string	The record value or partial content. This parameter is included in A/AAAA, CNAME, NS, MX, TXT, CAA, SRV, and URI records. It has different meanings for different record types: A/AAAA: IP address. Multiple IP addresses are separated by commas (,). At least one IPv4 address is required. CNAME: target domain name. NS: name server of the specified domain name. MX: valid domain name of the target mail server. TXT: valid text string. CAA: valid domain name of the certificate authority. SRV: valid domain name of the target host. URI: valid URI string.	example.com
KeyTag	integer	The public key identifier of the record. Value range: 0 to 65535. Applicable to CERT records.	0
Tag	string	The tag of the CAA record, which indicates its specific type and purpose, such as issue, issuewild, or iodef.	issue
Certificate	string	The public key certificate information of the record. Applicable to CERT, SMIMEA, and TLSA records.	dGVzdGFkYWxrcw==
Selector	integer	The certificate or public key type used by the record. Value range: 0 to 255. Applicable to SMIMEA and TLSA records.	0
BizName	string	The business scenario when the record is accelerated. Valid values: image_video: video and image. api: API. web: web page.	web
RecordId	integer	The record ID.	1234567890123
Ttl	integer	The time-to-live (TTL) of the record, in seconds. A value of 1 indicates that the TTL is set to automatic.	60
TotalCount	integer	The total number of records in the creation operation.	20

Examples

Success response

JSON format

{
  "RequestId": "2430E05E-1340-5773-B5E1-B743929F46F2",
  "RecordResultList": {
    "Success": [
      {
        "RecordName": "www.example.com",
        "Proxied": true,
        "Description": "success",
        "RecordType": "A/AAAA",
        "SourceType": "OSS",
        "Data": {
          "Usage": 0,
          "Fingerprint": "abcdef1234567890",
          "Priority": 10,
          "Port": 0,
          "Flag": 128,
          "Algorithm": 0,
          "Weight": 0,
          "Type": 0,
          "MatchingType": 0,
          "Value": "example.com",
          "KeyTag": 0,
          "Tag": "issue",
          "Certificate": "dGVzdGFkYWxrcw==",
          "Selector": 0
        },
        "BizName": "web",
        "RecordId": 1234567890123,
        "Ttl": 60
      }
    ],
    "Failed": [
      {
        "RecordName": "a.example.com",
        "Proxied": true,
        "Description": "The record name is invalid.",
        "RecordType": "A/AAAA",
        "SourceType": "OSS",
        "Data": {
          "Usage": 0,
          "Fingerprint": "abcdef1234567890",
          "Priority": 10,
          "Port": 0,
          "Flag": 128,
          "Algorithm": 0,
          "Weight": 0,
          "Type": 0,
          "MatchingType": 0,
          "Value": "example.com",
          "KeyTag": 0,
          "Tag": "issue",
          "Certificate": "dGVzdGFkYWxrcw==",
          "Selector": 0
        },
        "BizName": "web",
        "RecordId": 1234567890123,
        "Ttl": 60
      }
    ],
    "TotalCount": 20
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.