All Products
Search
Document Center

Domain Names:SaveSingleTaskForAddingDSRecord

Last Updated:Sep 26, 2024

Submits a task to create the delegation signer (DS) record of a domain name.

You can call the QueryTaskDetailList operation to query the task execution result.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SaveSingleTaskForAddingDSRecord

The operation that you want to perform. Set the value to SaveSingleTaskForAddingDSRecord.

Algorithm Integer Yes 1

The number of the encryption algorithm in use. For more information, see Domain Name System Security (DNSSEC) Algorithm Numbers. Valid values:

  • 1: RSA/MD5
  • 2: Diffie-Hellman
  • 3: DSA/SHA-1
  • 5: RSA/SHA-1
  • 6: DSA-NSEC3-SHA1
  • 7: RSASHA1-NSEC3-SHA1
  • 8: RSA/SHA-256
  • 10: RSA/SHA-512
  • 12: GOST R 34.10-2001
  • 13: ECDSA Curve P-256 with SHA-256
  • 14: ECDSA Curve P-384 with SHA-384
  • 15: Ed2551916 Ed448
  • 252: reserved for indirect keys
  • 253: private algorithm
  • 254: private algorithm OID
Digest String Yes f58fa917424383934c7b0cf1a90f61d692745680fa06f5ecdbe0924e86de9598

The digest of the result of the task.

DigestType Integer Yes 2

The type of the digest algorithm. For more information, see Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms. Valid values:

  • 1: SHA-1
  • 2: SHA-256
  • 3: GOST R 34.11-94
  • 4: SHA-384
DomainName String Yes example.com

The domain name.

KeyTag Integer Yes 1

The key tag that is used to identify the DNSSEC record. Valid values: integers between 0 and 65536.

Lang String No en

The language in which the system returns the error message. Valid values:

  • zh: Chinese
  • en: English

Default value: en

UserClientIp String No 127.0.0.1

The IP address of the client. Set the value to 127.0.0.1.

Response parameters

Parameter Type Example Description
RequestId String E2598CAF-DBFE-494E-95EF-B42A33C178AA

The ID of the request.

TaskNo String e893148f-6343-4ae1-9eba-6e2a4116e142

The ID of the task.

Examples

Sample requests

http(s)://[Endpoint]/?Action=SaveSingleTaskForAddingDSRecord
&Algorithm=1
&Digest=f58fa917424383934c7b0cf1a90f61d692745680fa06f5ecdbe0924e86de9598
&DigestType=2
&DomainName=example.com
&KeyTag=1
&<Common request parameters>

Sample success responses

XML format

<SaveSingleTaskForAddingDSRecordResponse>
    <TaskNo>3cbc5b9f-080d-4b5f-a04b-29f54bffdeab</TaskNo>
    <RequestId>722D0361-93BD-4289-824F-D17B218D8BF4</RequestId>
</SaveSingleTaskForAddingDSRecordResponse>

JSON format

{
    "RequestId":"E2598CAF-DBFE-494E-95EF-B42A33C178AA",
    "TaskNo":"e893148f-6343-4ae1-9eba-6e2a4116e142"
}

Error codes

For a list of error codes, visit the API Error Center.