Help Center> Cloud Connect> API Reference> API> Global Private Bandwidths> Updating a Global Private Bandwidth
Updated on 2024-03-29 GMT+08:00

Updating a Global Private Bandwidth

Function

This API is used to update a global private bandwidth.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{domain_id}/gcb/gcbandwidths/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

Minimum: 10

Maximum: 32

id

Yes

String

Resource ID.

Minimum: 32

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

Minimum: 0

Maximum: 2000000

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

globalconnection_bandwidth

Yes

UpdateGlobalConnectionBandwidth object

Detailed information about a global private bandwidth.

Table 4 UpdateGlobalConnectionBandwidth

Parameter

Mandatory

Type

Description

name

No

String

Resource name.

description

No

String

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

Minimum: 0

Maximum: 255

size

No

Integer

Range of a global private bandwidth, in Mbit/s.

Bandwidth range: 2 Mbit/s to 300 Mbit/s

Minimum: 2

Maximum: 300

charge_mode

No

String

Billing option. By default, billing by bandwidth is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist.

  • bwd: billing by bandwidth

  • 95: standard 95th percentile bandwidth billing

sla_level

No

String

Class of a global private bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists.

  • Pt: platinum

  • Au: gold

  • Ag: silver

Default: Au

Minimum: 1

Maximum: 36

binding_service

No

String

Instance type.

  • Cloud Connect: cloud connection

  • GEIP: Global EIP

  • GCN: central network

  • GSN: site network

  • ALL: all instance types

spec_code_id

No

String

UUID of a line specification code.

Minimum: 1

Maximum: 36

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Resource ID.

Minimum: 32

Maximum: 36

globalconnection_bandwidth

GlobalConnectionBandwidth object

Detailed information about a global private bandwidth.

Table 6 GlobalConnectionBandwidth

Parameter

Type

Description

id

String

Resource ID.

name

String

Resource name.

description

String

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

Minimum: 0

Maximum: 255

domain_id

String

ID of the account that the instance belongs to.

bordercross

Boolean

Whether the global private bandwidth is used for cross-border communications (between the Chinese mainland and a country/region outside the Chinese mainland).

  • True: cross-border communications

  • False: non-cross-border communications

type

String

Type of a global private bandwidth.

  • TrsArea: cross-geographic-region bandwidth

  • Area: geographic-region bandwidth

  • SubArea: region bandwidth

  • Region: multi-city bandwidth

binding_service

String

Instance type.

  • Cloud Connect: cloud connection

  • GEIP: Global EIP

  • GCN: central network

  • GSN: site network

  • ALL: all instance types

enterprise_project_id

String

ID of the enterprise project that the virtual gateway belongs to.

Minimum: 1

Maximum: 36

charge_mode

String

Billing option. By default, billing by bandwidth is enabled. Standard 95th percentile bandwidth billing is controlled using a whitelist.

  • bwd: billing by bandwidth

  • 95: standard 95th percentile bandwidth billing

size

Integer

Range of a global private bandwidth, in Mbit/s.

Bandwidth range: 2 Mbit/s to 300 Mbit/s

Minimum: 2

Maximum: 300

sla_level

String

Class of a global private bandwidth. There are three classes: platinum, gold, and silver. The default class is gold. Other options are controlled by whitelists.

  • Pt: platinum

  • Au: gold

  • Ag: silver

Default: Au

Minimum: 1

Maximum: 36

local_area

String

Name of a local access point. The x-language parameter in the header is used to control the language. The default language is English. zh-cn indicates Chinese.

Minimum: 1

Maximum: 36

remote_area

String

Name of a remote access point. The x-language parameter in the header is used to control the language. The default language is English. zh-cn indicates Chinese.

Minimum: 1

Maximum: 36

local_site_code

String

Code of the local access point.

Minimum: 1

Maximum: 36

remote_site_code

String

Code of s remote access point.

Minimum: 1

Maximum: 36

admin_state

String

Global private bandwidth status.

  • NORMAL: The bandwidth is normal.

  • FREEZED: The bandwidth is frozen.

frozen

Boolean

Whether a global private bandwidth is frozen.

  • true: The bandwidth is frozen.

  • false: The bandwidth is not frozen.

spec_code_id

String

UUID of a line specification code.

Minimum: 1

Maximum: 36

tags

Array of Tag objects

Resource tags.

Array Length: 1 - 20

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.

enable_share

Boolean

Whether a global private bandwidth can be used by multiple instances.

  • true: The bandwidth can be used by multiple instances.

  • false: The bandwidth cannot be used by multiple instances.

instances

Array of GlobalConnectionBandwidthAssociatedInstance objects

The list of instances that the global private bandwidth is bound to.

Array Length: 0 - 200

Table 7 Tag

Parameter

Type

Description

key

String

Tag key. The key can contain a maximum of 128 Unicode characters, including letters, digits, hyphens (-), and underscores (_).

value

String

Tag value. The value can contain a maximum of 255 Unicode characters, including letters, digits, hyphens (-), underscores (_), and periods (.).

Table 8 GlobalConnectionBandwidthAssociatedInstance

Parameter

Type

Description

id

String

Bound instance ID.

Minimum: 0

Maximum: 36

type

String

Bound instance type.

Minimum: 0

Maximum: 36

region_id

String

Region of the bound instance. The default value is global for global services.

Minimum: 0

Maximum: 36

project_id

String

Project ID of the bound instance.

Minimum: 0

Maximum: 36

Example Requests

Updating a global private bandwidth

PUT https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths/{id}

{
  "globalconnection_bandwidth" : {
    "name" : "test",
    "description" : "Description",
    "size" : 5
  }
}

Example Responses

Status code: 200

The global private bandwidth has been updated.

{
  "request_id" : "1b90e4762e3090961a30ca3a712dc0ed",
  "globalconnection_bandwidth" : {
    "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "name" : "name",
    "description" : "description",
    "domain_id" : "521bb3d98bed4c6c9ee8669bd0620f76",
    "bordercross" : false,
    "type" : "Region",
    "binding_service" : "CC",
    "enterprise_project_id" : "0c478f9e-73a4-4c45-b9bc-b2c3bfc0d4c0",
    "charge_mode" : "bwd",
    "size" : 100,
    "sla_level" : "Au",
    "local_site_code" : "cn-south-guangzhou",
    "remote_site_code" : "cn-north-beijing4",
    "frozen" : "false,",
    "spec_code_id" : "",
    "tags" : [ ],
    "created_at" : "2024-01-24T08:26:41.914Z",
    "updated_at" : "2024-01-24T08:26:41.914Z",
    "enable_share" : false,
    "instances" : [ ]
  }
}

SDK Sample Code

The SDK sample code is as follows.

Updating a global private bandwidth

 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
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 UpdateGlobalConnectionBandwidthSolution {

    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();
        UpdateGlobalConnectionBandwidthRequest request = new UpdateGlobalConnectionBandwidthRequest();
        UpdateGlobalConnectionBandwidthRequestBody body = new UpdateGlobalConnectionBandwidthRequestBody();
        UpdateGlobalConnectionBandwidth globalconnectionBandwidthbody = new UpdateGlobalConnectionBandwidth();
        globalconnectionBandwidthbody.withSize(5)
            .withName("test")
            .withDescription("Description");
        body.withGlobalconnectionBandwidth(globalconnectionBandwidthbody);
        request.withBody(body);
        try {
            UpdateGlobalConnectionBandwidthResponse response = client.updateGlobalConnectionBandwidth(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());
        }
    }
}

Updating a global private bandwidth

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

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

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

    try:
        request = UpdateGlobalConnectionBandwidthRequest()
        globalconnectionBandwidthbody = UpdateGlobalConnectionBandwidth(
            size=5,
            name="test",
            description="Description"
        )
        request.body = UpdateGlobalConnectionBandwidthRequestBody(
            globalconnection_bandwidth=globalconnectionBandwidthbody
        )
        response = client.update_global_connection_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)

Updating a global private bandwidth

 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
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.UpdateGlobalConnectionBandwidthRequest{}
	sizeGlobalconnectionBandwidth:= int32(5)
	nameGlobalconnectionBandwidth:= "test"
	descriptionGlobalconnectionBandwidth:= "Description"
	globalconnectionBandwidthbody := &model.UpdateGlobalConnectionBandwidth{
		Size: &sizeGlobalconnectionBandwidth,
		Name: &nameGlobalconnectionBandwidth,
		Description: &descriptionGlobalconnectionBandwidth,
	}
	request.Body = &model.UpdateGlobalConnectionBandwidthRequestBody{
		GlobalconnectionBandwidth: globalconnectionBandwidthbody,
	}
	response, err := client.UpdateGlobalConnectionBandwidth(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

200

The global private bandwidth has been updated.

Error Codes

See Error Codes.