tencent cloud

APIs

DokumentasiAPIsPrivate DNSPrivate DNS APIsAddSpecifyPrivateZoneVpc

AddSpecifyPrivateZoneVpc

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-07-09 21:11:31

1. API Description

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

This API is used to add the VPC associated with the private domain.

A maximum of 2 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: AddSpecifyPrivateZoneVpc.
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.
VpcSet.N No Array of VpcInfo Information about the new VPC.
AccountVpcSet.N No Array of AccountVpcInfo Information about the new VPC of the associated account.
Sync No Boolean Whether the operation is synchronous.

3. Output Parameters

Parameter Name Type Description
ZoneId String zone id
VpcSet Array of VpcInfo The VPC to be added.
AccountVpcSet Array of AccountVpcInfo The VPC of the associated account that is to be added.
UniqId String Unique ID

Note: This field may return null, indicating that no valid values can be obtained.
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 Adding the VPC Associated with the Private Domain

Input Example

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

{
    "ZoneId": "abc",
    "VpcSet": [
        {
            "UniqVpcId": "vpc-xxxxxxx",
            "Region": "ap-guangzhou"
        }
    ],
    "AccountVpcSet": [
        {
            "UniqVpcId": "vpc-xxxxxxxx",
            "Region": "ap-guangzhou",
            "Uin": "334345",
            "VpcName": "abc"
        }
    ]
}

Output Example

{
    "Response": {
        "ZoneId": "abc",
        "VpcSet": [
            {
                "UniqVpcId": "abc",
                "Region": "abc"
            }
        ],
        "AccountVpcSet": [
            {
                "Uin": "123456789",
                "UniqVpcId": "vpc-xxxxxxx",
                "Region": "ap-guangzhou"
            }
        ],
        "UniqId": "888888",
        "RequestId": "abc"
    }
}

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.
AuthFailure.TokenFailure Token verification failed.
DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
FailedOperation.BindZoneVpcFailed Failed to associate the private domain with the VPC.
FailedOperation.DataError Data exception.
InternalError Internal error.
InternalError.UndefiendError Undefined error.
InvalidParameter Incorrect parameter.
InvalidParameter.IllegalVpcInfo Invalid VPC.
InvalidParameter.VpcBinded The VPC has been bound to another domain.
InvalidParameter.VpcBindedMainDomain The VPC has been associated with the same primary domain.
InvalidParameter.ZoneNotExists The domain does not exist.
InvalidParameterValue Incorrect parameter value.
LimitExceeded The quota limit is exceeded.
LimitExceeded.TldOutOfLimit Exceeded the custom TLD quota.
LimitExceeded.TldOutOfRange The number of private domains using the custom TLD exceeds the total 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.
ResourceUnavailable The resource is unavailable.
ResourceUnavailable.TldPackageExpired The TLD value-added package expired.
ResourcesSoldOut The resources have been sold out.
UnauthorizedOperation Unauthorized operation.
UnauthorizedOperation.RoleUnAuthorized Role not authorized.
UnauthorizedOperation.UnauthorizedAccount Unverified user.
UnknownParameter Unknown parameter.
UnsupportedOperation Unsupported operation.
Topik sebelumnya: DeleteSpecifyPrivateZoneVpcTopik selanjutnya: DescribePrivateZone

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan