Help Center> Domain Name Service> API Reference> APIs> Private Zone Management> Associating a VPC with a Private Zone
Updated on 2024-03-20 GMT+08:00

Associating a VPC with a Private Zone

Function

This API is used to associate a VPC with a private zone.

Calling Method

For details, see Calling APIs.

URI

POST /v2/zones/{zone_id}/associaterouter

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

zone_id

Yes

String

ID of the zone associated with the VPC

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

router

Yes

Router object

VPC associated with the endpoint rule

Table 4 Router

Parameter

Mandatory

Type

Description

router_id

Yes

String

ID of the VPC associated with the zone

router_region

No

String

Region of the VPC

status

No

String

Resource status

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

router_id

String

VPC ID

router_region

String

Region of the VPC

status

String

Resource status

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

code

String

Error code

Minimum: 8

Maximum: 36

message

String

Description

Minimum: 2

Maximum: 512

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

code

String

Error code

Minimum: 8

Maximum: 36

message

String

Description

Minimum: 2

Maximum: 512

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

code

String

Error code

Minimum: 8

Maximum: 36

message

String

Description

Minimum: 2

Maximum: 512

Example Requests

Associating a VPC with a private zone

POST https://{endpoint}/v2/zones/{zone_id}/associaterouter

{
  "router" : {
    "router_id" : "f0791650-db8c-4a20-8a44-a06c6e24b15b",
    "router_region" : "xx"
  }
}

Example Responses

Status code: 202

Response to the request for associating a VPC with a private zone

{
  "status" : "PENDING_CREATE",
  "router_id" : "f0791650-db8c-4a20-8a44-a06c6e24b15b",
  "router_region" : "xx"
}

SDK Sample Code

The SDK sample code is as follows.

Associating a VPC with a private zone

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dns.v2.region.DnsRegion;
import com.huaweicloud.sdk.dns.v2.*;
import com.huaweicloud.sdk.dns.v2.model.*;


public class AssociateRouterSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DnsClient client = DnsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DnsRegion.valueOf("<YOUR REGION>"))
                .build();
        AssociateRouterRequest request = new AssociateRouterRequest();
        AssociateRouterRequestBody body = new AssociateRouterRequestBody();
        Router routerbody = new Router();
        routerbody.withRouterId("f0791650-db8c-4a20-8a44-a06c6e24b15b")
            .withRouterRegion("xx");
        body.withRouter(routerbody);
        request.withBody(body);
        try {
            AssociateRouterResponse response = client.associateRouter(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Associating a VPC with a private zone

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdns.v2.region.dns_region import DnsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdns.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DnsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DnsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = AssociateRouterRequest()
        routerbody = Router(
            router_id="f0791650-db8c-4a20-8a44-a06c6e24b15b",
            router_region="xx"
        )
        request.body = AssociateRouterRequestBody(
            router=routerbody
        )
        response = client.associate_router(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Associating a VPC with a private zone

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dns.NewDnsClient(
        dns.DnsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.AssociateRouterRequest{}
	routerRegionRouter:= "xx"
	routerbody := &model.Router{
		RouterId: "f0791650-db8c-4a20-8a44-a06c6e24b15b",
		RouterRegion: &routerRegionRouter,
	}
	request.Body = &model.AssociateRouterRequestBody{
		Router: routerbody,
	}
	response, err := client.AssociateRouter(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

202

Response to the request for associating a VPC with a private zone

400

Error response

404

Error response

500

Error response

Error Codes

See Error Codes.