ModifyPrivateZoneRecord

Last updated: 2021-09-18 16:39:41

1. API Description

Domain name for API request: privatedns.tencentcloudapi.com.

This API is used to modify a DNS record for a private domain.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: ModifyPrivateZoneRecord.
Version Yes String Common parameter. The value used for this API: 2020-10-28.
Region No String Common parameter. This parameter is not required for this API.
ZoneId Yes String Private domain ID
RecordId Yes String Record ID
RecordType Yes String Record type. Valid values: "A", "AAAA", "CNAME", "MX", "TXT", "PTR"
SubDomain Yes String Subdomain, such as "www", "m", and "@"
RecordValue Yes String Record value, such as IP: 192.168.10.2, CNAME: cname.qcloud.com., and MX: mail.qcloud.com.
Weight No Integer Record weight. Value range: 1–100
MX No Integer MX priority, which is required when the record type is MX. Valid values: 5, 10, 15, 20, 30, 40, 50
TTL No Integer Record cache time. The smaller the value, the faster the record will take effect. Value range: 1–86400s. Default value: 600

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Modifying DNS record for private domain (A record)

This example shows you how to modify an A record.

Input Example

POST / HTTP/1.1
Host: privatedns.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPrivateZoneRecord
<Common request parameters>

{
    "ZoneId": "zone-xxxxxx",
    "RecordId": "289",
    "RecordType": "A",
    "SubDomain": "@",
    "RecordValue": "8.8.8.8",
    "TTL": 600,
    "Weight": "100"
}

Output Example

{
  "Response": {
    "RequestId": "d6f4fef6-8a3c-e2ee-792856f06fa696da"
  }
}

Example2 Modifying DNS record for private domain (MX record)

This example shows you how to modify an MX record.

Input Example

POST / HTTP/1.1
Host: privatedns.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPrivateZoneRecord
<Common request parameters>

{
    "ZoneId": "zone-mao3y9jo",
    "SubDomain": "mail",
    "RecordType": "MX",
    "RecordValue": "stmp.qq.com",
    "TTL": 300,
    "MX": 10,
    "RecordId": "16125"
}

Output Example

{
  "Response": {
    "RequestId": "660006f4-8531-46f0-a2ba-05daf4e7932e"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure Error with CAM signature/authentication.
DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
FailedOperation.ModifyRecordFailed Failed to modify the record.
InternalError Internal error.
InternalError.UndefiendError Undefined error.
InvalidParameter Incorrect parameter.
InvalidParameter.IllegalCidr Invalid CIDR.
InvalidParameter.IllegalPTRRecord Invalid PTR record.
InvalidParameter.IllegalRecord Invalid record.
InvalidParameter.IllegalRecordValue Invalid record value.
InvalidParameter.InvalidMX The MX value must be a multiple of 5 between 5 and 50.
InvalidParameter.RecordAAAACountExceed The number of round-robin DNS AAAA records exceeds 50.
InvalidParameter.RecordACountExceed The number of round-robin DNS A records exceeds 50.
InvalidParameter.RecordCNAMECountExceed The number of round-robin DNS CNAME records exceeds 50.
InvalidParameter.RecordConflict Records conflict.
InvalidParameter.RecordCountExceed The number of records exceeds the limit.
InvalidParameter.RecordExist The record already exists.
InvalidParameter.RecordLevelExceed The number of record levels exceeds the limit.
InvalidParameter.RecordMXCountExceed The number of round-robin DNS MX records exceeds 50.
InvalidParameter.RecordRolllimitCountExceed The number of round-robin DNS records exceeds the limit.
InvalidParameter.RecordTXTCountExceed The number of round-robin DNS TXT records exceeds 10.
InvalidParameter.RecordUnsupportWeight The current record type does not support weight.
InvalidParameter.ZoneNotExists The domain does not exist.
InvalidParameterValue Incorrect parameter value.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
OperationDenied The operation was denied.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceInUse The resource is in use.
ResourceInsufficient Insufficient resource.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation Unauthorized operation.
UnauthorizedOperation.UnauthorizedAccount Unverified user.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.