Help Center/ Cloud Connect/ API Reference/ API/ Site-to-site Connection Management/ Binding a Bandwidth Package to a Site-to-Site Connection
Updated on 2024-11-25 GMT+08:00

Binding a Bandwidth Package to a Site-to-Site Connection

Function

This API is used to bind a bandwidth package to a site-to-site connection.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v3/{domain_id}/dcaas/site-network/{site_network_id}/connections/{site_connection_id}/associate

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

site_network_id

Yes

String

Site network ID.

site_connection_id

Yes

Object

Site-to-site connection ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

site_connection

Yes

AssociateSiteConnectionBandwidth object

Request body for binding a bandwidth package to a site-to-site connection.

Table 4 AssociateSiteConnectionBandwidth

Parameter

Mandatory

Type

Description

global_connection_bandwidth_id

No

String

Global connection bandwidth ID.

bandwidth_size

No

Integer

Amount of bandwidth, in Mbit/s.

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

site_connection

SiteConnection object

Site-to-site connection.

Table 6 SiteConnection

Parameter

Type

Description

id

String

Instance ID.

site_network_id

String

Site network ID.

state

String

Site-to-site connection status.

  • AVAILABLE: The connection is available.

  • CREATING: The connection is being created.

  • UPDATING: The connection is being updated.

  • DELETING: The connection is being deleted.

  • FREEZING: The connection is being frozen.

  • UNFREEZING: The connection is being unfrozen.

  • RECOVERING: The connection is being recovered.

  • FAILED: The connection failed.

  • FREEZED: The connection is frozen.

  • DELETED: The connection is deleted.

created_at

String

Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format.

updated_at

String

Time when the resource was updated. The time must be in the yyyy-MM-ddTHH:mm:ss format.

edge_pair

Array of DirectedEdge objects

Definition of the two ends of a site-to-site connection. The length is fixed to an array of 2.

cross_region_type

String

Communications within a region or between regions.

  • intra-region: communications within a region

  • inter-region: communications between regions

global_connection_bandwidth_id

String

Global connection bandwidth ID.

bandwidth_size

Integer

Amount of bandwidth, in Mbit/s.

is_frozen

Boolean

Whether the resource is frozen.

frozen_effect

String

Resource frozen effect.

  • RELEASABLE: The resource is frozen and can be released.

  • UNRELEASABLE: The resource is frozen and cannot be released.

is_bind_bandwidth

Boolean

Whether a bandwidth package is bound.

Table 7 DirectedEdge

Parameter

Type

Description

id

String

Instance ID.

region_id

String

Region ID.

gateway_id

String

Gateway ID.

gateway_type

String

Gateway type. GDGW indicates global DC gateways.

site_code

String

Site code.

project_id

String

Project ID.

Example Requests

Binding a bandwidth package to a site-to-site connection

POST /v3/{domain_id}/dcaas/site-network/{site_network_id}/connections/{site_connection_id}/associate

{
  "site_connection" : {
    "global_connection_bandwidth_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "bandwidth_size" : 20
  }
}

Example Responses

Status code: 202

The bandwidth package has been bound to the site-to-site connection.

{
  "request_id" : "0050ea65af7e190d9a791d9e69f28e63",
  "site_connection" : {
    "id" : "eb350a5c-06c1-4b12-9ae4-3820f31faaa0",
    "site_network_id" : "eb350a5c-06c1-4b12-9ae4-3820f31faaa0",
    "state" : "UPDATING",
    "created_at" : "2023-10-09T10:15:32.134Z",
    "updated_at" : "2023-10-09T10:15:32.134Z",
    "cross_region_type" : "inter-region",
    "bandwidth_size" : 0,
    "is_frozen" : false,
    "edge_pair" : [ {
      "id" : "1c233723-234c-4b50-8fba-7072b4c6aa1a",
      "gateway_id" : "1c233723-234c-4b50-8fba-7072b4c6aa1a",
      "project_id" : "XXX",
      "region_id" : "region-abc",
      "site_code" : "region-abc",
      "gateway_type" : "GDGW"
    }, {
      "id" : "1c233723-234c-4b50-8fba-7072b4c6aa11",
      "gateway_id" : "8641d7f0-bd0c-49fe-8b70-3649cd7dd9b2",
      "project_id" : "XXX",
      "region_id" : "region-abc",
      "site_code" : "region-abc",
      "gateway_type" : "GDGW"
    } ]
  }
}

SDK Sample Code

The SDK sample code is as follows.

Binding a bandwidth package to a site-to-site connection

 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
52
53
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.cc.v3.region.CcRegion;
import com.huaweicloud.sdk.cc.v3.*;
import com.huaweicloud.sdk.cc.v3.model.*;


public class AssociateSiteNetworkBandwidthSolution {

    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 GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CcClient client = CcClient.newBuilder()
                .withCredential(auth)
                .withRegion(CcRegion.valueOf("<YOUR REGION>"))
                .build();
        AssociateSiteNetworkBandwidthRequest request = new AssociateSiteNetworkBandwidthRequest();
        request.withSiteNetworkId("{site_network_id}");
        request.withSiteConnectionId();
        AssociateSiteConnectionBandwidthRequestBody body = new AssociateSiteConnectionBandwidthRequestBody();
        AssociateSiteConnectionBandwidth siteConnectionbody = new AssociateSiteConnectionBandwidth();
        siteConnectionbody.withGlobalConnectionBandwidthId("a3bad420-33b8-4e26-9e9b-bdf67aa8e72b")
            .withBandwidthSize(20L);
        body.withSiteConnection(siteConnectionbody);
        request.withBody(body);
        try {
            AssociateSiteNetworkBandwidthResponse response = client.associateSiteNetworkBandwidth(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());
        }
    }
}

Binding a bandwidth package to a site-to-site connection

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcc.v3.region.cc_region import CcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcc.v3 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 = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

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

    try:
        request = AssociateSiteNetworkBandwidthRequest()
        request.site_network_id = "{site_network_id}"
        request.site_connection_id = 
        siteConnectionbody = AssociateSiteConnectionBandwidth(
            global_connection_bandwidth_id="a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
            bandwidth_size=20
        )
        request.body = AssociateSiteConnectionBandwidthRequestBody(
            site_connection=siteConnectionbody
        )
        response = client.associate_site_network_bandwidth(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Binding a bandwidth package to a site-to-site connection

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cc.NewCcClient(
        cc.CcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.AssociateSiteNetworkBandwidthRequest{}
	request.SiteNetworkId = "{site_network_id}"
	globalConnectionBandwidthIdSiteConnection:= "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b"
	bandwidthSizeSiteConnection:= int64(20)
	siteConnectionbody := &model.AssociateSiteConnectionBandwidth{
		GlobalConnectionBandwidthId: &globalConnectionBandwidthIdSiteConnection,
		BandwidthSize: &bandwidthSizeSiteConnection,
	}
	request.Body = &model.AssociateSiteConnectionBandwidthRequestBody{
		SiteConnection: siteConnectionbody,
	}
	response, err := client.AssociateSiteNetworkBandwidth(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

The bandwidth package has been bound to the site-to-site connection.

Error Codes

See Error Codes.