tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreatePrivateZoneRecord

Last updated: 2024-04-07 11:57:52

    1. API Description

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

    This API is used to add 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 Params. The value used for this API: CreatePrivateZoneRecord.
    Version Yes String Common Params. The value used for this API: 2020-10-28.
    Region No String Common Params. This parameter is not required for this API.
    ZoneId Yes String Private domain 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
    RecordId String Record ID
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Private domain - adding an A record

    This example shows you how to add an A record.

    Input Example

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

{
    "ZoneId": "zone-123456",
    "RecordType": "A",
    "SubDomain": "b",
    "RecordValue": "3.3.3.3",
    "Weight": 100,
    "TTL": 600
}

    Output Example

    {
    "Response": {
        "RequestId": "a98891db-9d73-514a-8751422197b540cd",
        "RecordId": 1111
    }
}

    Example2 Private domain - adding an MX record

    This example shows you how to add an MX record.

    Input Example

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

{
    "ZoneId": "zone-123456",
    "RecordType": "MX",
    "SubDomain": "b",
    "RecordValue": "3.3.3.3",
    "Weight": 100,
    "MX": 5
}

    Output Example

    {
    "Response": {
        "RequestId": "a98891db-9d73-514a-8751422197b540cd",
        "RecordId": 1111
    }
}

    Example3 Private domain - adding a PTR record

    This example shows you how to add a PTR record.

    Input Example

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

{
    "ZoneId": "zone-123456",
    "RecordType": "PTR",
    "SubDomain": "1.1.1",
    "RecordValue": "qq.com"
}

    Output Example

    {
    "Response": {
        "RequestId": "a98891db-9d73-514a-8751422197b540cd",
        "RecordId": 1111
    }
}

    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.CreateRecordFailed Failed to create the record.
    FailedOperation.DataError Data exception.
    InternalError Internal error.
    InternalError.UndefiendError Undefined error.
    InvalidParameter Incorrect parameter.
    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.MXNotSupported
    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.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.VpcBindedMainDomain The VPC has been associated with the same primary domain.
    InvalidParameter.ZoneNotExists The domain does not exist.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.IllegalTTLValue The TTL value must be in the range of 1–86400.
    LimitExceeded The quota limit is exceeded.
    LimitExceeded.TldOutOfLimit Exceeded the custom TLD quota.
    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.
    ResourceNotFound.ServiceNotSubscribed The Private DNS service is not activated.
    ResourceUnavailable The resource is unavailable.
    ResourceUnavailable.TldPackageExpired The TLD value-added package expired.
    ResourcesSoldOut The resources have been sold out.
    UnauthorizedOperation Unauthorized operation.
    UnauthorizedOperation.UnauthorizedAccount Unverified user.
    UnknownParameter Unknown parameter.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy