tencent cloud

All product documents
Private DNS
DocumentationPrivate DNSAPI DocumentationPrivate DNS APIsModifyPrivateZoneVpc
ModifyPrivateZoneVpc
Download PDF
Last updated: 2024-04-07 11:57:43
ModifyPrivateZoneVpc
Last updated: 2024-04-07 11:57:43
Download PDF

1. API Description

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

This API is used to modify the VPC associated with a 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: ModifyPrivateZoneVpc.
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 List of all VPCs associated with private domain
AccountVpcSet.N No Array of AccountVpcInfo List of authorized accounts' VPCs to associate with the private domain

3. Output Parameters

Parameter Name Type Description
ZoneId String Private domain ID, such as zone-xxxxxx
VpcSet Array of VpcInfo List of VPCs associated with domain
AccountVpcSet Array of AccountVpcInfoOutput List of authorized accounts' VPCs associated with the private domain
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 Modifying the VPCs associated with a private domain

Input Example

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

{
    "ZoneId": "1",
    "VpcSet": [
        {
            "Region": "ap-guangzhou",
            "UniqVpcId": "vpc-xxxxxx"
        }
    ],
    "AccountVpcSet": [
        {
            "Uin": "123456789",
            "Region": "ap-guangzhou",
            "UniqVpcId": "vpc-xxxxxx",
            "VpcName": "vpcName"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "5cd964e2-b5e6-8a35-9ce5a1085860c845",
        "ZoneId": "1",
        "VpcSet": [
            {
                "UniqVpcId": "vpc-xxxxxxx",
                "Region": "ap-guangzhou"
            }
        ],
        "AccountVpcSet": [
            {
                "Uin": "123456789",
                "UniqVpcId": "vpc-xxxxxxx",
                "Region": "ap-guangzhou"
            }
        ]
    }
}

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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon