Help Center/ Cloud Connect/ API Reference/ API/ Inter-Region Bandwidths/ Assigning an Inter-Region Bandwidth
Updated on 2024-11-25 GMT+08:00

Assigning an Inter-Region Bandwidth

Function

This API is used to assign an inter-region bandwidth.

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}/ccaas/inter-region-bandwidths

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account 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

inter_region_bandwidth

Yes

CreateInterRegionBandwidth object

Details of the inter-region bandwidth to be assigned.

Table 4 CreateInterRegionBandwidth

Parameter

Mandatory

Type

Description

cloud_connection_id

Yes

String

Cloud connection ID.

bandwidth_package_id

Yes

String

Bandwidth package ID.

bandwidth

Yes

Integer

Inter-region bandwidth.

inter_region_ids

Yes

Array of strings

IDs of regions where the inter-region bandwidth is used for communications.

Response Parameters

Status code: 201

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

inter_region_bandwidth

InterRegionBandwidth object

Inter-region bandwidth.

Table 6 InterRegionBandwidth

Parameter

Type

Description

id

String

Instance ID.

name

String

Instance name.

description

String

Resource description. Angle brackets (<>) are not allowed.

domain_id

String

ID of the account that the instance belongs to.

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.

cloud_connection_id

String

Cloud connection ID.

bandwidth_package_id

String

Bandwidth package ID.

inter_regions

Array of InterRegion objects

Inter-region bandwidth details.

bandwidth

Integer

Amount of bandwidth, in Mbit/s.

Table 7 InterRegion

Parameter

Type

Description

id

String

Instance ID.

project_id

String

Project ID.

local_region_id

String

ID of one region where an inter-region bandwidth is used.

remote_region_id

String

ID of another region where an inter-region bandwidth is used.

Example Requests

Assigning an inter-region bandwidth with both region IDs specified

POST https://{cc_endpoint}/v3/{domain_id}/ccaas/inter-region-bandwidths

{
  "inter_region_bandwidth" : {
    "bandwidth" : "5",
    "cloud_connection_id" : "XXX",
    "inter_region_ids" : [ "region_a", "region_b" ],
    "bandwidth_package_id" : "XXX"
  }
}

Example Responses

Status code: 201

The inter-region bandwidth has been assigned.

{
  "inter_region_bandwidth" : {
    "id" : "XXX",
    "name" : "",
    "description" : "",
    "domain_id" : "XXX",
    "created_at" : "2023-09-20T11:41:53Z",
    "updated_at" : "2023-09-20T11:41:53Z",
    "bandwidth_package_id" : "XXX",
    "cloud_connection_id" : "XXX",
    "bandwidth" : 5,
    "inter_regions" : [ {
      "id" : "XXX",
      "project_id" : "",
      "local_region_id" : "region_a",
      "remote_region_id" : "region_b"
    }, {
      "id" : "XXX",
      "project_id" : "",
      "local_region_id" : "region_b",
      "remote_region_id" : "region_a"
    } ]
  },
  "request_id" : "fd403735e22a5213845afbf69425a976"
}

SDK Sample Code

The SDK sample code is as follows.

Assigning an inter-region bandwidth with both region IDs specified

 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
54
55
56
57
58
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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateInterRegionBandwidthSolution {

    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();
        CreateInterRegionBandwidthRequest request = new CreateInterRegionBandwidthRequest();
        CreateInterRegionBandwidthRequestBody body = new CreateInterRegionBandwidthRequestBody();
        List<String> listInterRegionBandwidthInterRegionIds = new ArrayList<>();
        listInterRegionBandwidthInterRegionIds.add("region_a");
        listInterRegionBandwidthInterRegionIds.add("region_b");
        CreateInterRegionBandwidth interRegionBandwidthbody = new CreateInterRegionBandwidth();
        interRegionBandwidthbody.withBandwidth(5)
            .withBandwidthPackageId("XXX")
            .withInterRegionIds(listInterRegionBandwidthInterRegionIds)
            .withCloudConnectionId("XXX");
        body.withInterRegionBandwidth(interRegionBandwidthbody);
        request.withBody(body);
        try {
            CreateInterRegionBandwidthResponse response = client.createInterRegionBandwidth(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());
        }
    }
}

Assigning an inter-region bandwidth with both region IDs specified

 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
# 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 = CreateInterRegionBandwidthRequest()
        listInterRegionIdsInterRegionBandwidth = [
            "region_a",
            "region_b"
        ]
        interRegionBandwidthbody = CreateInterRegionBandwidth(
            bandwidth=5,
            bandwidth_package_id="XXX",
            inter_region_ids=listInterRegionIdsInterRegionBandwidth,
            cloud_connection_id="XXX"
        )
        request.body = CreateInterRegionBandwidthRequestBody(
            inter_region_bandwidth=interRegionBandwidthbody
        )
        response = client.create_inter_region_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)

Assigning an inter-region bandwidth with both region IDs specified

 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
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.CreateInterRegionBandwidthRequest{}
	var listInterRegionIdsInterRegionBandwidth = []string{
        "region_a",
	    "region_b",
    }
	interRegionBandwidthbody := &model.CreateInterRegionBandwidth{
		Bandwidth: int32(5),
		BandwidthPackageId: "XXX",
		InterRegionIds: listInterRegionIdsInterRegionBandwidth,
		CloudConnectionId: "XXX",
	}
	request.Body = &model.CreateInterRegionBandwidthRequestBody{
		InterRegionBandwidth: interRegionBandwidthbody,
	}
	response, err := client.CreateInterRegionBandwidth(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

201

The inter-region bandwidth has been assigned.

Error Codes

See Error Codes.